Skip to main content

Module command_catalog

Module command_catalog 

Source
Expand description

Machine-readable command catalog.

Structs§

ActionFields
ActionTemplate
AdvertisedAction
CanonicalAction
CommandAction
CommandCatalogArgument
CommandCatalogEntry
CommandCatalogExitCode
CommandCatalogOption
CommandCatalogOutput
CommandJsonDiscriminator
CommandRuntimeContract
CommandSideEffectFlags
The catalog’s declared mutation surface for a command, surfaced to callers such as --dry-run so the plan report cites the single source of truth (heddle help --output json) rather than re-deriving side effects at each call site.

Enums§

CommandSideEffect

Functions§

advanced_help_groups
Area groups for the heddle help advanced listing, 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 explicit help_category on their registration, while automation / admin / git_projection commands 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"). Returns None for 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