mirror of https://github.com/jarrodwatts/claude-hud.git synced 2026-05-18 05:32:44 +00:00

Files

Jarrod Watts 36b2a09210 docs: add project documentation and improve robustness

- Add ARCHITECTURE.md, FAQ.md, LLM.md documentation
- Add LICENSE (MIT), CODE_OF_CONDUCT.md, PR template
- Add .editorconfig for consistent formatting
- Add check.sh script for validation
- Fix ESLint errors in hud-config.ts and settings-reader.ts
- Various test and component improvements

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2026-01-03 12:17:50 +11:00

1.2 KiB

Raw Blame History

FAQ

Does Claude HUD change Claude's outputs or prompts?

No. Claude HUD is read-only. It listens to Claude Code hook events and renders a UI, but it does not modify prompts, tools, or outputs.

Does it work if my terminal doesn't support splits?

Yes. Claude HUD tries to open a split pane when supported (tmux, iTerm2, Kitty, WezTerm, Zellij, Windows Terminal WSL). If splits are not available, it falls back to a separate window or background process.

How do I uninstall?

claude /plugin uninstall claude-hud

Does it require network access?

No. The HUD runs locally and only reads Claude Code hook events.

What does it depend on?

Claude Code (v1.0.33+)
Node.js 18+ or Bun
jq for JSON parsing in hook scripts

What data does it read?

It consumes Claude Code hook payloads and session events. It does not read your code unless a hook event includes metadata (like file paths) that Claude Code already exposes.

Where are runtime files stored?

Under ~/.claude/hud/:

events/<session_id>.fifo for the event stream
pids/<session_id>.pid for process tracking
logs/<session_id>.log for fallback logs

How do I debug it?

CLAUDE_HUD_DEBUG=1 claude
claude --debug hooks

For more, see TROUBLESHOOTING.md.

1.2 KiB Raw Blame History

FAQ