Install and update · kdashboard docs

Installers for macOS, Linux and Windows, how each platform updates, and how to build from source.

kdashboard is a desktop app. There is nothing to install in the cluster and no account to create. Every build is on the releases page; the download page lists the current installers with their sizes and SHA-256 digests.

macOS

Homebrew is the recommended install, and the only update channel on macOS.

brew install folio-pro/tap/kdashboard

To install by hand, download kdashboard-<version>-arm64.dmg (Apple Silicon) or kdashboard-<version>-x64.dmg (Intel) and drag the app into Applications.

The unidentified-developer prompt

Builds carry an ad-hoc signature, but no Apple Developer ID and no notarization yet, so Gatekeeper stops the first launch of a build downloaded by hand. Either open it once with right-click → Open, or clear the quarantine flag:

xattr -cr /Applications/Kdashboard.app

Linux

The Linux build is an x86_64 AppImage.

curl -LO https://github.com/folio-pro/kdashboard/releases/latest/download/Kdashboard-<version>.AppImage
chmod +x Kdashboard-<version>.AppImage
./Kdashboard-<version>.AppImage

Windows

Download and run kdashboard-Setup-<version>.exe.

Updates

kdashboard checks the GitHub release feed once, a few seconds after it starts. Nothing is downloaded until you say so.

Platform	How an update is installed
macOS	The app tells you a new version is out and points you at Homebrew: `brew upgrade --cask kdashboard`. In-place updates need a signed build, which is on the roadmap.
Linux	In-app: download and restart.
Windows	In-app: download and restart.

Build from source

You need Node.js 20 or newer and Bun.

git clone https://github.com/folio-pro/kdashboard.git
cd kdashboard
bun install
bun run dev:electron        # the full app, with hot reload
bun run build:electron      # a packaged build in release/

scripts/dev-cluster.sh creates a kind cluster seeded with sample workloads — some of them deliberately broken — if you want something to point the app at.

Uninstall

Remove the app (brew uninstall --cask kdashboard, delete the AppImage, or use Add or remove programs). kdashboard leaves nothing in your clusters, so there is nothing to clean up there. What it keeps on your machine is listed in Settings.