Quick Start

Get KubeGraf running and connected to your cluster in under a minute.

Install KubeGraf

Run the install script (macOS/Linux):

curl -sSL https://kubegraf.io/install.sh | bash

Or use a package manager. See Installation for more options.

Launch Terminal UI

Simply run kubegraf in your terminal:

kubegraf

KubeGraf automatically reads your ~/.kube/config and connects to the current context.

Or Launch Web Dashboard

Start the web UI with:

kubegraf --web

Then open http://localhost:8080 in your browser.

Basic Navigation (Terminal UI)

The terminal UI uses vim-style keybindings:

j / k - Move up/down
Tab - Switch between tabs (Pods, Deployments, Services, etc.)
Enter - View resource details
n - Change namespace
c - Change context/cluster
/ - Search/filter resources
l - View logs (on a pod)
s - Shell into container
r - Refresh
q - Quit

Tip: Press ? at any time to see all available keybindings.

Switching Clusters

KubeGraf supports multiple cluster contexts:

# Use a specific context
kubegraf --context my-cluster

# Use a specific kubeconfig file
kubegraf --kubeconfig /path/to/config

# List available contexts
kubegraf contexts

Common Commands

# Terminal UI (default)
kubegraf

# Web dashboard
kubegraf --web

# Web dashboard on custom port
kubegraf --web --port 3000

# Specific namespace
kubegraf -n kube-system

# All namespaces
kubegraf -A

Next Steps

Master the Terminal UI - Learn all keyboard shortcuts
Explore the Web Dashboard - Visual interface guide
Resource Map - Visualize cluster relationships
Configuration - Customize themes, keybindings