flux2/install/README.md

# GOTK CLI Installation

Binaries for macOS and Linux AMD64 are available for download on the 
[release page](https://github.com/fluxcd/toolkit/releases).

To install the latest release run:

```bash
curl -s https://raw.githubusercontent.com/fluxcd/toolkit/master/install/gotk.sh | sudo bash
```

The install script does the following:
* attempts to detect your OS
* downloads and unpacks the release tar file in a temporary directory
* copies the gotk binary to `/usr/local/bin`
* removes the temporary directory

If you want to use gotk as a kubectl plugin, rename the binary to `kubectl-gotk`:

```sh
mv /usr/local/bin/gotk /usr/local/bin/kubectl-gotk
```

## Build from source

Clone the repository:

```bash
git clone https://github.com/fluxcd/toolkit
cd toolkit
```

Build the `gotk` binary (requires go >= 1.14):

```bash
make build
```

Run the binary:

```bash
./bin/gotk -h
```