Skip to content
claude-dashboard

Quick Start

After installing claude-dashboard, you can configure it using the /claude-dashboard:setup command.

Run Setup

Section titled “Run Setup”

The simplest way to get started is to run the setup command without arguments. This launches interactive mode, which guides you through selecting a display mode, language, plan, and theme:

/claude-dashboard:setup

Choose a Display Mode

Section titled “Choose a Display Mode”

There are three built-in preset modes:

Compact (1 line) — Default

Section titled “Compact (1 line) — Default”

Shows the essential metrics on a single line.

/claude-dashboard:setup compact
◆ Opus(X) │ ██░░ 80% │ $1.25 │ 5h: 42% │ 7d: 69%

Normal (2 lines)

Section titled “Normal (2 lines)”

Adds project info, session details, and progress tracking.

/claude-dashboard:setup normal
◆ Opus(X) │ ██░░ 80% │ $1.25 │ 5h: 42% │ 7d: 69%
📁 project (main ↑3) │ 🔑 abc123 │ ⏱ 45m │ 🔥 5K/m │ ✓ 3/5

Detailed (6 lines)

Section titled “Detailed (6 lines)”

Shows all available widgets including analytics, multi-CLI usage, and insights.

/claude-dashboard:setup detailed
◆ Opus(X) │ ██░░ 80% │ $1.25 │ 5h: 42% │ 7d: 69%
📁 project (main ↑3) │ » feature-auth │ 🔑 abc123 │ ⏱ 45m │ 🔥 5K/m │ ⚡ 67 tok/s │ ⏳ 2h │ ✓ 3/5
CLAUDE.md: 2 │ ⚙️ Read(app.ts) (12 done) │ 🤖 Agent: 1 │ 📦 85% │ 🟢 72%
📊 In 30K · Out 8K │ 📈 ~$8/h │ 💵 $5/$15 │ 💰 Today: $4.83
🔷 codex │ 💎 gemini │ +156 -23 │ concise │ v1.0.80 │ Off-Peak (23h9m)
💬 14:32 Fix the authentication bug │ NORMAL │ API 42% │ 🏷 v1.2.3 +5

Specify Language and Plan

Section titled “Specify Language and Plan”

You can pass additional arguments for language and plan:

Terminal window
/claude-dashboard:setup normal en pro       # English, Pro plan
/claude-dashboard:setup detailed ko max     # Korean, Max plan

What’s Next

Section titled “What’s Next”