// documentation
status-herald documentation
HERALD is a heads-up engine for terminal status surfaces: tmux curtain cards that cover unfocused agent panes, optional denizens (ASCII creatures per session), and native bars / Claude statusline segments.
Site: herald.muslewski.com · npm: status-herald
Start here
| Path | For |
|---|---|
| Getting started | Install → wire hooks → doctor → arm / grid |
| Bestiary | Signature page — denizens, poses, config |
| Works with | Fleet siblings (sage, oracle, atlas, armory, ferry) |
| Agent status providers | Shared filesystem convention (optional peers) |
| Interop ↔ agentic-sage | COMPACTING / observational compact path |
Doctrine (short)
- Standalone-first — install only status-herald and curtain + bars still work.
- Fail-open — missing siblings leave gauges/lines empty; nothing hard-errors.
- Per-pane honesty — timers, subs, NEEDS, COMPACTING answer the tab you are looking at.
- Open is instant — focus a card or tab → live session; no click gate.
Where other knowledge lives
| Kind | Location |
|---|---|
| Public product docs | docs/ (this tree) |
| Architecture mind (Atlas) | status-herald-mind/ — zones, decisions; specs/plans pipeline |
| Agent install runbook | AGENTS.md |
| Human README | README.md |
| Changelog | CHANGELOG.md |
Agent design notes under docs/superpowers/ are historical; new specs/plans go to the mind vault (status-herald-mind/specs/, status-herald-mind/plans/).