flux2/install/README.md

# flux CLI Installation

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

To install the latest release run:

```bash
curl -s https://raw.githubusercontent.com/fluxcd/flux2/main/install/flux.sh | sudo bash
```

**Note**: You may export an env `GITHUB_TOKEN` which is a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
to avoid running into Github API rate limiting while executing the install script.
This is recommended if you execute the install script multiple times within the same rate limting window.

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

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

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

## Build from source

Clone the repository:

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

Build the `flux` binary (requires go >= 1.15):

```bash
make build
```

Run the binary:

```bash
./bin/flux -h
```