CLI reference
heddle capture
Shippedheddle capture -m <INTENT> [OPTIONS] Capture a recoverable Heddle step for undo, provenance, and review
Output text (default) · json · json-compact
Flags
--help-agent <HELP_AGENT>hidden- Reveal the hidden agent-automation flags inline instead of capturing. A first-class clap flag so the whole command line (including global options in any spelling clap accepts) is parsed by clap; the dispatch arm inspects the parsed result rather than scanning raw tokens. `hide`d to keep everyday `capture --help` terse (the after-help pointer is the discovery route). It is still a registered clap arg, so `doctor docs` recognizes `heddle capture --help-agent` via the registered-but-hidden flag seam — the machine contract stays in sync without cluttering human help values:
true · falseAccepted by the CLI, but absent from standard--help. --intent <INTENT>, -m <INTENT>, --message- Required natural-language intent for this recoverable step
--confidence <CONFIDENCE>- Confidence level (0.0-1.0)
--force <FORCE>, -f <FORCE>- Allow a large or deletion-heavy capture without the safety preflight values:
true · false --agent-provider <AGENT_PROVIDER>hidden- Override HEDDLE_AGENT_PROVIDER Accepted by the CLI, but absent from standard
--help. --agent-model <AGENT_MODEL>hidden- Override HEDDLE_AGENT_MODEL Accepted by the CLI, but absent from standard
--help. --agent-session <AGENT_SESSION>hidden- Override active agent session id Accepted by the CLI, but absent from standard
--help. --agent-segment <AGENT_SEGMENT>hidden- Override active agent session segment Accepted by the CLI, but absent from standard
--help. --policy <POLICY>hidden- Override HEDDLE_AGENT_POLICY Accepted by the CLI, but absent from standard
--help. --no-policy <NO_POLICY>hidden- Omit policy attribution values:
true · falseAccepted by the CLI, but absent from standard--help. --no-agent <NO_AGENT>hidden- Omit agent attribution values:
true · falseAccepted by the CLI, but absent from standard--help. --split <SPLIT>hidden- Split selected paths into another thread instead of capturing the whole worktree values:
true · falseAccepted by the CLI, but absent from standard--help. --into <INTO>hidden- Target thread when using `--split` Accepted by the CLI, but absent from standard
--help. --path <PATH>hidden- Repository-relative path prefix to include when using `--split` Accepted by the CLI, but absent from standard
--help. --op-id <OP_ID>hidden- Operation id (UUID v4) for idempotent retries. See `heddle help operation-ids` Accepted by the CLI, but absent from standard
--help.
Examples
save state (and its Git Overlay checkpoint)
bash$ heddle capture -m 'add login route'honest confidence on a draft step
bash$ heddle capture -m 'wip' --confidence 0.6