kdash-rs/kdash
{ "createdAt": "2021-04-13T05:38:42Z", "defaultBranch": "main", "description": "A simple and fast dashboard for Kubernetes", "fullName": "kdash-rs/kdash", "homepage": "https://kdash.cli.rs", "language": "Rust", "name": "kdash", "pushedAt": "2025-10-17T07:02:24Z", "stargazersCount": 2385, "topics": [ "dashboard", "hacktoberfest", "k8s", "kubernetes", "monitoring", "rust", "tui" ], "updatedAt": "2025-11-23T14:22:09Z", "url": "https://github.com/kdash-rs/kdash"}KDash - A fast and simple dashboard for Kubernetes
Section titled “KDash - A fast and simple dashboard for Kubernetes”![logo]!(artwork/logo.png)
A simple terminal dashboard for Kubernetes built with Rust
![UI]!(screenshots/ui.gif)
Sponsors
Section titled “Sponsors”Thanks to the sponsors of @deepu105 who makes maintaining projects like KDash sustainable. Consider sponsoring if you like the work.
Installation
Section titled “Installation”Homebrew (Mac & Linux)
Section titled “Homebrew (Mac & Linux)”brew tap kdash-rs/kdashbrew install kdash
# If you need to be more specific, use:brew install kdash-rs/kdash/kdashTo upgrade
brew upgrade kdashScoop (Windows - Recommended way)
Section titled “Scoop (Windows - Recommended way)”scoop bucket add kdash-bucket https://github.com/kdash-rs/scoop-kdash
scoop install kdashChocolatey (Windows)
Section titled “Chocolatey (Windows)”Chocolatey package is 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.4.3To upgrade
choco upgrade kdash --version=0.4.3If you have Cargo installed then you install KDash from crates.io
cargo install kdash
# if you face issues with k8s-openapi crate try the belowcargo install --locked kdashYou can also clone the repo and run cargo run or make to build and run the app
Nix (Maintained by third party)
Section titled “Nix (Maintained by third party)”Try out kdash via nix run nixpkgs#kdash or add kdash to your
configuration.nix for permanent installation.
Install script
Section titled “Install script”Run the below command to install the latest binary. Run with sudo if you don’t have write access to /usr/local/bin. Else the script will install to the current directory. Alternatively, set BIN_DIR environment variable e.g. BIN_DIR=~/.local/bin to override the default install location.
curl https://raw.githubusercontent.com/kdash-rs/kdash/main/deployment/getLatest.sh | bashManual
Section titled “Manual”Binaries for macOS (x86_64, arm64), Linux GNU/MUSL(x86_64, armv6, armv7, aarch64) and Windows (x86_64, aarch64) are available on the releases page
- Download the latest binary for your OS.
- For Linux/macOS:
cdto the file you just downloaded and runtar -C /usr/local/bin -xzf downloaded-file-name. Use sudo if required.- Run with
kdash
- For Windows:
- Use 7-Zip or TarTool to unpack the tar file.
- Run the executable file
kdash.exe
Docker
Section titled “Docker”Run KDash as a Docker container by mounting your KUBECONFIG. For example the below command for the default path
docker run --rm -it -v ~/.kube/config:/root/.kube/config deepu105/kdash# If you want localhost access from the containerdocker run --network host --rm -it -v ~/.kube/config:/root/.kube/config deepu105/kdashYou can also clone this repo and run make docker to build a docker image locally and run it using the above command
Troubleshooting
Section titled “Troubleshooting”Note: This may not work properly if you run Kubernetes locally using Minikube or Kind
Note: On Debian/Ubuntu you might need to install
libxcb-xfixes0-devandlibxcb-shape0-dev. On Fedoralibxcbandlibxcb-develwould be needed.
Note: On Linux you might need to have package
xorg-dev(Debian/Ubuntu) orxorg-x11-server-devel(Fedora) or equivalent installed for the copy to clipboard features to work
Note: If you are getting compilation error from openSSL. Make sure perl and perl-core are installed for your OS.
USAGE:
Section titled “USAGE:”kdashPress ? while running the app to see keybindings
FLAGS:
Section titled “FLAGS:”-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.-d, --debug[=<debug>]: Enables debug mode and writes logs tokdash-debug-<timestamp>.logfile in the current directory. Default behavior is to write INFO logs. Pass a log level to overwrite the default [possible values: info, debug, trace, warn, error]
Limitations/Known issues
Section titled “Limitations/Known issues”- [Linux/Docker] Copy to clipboard feature is OS/arch dependent and might crash in some Linux distros and is not supported on
aarch64andarmmachines. - [macOS] KDash looks better on iTerm2 since macOS’s default Terminal app makes the colors render weird.
- [Windows] KDash looks better on CMD since Powershell’s default theme makes the colors 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 thecluster.servervalue in your.kube/configfor the k3d cluster to127.0.0.1:<port>.
Features
Section titled “Features”- CLI info
- Node metrics
- Resource watch (configurable polling interval with
-pflag) - Custom resource definitions
- Describe resources & copy the output
- Get YAML for resources & copy the output
- Stream container logs
- Context
- 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
- Sensible keyboard shortcuts
- Global glob filtering for resource names
Screenshots
Section titled “Screenshots”Overview screen
Section titled “Overview screen”![UI]!(screenshots/overview.png)
Container logs screen (light theme)
Section titled “Container logs screen (light theme)”![UI]!(screenshots/logs.png)
Pod describe screen (light theme)
Section titled “Pod describe screen (light theme)”![UI]!(screenshots/describe.png)
Contexts screen
Section titled “Contexts screen”![UI]!(screenshots/contexts.png)
Utilization screen
Section titled “Utilization screen”![UI]!(screenshots/utilization.png)
Libraries used
Section titled “Libraries used”How does this compare to K9S?
Section titled “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 the resources with a focus on speed and UX. Really, if something is slow or has 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 in the future, we might.
Licence
Section titled “Licence”MIT