Skip to content

Configuration

claude-dashboard is configured through a JSON file and the /claude-dashboard:setup command.

The fastest way to configure is via the setup command:

Terminal window
# Preset modes
/claude-dashboard:setup compact # 1 line (default)
/claude-dashboard:setup normal en pro # 2 lines, English, Pro plan
/claude-dashboard:setup detailed ko max # 5 lines, Korean, Max plan
# Custom mode: control widget order and line composition
# Format: "widget1,widget2,...|widget3,widget4,..." (| separates lines)
/claude-dashboard:setup custom auto max "model,context,cost|projectInfo,todoProgress"

Running /claude-dashboard:setup without arguments launches interactive mode, which guides you through each option.

FeatureMaxPro
5h rate limit + countdownYesYes
7d all modelsYesNo

Pro plan users will not see the 7-day rate limit widgets (rateLimit7d, rateLimit7dSonnet), as these limits only apply to the Max plan.

The configuration is stored at ~/.claude/claude-dashboard.local.json. You can edit this file directly or use the setup command.

{
"language": "auto",
"plan": "max",
"displayMode": "custom",
"lines": [
["model", "context", "cost", "rateLimit5h"],
["projectInfo", "todoProgress"]
],
"theme": "default",
"separator": "pipe",
"dailyBudget": 15,
"disabledWidgets": [],
"cache": {
"ttlSeconds": 300
}
}

For quick configuration, you can use a preset string instead of specifying lines manually:

{
"preset": "MC$R|BDO",
"theme": "tokyoNight",
"separator": "dot"
}

When preset is set, it overrides displayMode with custom and generates the line layout from the shorthand string. See Preset Shortcuts for the character mapping.

Set a daily budget limit in USD to track your spending:

{
"dailyBudget": 15
}

The budget widget shows daily spending versus your configured limit. Warning indicators appear at 80% usage and critical alerts at 95%.

Add widget IDs to disabledWidgets to hide specific widgets from any display mode (including presets and custom layouts):

{
"disabledWidgets": ["codexUsage", "geminiUsage"]
}

Empty lines that result from disabling widgets are automatically removed.

Widgets that show utilization percentages use a consistent color scheme:

  • Green (0-50%): Safe range
  • Yellow (51-80%): Warning range
  • Red (81-100%): Critical range

This applies to context usage, rate limits, cache hit rate, budget utilization, and similar percentage-based widgets.