The Flux Command-Line Interface documentation.
The Flux CLI is available as a binary executable for all major platforms, the binaries can be downloaded from GitHub releases page.
Install using package management
brew install fluxcd/tap/flux
choco install flux
Install using Bash
To install the latest release on Linux, macOS or Windows WSL:
curl -s https://fluxcd.io/install.sh | sudo FLUX_VERSION=2.0.0-rc.4 bash
The install script does the following:
- attempts to detect your OS
- downloads, verifies and unpacks the release tar file in a temporary directory
- copies the
- removes the temporary directory
Install using Docker
A container image with
flux is available on DockerHub and GitHub:
$ docker run -it --entrypoint=sh -v ~/.kube/config:/kubeconfig ghcr.io/fluxcd/flux-cli:v2.0.0-rc.4 / # flux check --kubeconfig=kubeconfig
Enable shell autocompletion
To configure your shell to load
bash completions add to your profile:
. <(flux completion bash)
are also supported with their own sub-commands.
Last modified 2023-05-24: Update docs to Flux RC.4 (08eaeed)