A simple terminal dashboard for Kubernetes built with Rust
Homebrew (Mac & Linux)
brew tap kdash-rs/kdash brew install kdash # If you need to be more specific, use: brew install kdash-rs/kdash/kdash
brew upgrade kdash
Scoop (Windows - Recommended way)
scoop bucket add kdash-bucket https://github.com/kdash-rs/scoop-kdash scoop install kdash
Choco package located here. Since validation of the package takes forever, it may take a long while to become available after a release. I would recommend using Scoop instead for Windows.
choco install kdash # Version number may be required for newer releases, if available: choco install kdash --version=0.1.0
choco upgrade kdash --version=0.1.0
Run the below command to install the latest binary. Run with sudo if you dont have write access to /usr/local/bin. Else the script will install to current directory
curl https://raw.githubusercontent.com/kdash-rs/kdash/main/deployment/getLatest.sh | bash
Binaries for macOS, Linux and Windows are available on the releases page
- Download the latest binary for your OS.
- For Linux/macOS:
cdto the file you just downloaded and run
tar -C /usr/local/bin -xzf downloaded-file-name. Use sudo if required.
- Run with
- For Windows:
- Use 7-Zip or TarTool to unpack the tar file.
- Run the executable file
Run KDash as a Docker container by mounting your
KUBECONFIG. For example the below for default path
docker run --rm -it -v ~/.kube/config:/root/.kube/config deepu105/kdash
You can also clone this repo and run
make docker to build a docker image locally and run it using above command
Note: This may not work properly if you run Kubernetes locally using Minikube or Kind
If you have Cargo installed then you install KDash from crates.io
cargo install kdash
You can also clone the repo and run
cargo run or
make to build and run the app
Note:: On Linux you might need to have package
xorg-dev (Debian/Ubuntu) or
xorg-x11-server-devel (Fedora) or equivalent installed for the copy to clipboard features to work
? while running the app to see keybindings
-h, --help: Prints help information
-V, --version: Prints version information
-t, --tick-rate <tick-rate>: Set the tick rate (milliseconds): the lower the number the higher the FPS.
-p, --poll-rate <poll-rate>: Set the network call polling rate (milliseconds, should be multiples of tick-rate): the lower the number the higher the network calls.
- [Windows] KDash looks better on CMD since Powershell’s default theme makes the colours look weird.
- [Windows] If using k3d for local clusters, set the server URL to 127.0.0.1 as 0.0.0.0 doesn’t work with kube-rs. You can use
k3d cluster create --api-port 127.0.0.1:6550or change the
cluster.servervalue in your
.kube/configfor the k3d cluster to
- CLI Info
- Node metrics
- Resource Watch (configurable polling interval with
- Describe resources & copy output
- Get YAML for resources & copy output
- Stream container logs
- Context info
- Context watch
- Change namespace
- Context switch
- Resources utilizations for nodes, pods and namespaces based on metrics server. Requires metrics-server to be deployed on the cluster.
- Dark/Light themes
Container logs screen (light theme)
Pod describe screen (light theme)
How does this compare to K9S?
K9S is a beast compared to this as it offers way more features including CRUD actions.
KDash only offers a view of most used resources with a focus on speed and UX. Really, if something is slow or have bad UX then please raise a bug. Hence the UI/UX is designed to be more user friendly and easier to navigate with contextual help everywhere and a tab system to switch between different resources easily.
At least for now there are no plans to add full CRUD for resources but we will add more resources and more useful actions