Expand description
Progressive-disclosure help: curated default, advanced surface, topic-scoped help.
The Heddle CLI’s default heddle help lists only the authority-aware loop
from the command contract table. Advanced affordances, automation,
admin commands, and Git projection commands are reachable
via heddle help advanced or heddle help <topic>. Per-verb help
via heddle <verb> --help continues to derive from clap
doc-comments.
§Cultural deliverable
The default help is curated, not auto-generated. Tier metadata
lives in the command contract table so human help and machine
command catalog output cannot drift. See AGENTS.md “CLI surface
curation” for the full doctrine.
Enums§
Functions§
- advanced_
verbs - Verbs surfaced by
heddle help advanced, in command-contract order. This includes power surfaces, automation/admin commands, and Git interop surfaces, each labeled by the contract table. - everyday_
verbs - Verbs that show in
heddle help, in command-contract order. Blurbs are looked up at print time from the command catalog. - print_
capture_ agent_ help - Render
capture’s clap-derived help with the hidden agent-automation flags revealed. Called from theCommands::Capturedispatch arm once clap has parsed--help-agent(a first-class flag oncapture). - print_
direct_ help_ for_ raw - print_
help - Entry point for the
Commands::Help { topics }dispatch arm AND the bare-help intercept inmain.rs. Routes between everyday / advanced / topic surfaces and falls through to clap-derived help for command paths without a dedicated topic. - render_
capture_ agent_ help - Render
capture --help-agentto aString(the reveal-help variant). - render_
direct_ help_ for_ raw - Render the
heddle <path> --helppre-parse help to aString. - render_
for_ args - Render the help that
heddle <args>would print, in-process, for the help-shaped argv forms — without spawning the binary. - render_
help - Render the curated help surface to a
Stringinstead of stdout. - tier_of
- Stable name for each verb. Pure presentation — has no relation to the clap variant identifier so doc-comment regenerations don’t churn this file.
- topic_
text - Static per-topic help. Topics are addressed via
heddle help <topic>.