summaryrefslogtreecommitdiff
path: root/docs/guide/ags/installation.md
blob: 0adcf68ef58a9e69042ecce177d6078a446c6f6f (plain)
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
# Installation

## Nix

maintainer: [@Aylur](https://github.com/Aylur)

Read more about it on the [nix page](../getting-started/nix#ags)

You can try without installing.

<!--TODO: remove v2 after merge-->
```sh
nix run github:aylur/ags/v2 -- --help
```

## Bulding AGS from source

1. [Install Astal](../getting-started/installation.md) if you have not already

2. Install the following dependencies

:::code-group

```sh [<i class="devicon-archlinux-plain"></i> Arch]
sudo pacman -Syu go npm gjs
```

```sh [<i class="devicon-fedora-plain"></i> Fedora]
sudo dnf install golang npm gjs
```

```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
sudo apt install golang-go npm gjs
```

:::

3. Clone the repo and Install

<!--TODO: remove v2 after merge-->
```sh
git clone https://github.com/aylur/ags.git
cd ags/src
git checkout v2 # https://github.com/Aylur/ags/pull/504
go install
```

:::info
If you have installed Astal **not** in `/usr` make sure to set its path.

```sh
go install -ldflags "-X main.astalGjs=$(pkg-config --variable prefix astal-0.1)/share/astal/gjs"
```

:::

:::tip
`go install` installs the `ags` binary to `$GOPATH/bin` so make sure its in your `$PATH`.
You can move it to another directory if you like. For example

```sh
mv $GOPATH/bin/ags ~/.local/bin/ags
```

:::