README
¶
vitals
A terminal statusline for Claude Code sessions.
Install
go install github.com/Jason-Adam/vitals/cmd/vitals@latest
Setup
Add to ~/.claude/settings.json:
{
"statusLine": {
"type": "command",
"command": "vitals"
}
}
To customize, run vitals --init to generate a config at ~/.config/vitals/config.toml.
Development
# Install pre-commit hooks
brew install pre-commit
pre-commit install
# Run tests
make test
License
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
vitals
command
|
|
|
internal
|
|
|
breadcrumb
Package breadcrumb manages permission-waiting breadcrumb files.
|
Package breadcrumb manages permission-waiting breadcrumb files. |
|
color
Package color handles terminal color capability detection and color conversion.
|
Package color handles terminal color capability detection and color conversion. |
|
config
Package config loads TOML-based HUD configuration with defaults.
|
Package config loads TOML-based HUD configuration with defaults. |
|
eval
Package eval provides color math and terminal palette utilities for evaluating widget contrast and theme coherence.
|
Package eval provides color math and terminal palette utilities for evaluating widget contrast and theme coherence. |
|
extracmd
Package extracmd executes an optional user-configured command and returns its label output for display in the statusline.
|
Package extracmd executes an optional user-configured command and returns its label output for display in the statusline. |
|
gather
Package gather coordinates parallel data collection for the statusline.
|
Package gather coordinates parallel data collection for the statusline. |
|
git
Package git provides git repository status information for the working directory.
|
Package git provides git repository status information for the working directory. |
|
hook
Package hook handles Claude Code hook events dispatched via the CLI subcommand "vitals hook <event>".
|
Package hook handles Claude Code hook events dispatched via the CLI subcommand "vitals hook <event>". |
|
logging
Package logging provides a debug file logger gated behind an environment variable.
|
Package logging provides a debug file logger gated behind an environment variable. |
|
model
Package model defines the shared data types passed between gather and render stages.
|
Package model defines the shared data types passed between gather and render stages. |
|
preset
Package preset defines the Preset data model and built-in presets.
|
Package preset defines the Preset data model and built-in presets. |
|
render
Package render walks config lines, calls widget functions, joins non-empty results with the configured separator, and writes each line to an io.Writer.
|
Package render walks config lines, calls widget functions, joins non-empty results with the configured separator, and writes each line to an io.Writer. |
|
render/widget
Package widget provides the registry of render functions and shared icon helpers.
|
Package widget provides the registry of render functions and shared icon helpers. |
|
setup
Package setup handles registration of Claude Code hooks in settings.json.
|
Package setup handles registration of Claude Code hooks in settings.json. |
|
stdin
Package stdin reads and parses the JSON blob that Claude Code pipes to stdin on every invocation.
|
Package stdin reads and parses the JSON blob that Claude Code pipes to stdin on every invocation. |
|
theme
Package theme provides named color theme presets for the HUD statusline.
|
Package theme provides named color theme presets for the HUD statusline. |
|
transcript
Package transcript — ExtractionState bridges parsed transcript entries into model.TranscriptData for statusline rendering.
|
Package transcript — ExtractionState bridges parsed transcript entries into model.TranscriptData for statusline rendering. |
Click to show internal directories.
Click to hide internal directories.