Look up
CLI reference
Every heddle command. Grouped by what you're trying
to do. Three families have full reference pages today;
everything else is listed with a status chip so you can see what
ships, what's foundation, and what's planned. The full set
arrives in v2 via a typed spec file mirrored against the
binary's structured help.
Working in a repo
- heddle init Shipped
Initialise a Heddle repo beside Git. Adopts the current branch as main.
- heddle capture Shipped
Snapshot the working tree into the current thread.
- heddle thread Shipped
Manage threads — 17 subcommands covering creation, navigation, refresh, absorb, promote, drop, approval, and cleanup.
thread createStart a new task threadthread switchSwitch the current checkout to an existing thread refthread listList threads in the repositorythread showDisplay one thread with actor and workflow contextthread capturesShow granular captures on a threadthread renameRename a thread refthread refreshRebase the thread onto its target threadthread moveMove selected captured paths between threadsthread absorbAbsorb a child thread into its parent or another threadthread resolveGuide a blocked or stale thread toward its next clean statethread promotePromote a thread to a heavy checkout at a chosen paththread dropDrop a thread and mark it abandonedthread approveRecord a merge approval for source → target (feature-gated: hosted-client)thread approvalsList approvals recorded for source → target (feature-gated: hosted-client)thread revoke-approvalRevoke a previously recorded approval by id (feature-gated: hosted-client)thread check-mergeCheck whether source → target would merge under branch-protection policies (read-only, feature-gated)thread cleanupSweep threads that have outlived their usefulness — drop checkouts and registry entries
- heddle fork Shipped
Fork from any state into a new (or detached) thread for parallel exploration without context loss.
Reading and reviewing
- heddle review Shipped
Read the review payload for a state, sign it, walk to the next pending review, and surface signal health.
review showRender the review payload for a state (defaults to HEAD)review signSubmit a review signature on a state (kind: read / agent_preview / agent_co_review)review nextWalk to the next pending reviewreview healthPer-module signal health over a rolling window of states
- heddle context Shipped
Attach reasoning to files, symbols, and line ranges — re-anchored on every capture so notes survive refactor.
context setAttach a context annotation to a file, symbol, line range, or statecontext getShow context annotations for a file or state targetcontext listList all active context targetscontext historyShow full revision history for one logical annotationcontext editAdd a new revision to an existing logical annotationcontext supersedeCreate a replacement annotation and supersede an older onecontext rmRemove context annotationscontext checkCheck annotation staleness against current codecontext suggestSuggest low-noise targets that may benefit from contextcontext auditAudit stale, superseded, and duplicate context
- heddle discuss Shipped
Symbol-anchored discussions with multi-mode resolution (into-annotation / by-edit / dismiss).
discuss openOpen a new discussion anchored to a (file, symbol)discuss appendAppend a turn to an existing discussiondiscuss resolveResolve a discussion via --mode (into-annotation | by-edit | dismiss)discuss listList discussions filtered by state, symbol, or statusdiscuss showShow a single discussion with its turns
Bridging to Git
- heddle bridge git Shipped
Round-trip with Git — init mirror, export states, import history, sync both ways, push/pull a remote.
bridge git statusShow the Heddle ↔ Git bridge statebridge git initInitialize the Git mirror at .heddle/git/bridge git exportExport states to a bare Git repo at --destinationbridge git importImport local branches and tags from a source repo (--path, --ref)bridge git syncBidirectional sync — export then importbridge git pushPush to the bridged Git remote (default: origin)bridge git pullPull from the bridged Git remote (default: origin)
Agents and integrations
- heddle agent Shipped
Run the agent gRPC daemon over a Unix socket, plus the reservation API for out-of-process orchestration.
agent serveStart the agent gRPC daemon (Unix socket; requires --foreground)agent statusShow daemon status (pid, socket, pidfile)agent stopAsk the running daemon to drain and exitagent reserveAtomically reserve a thread for one writeragent heartbeatUpdate reservation heartbeatagent captureCapture under a session-validated reservationagent readyMark a reservation's thread ready for integrationagent releaseRelease a reservation (status: complete | abandoned)agent listList agent reservations (optionally filtered to alive ones)
- heddle daemon Foundation
FUSE mount daemon — surfaces threads as virtual filesystems. Linux + --features mount build only.
daemon serveRun the mount daemon in the foregrounddaemon statusProbe whether the daemon is alivedaemon stopRequest a graceful shutdown
Repository care
- heddle fsck Shipped
Repository integrity check. Walks the object graph; --bridge also validates the Git overlay; --repair reconstructs from the oplog.
- heddle doctor Shipped
Repository health snapshot, plus dev-build-only drift-checkers. `doctor docs` keeps this docs site in sync with the binary; `doctor schemas` keeps published JSON samples in sync.
doctor docsDiff-check markdown docs against the real CLI surface — exits non-zero on driftdoctor schemasDiff-check `docs/json-schemas.md` against the canonical schema registry
- heddle completion Shipped
Emit shell completion scripts — bash, zsh, fish (no powershell).
- heddle redact Shipped
Redact sensitive blobs from history. Reads return a stub; the receipt stays.
redact applyRedact a blob and write a tombstoneredact listList active redactions in this reporedact showShow the tombstone for a redactionredact trust addAdd an operator public key to [redact] trusted_keys so signed redactions from that key are accepted over the wireredact trust listList the currently-trusted operator keysredact trust removeRemove an operator public key from the trust list
- heddle purge Shipped
Physically remove redacted bytes from disk. Irreversible. The hard form of redaction.
purge applyHarden a redaction into a purgepurge listList purges performed in this repo