Expand description
Machine-readable command catalog.
Structs§
- Action
Fields - Action
Template - Advertised
Action - Canonical
Action - Command
Action - Command
Catalog Argument - Command
Catalog Entry - Command
Catalog Exit Code - Command
Catalog Option - Command
Catalog Output - Command
Json Discriminator - Command
Runtime Contract - Command
Side Effect Flags - The catalog’s declared mutation surface for a command, surfaced to
callers such as
--dry-runso the plan report cites the single source of truth (heddle help --output json) rather than re-deriving side effects at each call site.
Enums§
Functions§
- advanced_
help_ groups - Area groups for the
heddle help advancedlisting, in render order, as(display title, verbs)pairs (heddle#652). The grouping is contract-table data, not a hand-maintained help string: native advanced commands carry an explicithelp_categoryon their registration, whileautomation/admin/git_projectioncommands derive their group from the surface they already declare. Verbs keep contract order (help_rank, then name) within each group — the same ordering the flat list used. Feature-gated verbs absent from the current build simply don’t appear; a group may come back empty. - build_
command_ catalog - command_
canonical_ command - command_
contract_ root_ commands - command_
help_ tier - command_
help_ visibility - command_
json_ discriminators - command_
json_ discriminators_ for_ schema_ verb - command_
path - command_
persists_ op_ id - command_
runtime_ contract - command_
runtime_ contract_ for_ command - command_
side_ effect_ flags - Look up the declared side-effect flags for a command path (e.g.
"push","land","ready"). ReturnsNonefor an unknown command. - command_
supports_ json_ for_ command - command_
supports_ op_ id - command_
supports_ op_ id_ for_ command - command_
surface - command_
uses_ bootstrap_ op_ id_ store - heddle_
action - land_
local_ command - Build the canonical local land command for a thread.
- merge_
preview_ command - Build the canonical non-mutating merge-preview command for a thread.
- observe_
only_ root_ commands - operator_
envelope_ verbs - recommended_
action_ template - root_
commands_ for_ advanced_ help - root_
commands_ for_ help_ visibility - split_
recommended_ action - validate_
recommended_ action