CLI Reference
The KTube CLI is a single binary that includes everything you need to install and manage KTube.
Included: Kubernetes client, Helm SDK, and Kind - no external dependencies required.
Commands
| Command | Description |
|---|---|
| ktube install | Install KTube to the cluster |
| ktube uninstall | Remove KTube from the cluster |
| ktube upgrade | Upgrade KTube to latest version |
| ktube dashboard | Open the KTube dashboard |
| ktube status | Check KTube installation status |
| ktube cluster create | Create local Kind cluster |
| ktube cluster delete | Delete local Kind cluster |
| ktube version | Print version information |
ktube install
Install KTube operator and dashboard to your cluster.
$ ktube install [flags]Flags
| Flag | Description | Default |
|---|---|---|
| --namespace, -n | Target namespace | ktube-system |
| --set | Set Helm values | - |
| -f, --values | Values file path | - |
| --version | Install specific version | latest |
Examples
# Basic install$ ktube install# Custom namespace$ ktube install -n my-namespace# With custom values$ ktube install --set operator.replicas=2ktube dashboard
Open the KTube dashboard in your browser.
$ ktube dashboardThis starts a port-forward to the dashboard and opens https://console.ktube.dev in your browser.
ktube cluster create
Create a local Kind cluster for development.
$ ktube cluster create [flags]Flags
| Flag | Description | Default |
|---|---|---|
| --name | Cluster name | ktube |
| --image | Kind node image | kindest/node:latest |
Shell Completions
# Bash$ source <(ktube completion bash)# Zsh$ source <(ktube completion zsh)# Fish$ ktube completion fish | source