Installation & Upgrade

The KubeKanvas CLI runs on macOS, Windows, and Linux. It requires kubectl and Helm to interact with your Kubernetes clusters. The CLI can install these dependencies for you via the setup command.

System Requirements

Requirement	Details
Operating System	macOS (Intel & Apple Silicon), Windows 10+, Linux (amd64/ arm64)
kubectl	Required for Kubernetes cluster operations (auto-installable)
Helm	Required for Helm chart deployment and release management (auto-installable)
Docker	Optional — only required for local k3d cluster setup

Install via Homebrew (Recommended)

The fastest way to install the KubeKanvas CLI on macOS or Linux is via Homebrew:

brew install kubekanvas/tap/kubekanvas

Verify the installation:

kubekanvas --version

Install via Direct Download

Pre-built binaries are available for all platforms on the Downloads page. Choose the correct binary for your operating system and architecture.

macOS

curl -L https://downloads.kubekanvas.io/latest/kubekanvas-macos-arm64 -o kubekanvas
chmod +x kubekanvas
sudo mv kubekanvas /usr/local/bin/

curl -L https://downloads.kubekanvas.io/latest/kubekanvas-macos-amd64 -o kubekanvas
chmod +x kubekanvas
sudo mv kubekanvas /usr/local/bin/

Linux

curl -L https://downloads.kubekanvas.io/linux/x64/latest/kubekanvas -o kubekanvas
chmod +x kubekanvas
sudo mv kubekanvas /usr/local/bin/

curl -L https://downloads.kubekanvas.io/linux/arm64/latest/kubekanvas -o kubekanvas
chmod +x kubekanvas
sudo mv kubekanvas /usr/local/bin/

Windows

Download the installer from the Downloads page and run the .exe installer. The CLI will be added to your PATH automatically.

Install via GUI Installer

Platform-specific GUI installers are available on the Downloads page:

macOS: .dmg installer with drag-and-drop
Windows: .exe installer with setup wizard
Linux: .deb and .rpm packages

Upgrade

Homebrew

brew upgrade kubekanvas

Direct Download

Download the latest binary from the Downloads page and replace the existing binary in your PATH.

Install Kubernetes Dependencies

After installing the CLI, run the setup command to automatically install kubectl and Helm if they are not already present:

kubekanvas setup

This command detects your platform and installs the appropriate versions of kubectl and Helm. See the setup command reference for details.

Verify Installation

kubekanvas --version
kubekanvas --help

Next step: Log in to KubeKanvas to authenticate your CLI with your account.