jarrodwatts/claude-hud Instruction Manual

What jarrodwatts/claude-hud is—in plain language

Claude Code status-line HUD for project path, context health, tools, agents, todos, and usage from native session/transcript data.

Mental model: This repository extends a host application. The host loads its commands, skills, hooks, or agents; most day-to-day use happens inside that host rather than by launching a separate app.

Interfacesplugin, status line

Primary languageNone documented

Typical useMonitor long Claude Code sessions without leaving the terminal.

Your first 15 minutes

Complete the linked Installation Guide and its verification step.
Create a disposable test folder or use non-sensitive sample data.
Run the small example below and observe what files, ports, or prompts appear.
Read the result before approving writes, network calls, account access, or costs.
Only then repeat the workflow with a real project.

Starter workflow

git clone https://github.com/jarrodwatts/claude-hud
cd claude-hud
npm ci && npm run build
npm test

Open Installation Guide Open upstream README

Complete indexed functionality map

Each card below corresponds to a component identified in the repository research. Open a component record for its path, purpose, capabilities, dependencies, risks, and relationships.

HUD renderer

plugin

Render live status.

README.md

Open component record →

Setup/config

command

Configure statusline/presets.

README.md

Open component record →

Upstream feature-by-feature guide

These capabilities are derived from the current first-party README and supporting documentation. Names follow upstream terminology so you can search the source documentation precisely.

Upstream capability

What is Claude HUD?

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns what is claude hud?. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Default (2 lines)

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns default (2 lines). Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

How It Works

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns how it works. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Configuration

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns configuration. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Presets

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns presets. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Manual Configuration

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns manual configuration. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Options

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns options. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Usage Limits

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns usage limits. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Security Notes

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns security notes. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Display Examples

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns display examples. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Auto-Refresh

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns auto-refresh. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

Upstream capability

Disabling the HUD Temporarily

Upstream treats this as a distinct part of jarrodwatts/claude-hud. In plain language, use this area when your task concerns disabling the hud temporarily. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.

How to use the main workflows

Choose the smallest relevant function

Start with one capability card instead of asking the repository to do everything at once. This makes permissions, inputs, and output easier to understand.

Prepare a disposable input

Use a sample URL, copied repository, test document, or sandbox account. Keep production credentials and irreplaceable files out of the first run.

Run, observe, and stop

Watch Terminal output or the host application's activity view. If the behavior differs from the README, stop with Control + C or cancel inside the host before retrying.

Inspect the result

Check generated files, diffs, API responses, logs, or previews. Never assume “command finished” means the result is correct.

Save a repeatable recipe

Record the working command and non-secret configuration in your project's README. Store secrets in the documented environment file or password manager.

Copy-paste recipes from upstream documentation

These examples are selected from the repository's first-party documentation. Replace obvious placeholders, keep quotation marks intact, and run them only in the context indicated by the surrounding explanation.

Development

git clone https://github.com/jarrodwatts/claude-hud
cd claude-hud
npm ci && npm run build
npm test

Configuration, accounts, and files

Configuration files

None documented

A configuration file changes behavior without changing source code. Make one change at a time and keep a backup before editing JSON, TOML, YAML, or environment files.

Important directories

None documented

Paths identify where the relevant implementation or generated files live. Paths beginning with ~ are inside your home folder.

Credentials

None documented

Prefer temporary, least-privileged credentials. Never commit .env, tokens, cookies, private keys, or session exports.

External services

None documented

Check pricing, data retention, rate limits, and account permissions before enabling optional integrations.

Safe operating habits

Use test data first and keep a current backup or Git commit.
Read commands before pasting. A README is useful evidence, not a substitute for judgment.
Review agent-generated file changes with git diff before committing.
Keep local services bound to 127.0.0.1 unless you intentionally secure and expose them.
Do not give plugins or MCP servers broader filesystem, browser, GitHub, or cloud access than their current task requires.
Confirm API costs and model names before running large batches.
Stop and investigate repeated authentication failures instead of pasting a token into multiple places.

Reference and source trail

The manual reflects first-party files checked on August 18, 2026. It explains the indexed repository rather than promising that every optional third-party integration is available or safe.