File: installation.md

package info (click to toggle)
changie 1.24.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,068 kB
  • sloc: makefile: 40; ruby: 38; javascript: 32
file content (146 lines) | stat: -rw-r--r-- 3,172 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
---
title: 'Installation'
---

## ArchLinux

An [AUR package](https://aur.archlinux.org/packages/changie/) is available.

```sh
trizen -S changie
```

## Docker

Docker images are uploaded to [GitHub Packages](https://github.com/miniscruff/changie/pkgs/container/changie).

```sh
# Replace latest with any changie command
docker run \
    --mount type=bind,source=$PWD,target=/src \
    -w /src \
    ghcr.io/miniscruff/changie \
    latest
```

**Notes**
1. In order to complete prompts with docker you will need to use an [interactive terminal](https://docs.docker.com/engine/reference/commandline/run/#assign-name-and-allocate-pseudo-tty---name--it)
1. You may also want to include your own user and group ID if any files would be created using the [user option](https://docs.docker.com/engine/reference/run/#user).

```sh
docker run \
    --mount type=bind,source=$PWD,target=/src \
    -w /src \
    -it \
    --user $(id -u ${USER}):$(id -g ${USER}) \
    ghcr.io/miniscruff/changie \
    new
```

## GitHub action

This [GitHub action](https://github.com/miniscruff/changie-action) can be used.

```yaml
- name: Batch a new minor version
  uses: miniscruff/changie-action@VERSION # view action repo for latest version
  with:
    version: latest # use the latest changie version
    args: batch minor
```

## macOS with Homebrew

On macOS, you can use [Homebrew](https://brew.sh/) to install changie from homebrew core.

```sh
brew install changie
```

## Manual

* Download from [here](https://github.com/miniscruff/changie/releases).
* Add executable somewhere in your path depending on your platform.

## Manual deb/rpm packages

Download a `.deb` or `.rpm` file from the [releases page](https://github.com/miniscruff/changie/releases)
and install with `dpkg -i` and `rpm -i` respectively.

## Mise

Changie is included in the [Mise](https://mise.jdx.dev/) registry.
It's recommended to use `mise use` for tools.

```sh
mise use changie
```

This will add changie to the `mise.toml` file.
```toml
[tools]
changie = "latest"
```

Or if you only want to use changie for a single mise task, such as `changie new`.

```toml
[tasks.fragment]
tools.changie = "latest"
run = "changie new"
```

## NodeJS

Changie is available as an [NPM package](https://www.npmjs.com/package/changie).

To add as a dependency of your project

```sh
npm i -D changie
```

To install globally

```
npm i -g changie
```

To run without adding a dependency

```
npx changie
```

## Source

Go install can be used to download changie from the main branch.

```sh
go install github.com/miniscruff/changie@latest
```

## UBI ( universal binary installer )

[UBI](https://github.com/houseabsolute/ubi) can be used to install Changie binaries directly from
GitHub.

```sh
ubi --project miniscruff/changie --in /binary/path
```

## Windows Scoop

On Windows you can use [scoop](https://scoop.sh/) by first adding the repo and then installing.
```sh
scoop bucket add changie https://github.com/miniscruff/changie
scoop install changie
```

## Winget

On Windows you can also use the [winget](https://github.com/microsoft/winget-pkgs) package manager.

```sh
winget install miniscruff.changie
```