Installation

Kluctl is available as a CLI and as a GitOps controller.

Installing the CLI link

Binaries link

The kluctl CLI is available as a binary executable for all major platforms, the binaries can be downloaded form GitHub releases page.

Installation with Homebrew link

With Homebrew for macOS and Linux:

  brew install kluctl/tap/kluctl
  

Installation with Bash link

With Bash for macOS and Linux:

  curl -s https://kluctl.io/install.sh | 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 kluctl binary to /usr/local/bin
• removes the temporary directory

Build from source link

Clone the repository:

  git clone https://github.com/kluctl/kluctl
cd kluctl
  

Build the kluctl binary (requires go >= 1.19):

  make build
  

Run the binary:

  ./bin/kluctl -h
  

Container images link

A container image with kluctl is available on GitHub:

• ghcr.io/kluctl/kluctl:<version>

Installing the GitOps Controller link

The controller can be installed via two available options.

Using the “install” sub-command link

The kluctl controller install command can be used to install the controller. It will use an embedded version of the Controller Kluctl deployment project found here.

Using a Kluctl deployment link

To manage and install the controller via Kluctl, you can use a Git include in your own deployment:

  deployments:
  - git:
      url: https://github.com/kluctl/kluctl.git
      subDir: install/controller
      ref:
        tag: v2.24.1
  

Installing the Kluctl Webui link

See Installing the Kluctl Webui for details.