Skip to content

Commit 88aca49

Browse files
tohnjmattheis
authored andcommitted
add installation instructions for macOS and Arch Linux
1 parent 9c0883d commit 88aca49

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,30 +25,61 @@ $ http -f POST "https://push.example.de/message?token=<apptoken>" title="my titl
2525

2626
## Installation
2727

28+
### Manually
29+
2830
Download the [latest release][release] for your os: (this example uses version `v2.2.0`)
31+
2932
```bash
3033
$ wget -O gotify https://github.com/gotify/cli/releases/download/v2.2.0/gotify-cli-linux-amd64
3134
# or
3235
$ curl -Lo gotify https://github.com/gotify/cli/releases/download/v2.2.0/gotify-cli-linux-amd64
3336
```
37+
3438
Make `gotify` executable:
39+
3540
```bash
3641
$ chmod +x gotify
3742
```
43+
3844
Test if the Gotify-CLI works: *(When it doesn't work, you may have downloaded the wrong file or your device/os isn't supported)*
45+
3946
```bash
4047
$ gotify version
4148
```
49+
4250
It should output something like this:
51+
4352
```bash
4453
Version: 2.2.0
4554
Commit: 95cc125e39f805a1369b0c746c8bf3af15797a57
4655
BuildDate: 2020-09-25-16:27:04
4756
```
57+
4858
*(optional)* Move the executable to a folder on your `$PATH`:
59+
4960
```bash
5061
$ mv gotify /usr/bin/gotify
5162
```
63+
64+
### Arch Linux
65+
66+
Gotify-CLI is available [in the AUR][AUR], so you can install it with
67+
[any AUR helper][AUR-helpers], i.e. [`yay`][yay]:
68+
69+
```bash
70+
$ yay -S gotify-cli
71+
```
72+
73+
### macOS
74+
75+
Gotify-CLI is available [in Homebrew][brew], so you can install it with:
76+
77+
```bash
78+
$ brew install gotify
79+
```
80+
81+
## Usage
82+
5283
Now you can either run the initialization wizard or [create a config manually](#Configuration). This tutorial uses the wizard.
5384
```bash
5485
$ gotify init
@@ -192,3 +223,7 @@ docker run -it -v "$PWD/cli.json:/home/app/cli.json" gotify/gotify-cli:latest pu
192223
[travis]: https://app.travis-ci.com/gotify/cli
193224
[badge-release]: https://img.shields.io/github/release/gotify/cli.svg
194225
[release]: https://github.com/gotify/cli/releases/latest
226+
[AUR]: https://aur.archlinux.org/packages/gotify-cli
227+
[AUR-helpers]: https://wiki.archlinux.org/title/AUR_helpers
228+
[yay]: https://aur.archlinux.org/packages/yay/
229+
[brew]: https://brew.sh

0 commit comments

Comments
 (0)