Skip to main content
The /claude-hud:configure command walks you through an interactive guided flow to configure what your HUD shows and how it looks. It reads your existing config (if any), presents contextual questions, shows a preview of the result, and writes ~/.claude/plugins/claude-hud/config.json. Changes take effect immediately — no restart required.
Configure never touches advanced manual settings. The following are preserved exactly as-is during every save: colors.*, pathLevels, display.usageThreshold, and display.environmentThreshold. To change these, edit ~/.claude/plugins/claude-hud/config.json directly.

Always-on elements

These two elements are always enabled and are not configurable:
  • Model name[Opus]
  • Context bar████░░░░░░ 45%

Which flow runs

Configure detects whether a config file already exists and routes accordingly:
  • No config → Flow A (new user): Layout → Preset → Turn Off → Turn On → Custom Line
  • Config exists → Flow B (update): Turn Off → Turn On → Git Style → Layout/Reset → Custom Line
For first-time configuration. Starts from a preset and lets you fine-tune.
1

Choose a layout

OptionWhat it does
Expanded (recommended)Splits information into semantic lines — project, context, usage, activity
CompactEverything on a single line
Compact + SeparatorsSingle line with a visual separator before activity lines
Config written:
LayoutlineLayoutshowSeparators
Expandedexpandedfalse
Compactcompactfalse
Compact + Separatorscompacttrue
2

Choose a preset

Presets define which elements are on or off as a starting point.
PresetWhat’s included
Full (recommended)Everything enabled — tools, agents, todos, git, usage, duration, session name
EssentialActivity lines (tools, agents, todos) + git + session duration. Info fields off.
MinimalCore only — model name and context bar. Everything else off.
Preset element defaults:
ElementFullEssentialMinimal
Tools activityONONOFF
Agents statusONONOFF
Todo progressONONOFF
Git statusONONON
Config countsONOFFOFF
Token breakdownONOFFOFF
Usage limitsONOFFOFF
Session durationONONOFF
Session nameONOFFOFF
3

Turn off (optional)

Shows only the elements that are on in your chosen preset. Select any you want to disable.If you chose Minimal, this step is skipped (nothing is on to turn off).
4

Turn on (optional)

Shows only the elements that are off in your chosen preset. Select any you want to enable.If you chose Full, this step is skipped (everything is already on).
5

Custom line (optional)

Optionally add a custom phrase to display in your HUD (max 80 characters). Saved as display.customLine in config.Skip this step if you don’t want a custom line.

All configurable elements

ElementConfig keyDefault
Tools activitydisplay.showToolsfalse
Agents statusdisplay.showAgentsfalse
Todo progressdisplay.showTodosfalse
Project namedisplay.showProjecttrue
Git statusgitStatus.enabledtrue
Config countsdisplay.showConfigCountsfalse
Token breakdowndisplay.showTokenBreakdowntrue
Output speeddisplay.showSpeedfalse
Usage limitsdisplay.showUsagetrue
Usage bar styledisplay.usageBarEnabledtrue
Session namedisplay.showSessionNamefalse
Session durationdisplay.showDurationfalse
Custom linedisplay.customLine

Preview before saving

Before writing anything, configure shows a summary of changes and a preview of exactly how your HUD will look: Expanded layout:
[Opus | Pro] │ my-project git:(main*)
Context ████░░░░░ 45% │ Usage ██░░░░░░░░ 25% (1h 30m / 5h)
◐ Edit: file.ts | ✓ Read ×3
▸ Fix auth bug (2/5)
Compact layout:
[Opus | Pro] ████░░░░░ 45% | my-project git:(main*) | 5h: 25% | ⏱️ 5m
◐ Edit: file.ts | ✓ Read ×3
▸ Fix auth bug (2/5)
You confirm before any changes are saved. If you cancel (Esc) or the result is identical to your current config, nothing is written.

Config file location

Configuration is written to:
~/.claude/plugins/claude-hud/config.json
The file is merged on each save — only the keys touched by the configure flow are updated. All other keys, including advanced settings, remain unchanged.

Build docs developers (and LLMs) love