KubeKanvas Documentation

Your bridge between the KubeKanvas visual Kubernetes IDE and your clusters.

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

RequirementDetails
Operating SystemmacOS (Intel & Apple Silicon), Windows 10+, Linux (amd64/ arm64)
kubectlRequired for Kubernetes cluster operations (auto-installable)
HelmRequired for Helm chart deployment and release management (auto-installable)
DockerOptional — 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. Download URLs are pinned to a release, so the commands below always point at the current version (v1.27.0).

macOS

The macOS build ships as a .pkg installer, so install it with installer rather than moving a binary onto your PATH.

Apple Silicon (ARM64)
curl -fsSL https://downloads.kubekanvas.io/macos/arm64/8a46a26/kubekanvas-1.27.0-macos-arm64.pkg -o kubekanvas.pkg sudo installer -pkg kubekanvas.pkg -target /
Intel (x86_64)
curl -fsSL https://downloads.kubekanvas.io/macos/x64/8a46a26/kubekanvas-1.27.0-macos-x64.pkg -o kubekanvas.pkg sudo installer -pkg kubekanvas.pkg -target /
Linux

The Linux build is a standalone executable — there is no package to install.

x86_64 (amd64)
curl -fsSL https://downloads.kubekanvas.io/linux/x64/8a46a26/kubekanvas-1.27.0-linux-x64 -o kubekanvas chmod +x kubekanvas sudo mv kubekanvas /usr/local/bin/kubekanvas
ARM64 (aarch64)
curl -fsSL https://downloads.kubekanvas.io/linux/arm64/8a46a26/kubekanvas-1.27.0-linux-arm64 -o kubekanvas chmod +x kubekanvas sudo mv kubekanvas /usr/local/bin/kubekanvas
Windows

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

x86_64 (x64) — PowerShell
Invoke-WebRequest -Uri "https://downloads.kubekanvas.io/windows/x64/8a46a26/kubekanvas-1.27.0-windows-x64.exe" -OutFile "kubekanvas-1.27.0-windows-x64.exe"

Install via GUI Installer

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

  • macOS: .pkg installer
  • Windows: .exe installer with setup wizard
  • Linux: standalone executable — no package manager required

Upgrade

Homebrew
brew upgrade kubekanvas
Direct Download

Re-run the install command for your platform above — each release is published under its own version, so the URL changes with every upgrade. The commands overwrite the binary already on 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.