# Installation

## Unix

### Installation script

This will download a binary from the latest GitHub release.
**This will activate `sudo` to write the executable.** Please review the install script
before running it.

```shell
curl https://raw.githubusercontent.com/spenserblack/gengo/main/install.sh | sh
```

### Arch Linux

gengo is available as [an AUR package](https://aur.archlinux.org/packages/gengo/).
It can be installed using an AUR helper (e.g. paru):

```shell
paru -S gengo
```

## Windows

### Installation script

This will download a binary from the latest GitHub release.

```powershell
Invoke-RestMethod "https://raw.githubusercontent.com/spenserblack/gengo/main/install.ps1" | Invoke-Expression
```

If you get an error regarding execution policy, please read the error carefully and
determine the execution policy that is right for you. You may try re-running the
installation script if you have updated the execution policy.

### Scoop

gengo is installable via [Scoop](https://scoop.sh). See the [Scoop manifest][scoop-manifest].

```batch
scoop install https://raw.githubusercontent.com/spenserblack/gengo/main/scoop/gengo.json
```

## Universal

### From GitHub Releases

Download the appropriate file from [a release](https://github.com/spenserblack/gengo/releases).

### With `cargo`

The following installs the `gengo` binary.

```shell
cargo install gengo-bin
```

### Docker

You can build a docker image and run it as well.

```bash
docker build -t gengo .
docker run --rm -v $(pwd):$(pwd) -w $(pwd) -t gengo
```

Or pull it from the [GitHub Container Registry][ghcr-package].

[ghcr-package]: https://github.com/users/spenserblack/packages/container/package/gengo
[scoop-manifest]: ../scoop/gengo.json