Skip to main content

Module help

Module help 

Source
Expand description

Progressive-disclosure help: curated default, advanced surface, topic-scoped help.

The Heddle CLI’s default heddle help lists only the native 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§

Tier

Functions§

advanced_verbs
Verbs surfaced by heddle help advanced, in command-contract order. This includes power surfaces, automation/admin commands, and Git-shaped aliases, 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 the Commands::Capture dispatch arm once clap has parsed --help-agent (a first-class flag on capture).
print_direct_help_for_raw
print_help
Entry point for the Commands::Help { topics } dispatch arm AND the bare-help intercept in main.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-agent to a String (the reveal-help variant).
render_direct_help_for_raw
Render the heddle <path> --help pre-parse help to a String.
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 String instead 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>.