Skip to content
Start free

CLI

CLI Installation

Install the kubeadapt CLI with Homebrew, go install, or a release binary from GitHub. Builds are available for macOS, Linux, and Windows.

Last updated

Install the kubeadapt binary with Homebrew, with go install, or from a GitHub release archive.

Homebrew

Homebrew is the recommended method on macOS and Linux. The formula ships a prebuilt binary.

bash
brew install kubeadapt/tap/kubeadapt

To upgrade to the latest version:

bash
brew upgrade kubeadapt/tap/kubeadapt

go install

With Go 1.26 or newer:

bash
go install github.com/kubeadapt/kubeadapt-cli/cmd/kubeadapt@latest

The binary is installed to $(go env GOPATH)/bin.

Release binaries

Each GitHub release has archives for Linux, macOS, and Windows on amd64 and arm64. Archives are named kubeadapt_<version>_<os>_<arch>.tar.gz (.zip on Windows), and the release includes a checksums.txt file with SHA-256 sums.

For example, on Linux amd64:

bash
VERSION=0.3.0
curl -sSLO "https://github.com/kubeadapt/kubeadapt-cli/releases/download/v${VERSION}/kubeadapt_${VERSION}_linux_amd64.tar.gz"
tar -xzf "kubeadapt_${VERSION}_linux_amd64.tar.gz" kubeadapt
sudo mv kubeadapt /usr/local/bin/

On Windows, download the windows .zip, extract kubeadapt.exe, and add its folder to your PATH.

Build from source

To build a local checkout, run task build. It needs Task and GoReleaser, and writes the binary to bin/kubeadapt.

bash
git clone https://github.com/kubeadapt/kubeadapt-cli.git
cd kubeadapt-cli
task build

Uninstall

MethodCommand
Homebrewbrew uninstall kubeadapt/tap/kubeadapt
go installrm "$(go env GOPATH)/bin/kubeadapt"
Release binaryDelete the binary you copied, e.g. sudo rm /usr/local/bin/kubeadapt
Source buildRemove the cloned directory

Uninstalling leaves your config file in place. Run kubeadapt auth logout first if you want the stored API key removed.

Verify installation

Confirm the binary is on your PATH:

bash
kubeadapt version

Expected output:

plaintext
kubeadapt 0.3.0
  Commit:     <commit>
  Built:      <build time>
  Go version: <go version>
  OS/Arch:    darwin/arm64

kubeadapt version -o json prints the same fields as version, commit, built, go_version, and os_arch.

Next