Look up
CLI reference
Every heddle command, grouped by what you're trying to
do, in the order the CLI's own help presents itself. Names, flags,
flag values and exit codes on these pages are generated from the
command catalog of heddle 0.26.0 — a page that
documents something the binary doesn't have fails CI.
Three pages carry contracts rather than commands, and they are the
ones to read first if you are driving Heddle unattended: exit codes (only 75 is safe to retry), machine output (error envelopes go to stderr), and auth and identity.
The everyday loop
- heddle status Shipped
Show what needs attention and the next safe Heddle action
- heddle diff Shipped
Show what changed in the worktree, a thread, or two states
- heddle capture Shipped
Capture a recoverable Heddle step for undo, provenance, and review
- heddle start Shipped
Create or resume an isolated thread for focused work
- heddle ready Shipped
Check this checkout before local integration
- heddle land Shipped
Integrate into the local target thread; push to publish
Synchronising
- heddle push Shipped
Push the source-authoritative history to a remote
- heddle pull Shipped
Pull source-authoritative history from a remote
- heddle clone Shipped
Download an existing repository into a local directory
Reading history
- heddle log Shipped
Show state history
- heddle show Shipped
Show state details
Setting up
- heddle init Shipped
Initialize Heddle in a directory or existing Git checkout
- heddle import local Shipped
Import a Git checkout on this computer
Recovery
- heddle undo Shipped
Undo the last Heddle operation
- heddle resolve Shipped
Resolve merge conflicts
- heddle verify Shipped
Verify this workspace; exits nonzero until every check is clean
Threads, reading and reviewing
- heddle thread Shipped
Manage threads
thread createCreate a thread ref at the current statethread currentPrint the name of the current thread (the thread the working checkout is attached to). Read-only — no state change. Useful in shell pipelines: `cd "$(heddle thread cd "$(heddle thread current)")"`thread switchSwitch the current checkout to an existing thread refthread cdPrint the on-disk path for a thread. Read-only — no state change, no auto-capture. Without a shell hook: cd "$(heddle thread cd X)" With `heddle shell init`, `heddle thread cd X` becomes `cd <path>`thread listList threadsthread showShow one thread with actor and workflow contextthread capturesShow granular captures on a threadthread renameRename a thread refthread refreshRefresh a thread onto its target threadthread moveMove selected captured paths from one thread into anotherthread absorbAbsorb a child thread into its parent or another threadthread resolveGuide a blocked or stale thread toward its next clean statethread ownershipInspect or explicitly transfer a Thread's native ownershipthread ownership statusShow the local owner or the complete signed conflictthread ownership claimExplicitly transfer a local-key Thread to the currently authorized accountthread ownership resolveOriginal local owner chooses one accepted claim; the current account acceptsthread checkoutCreate a working checkout for this threadthread dropDrop a thread and mark it abandonedthread cleanupSweep merged, stale auto-created, or abandoned threadsthread collapseCollapse (squash) multiple states into onethread expandExpand a squashed land into the captures it collapsedthread markerManage named state markers under the thread namespacethread marker listList markers, optionally filtered by name prefixthread marker createCreate marker at current statethread marker deleteDelete marker(s)thread marker showShow marker details
- heddle review Shipped
Review and approve an exact hosted Thread comparison
review showShow the exact source and target comparison for a Threadreview approveApprove the exact source and target comparison shown for this thread, using your configured signing identity.review listList signed review decisions for a Threadreview revokeRevoke one of your signed approvalsreview readinessCheck whether a Thread's exact comparison is ready to land into a targetreview signSubmit a low-level review signature on a statereview nextWalk to the next pending review when review selection is configuredreview healthPer-module signal health over a rolling window
- heddle context Shipped
Manage code context annotations
context setAttach a context annotation to a file, symbol, line range, or statecontext getShow current 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 logical 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 contextcontext reasonMine external sources for context annotationscontext reason gitMine Git-agent transcripts and attach reasoning as context annotations
- heddle discuss Shipped
Open or resolve discussions anchored to code
discuss newOpen a new discussiondiscuss replyReply to an existing discussiondiscuss resolveResolve a discussiondiscuss reopenReopen a resolved discussiondiscuss listList repository discussionsdiscuss showShow one discussion and its causal headsdiscuss waitReplay hosted discussion events after the local watermark, then go live
Round-tripping with Git
- heddle bridge git export Shipped reference in progress
Export Heddle states to Git
- heddle bridge git import Shipped reference in progress
Import Git commits to Heddle without changing source authority
- heddle sync git Shipped reference in progress
Bidirectional sync with Git (export + import)
Agents and integrations
- heddle agent Shipped
Agent reservation and one-shot orchestration API
agent reserveAtomically reserve a thread for one writeragent heartbeatUpdate reservation heartbeatagent captureCapture under a token-authenticated writer leaseagent readyMark a reservation's thread ready for integrationagent releaseRelease a reservation (status: complete | abandoned)agent listList agent reservations (optionally filtered to alive ones)agent taskManage local agent task assignmentsagent task createCreate a local agent task assignmentagent task listList local agent task assignmentsagent task showShow one local agent task assignmentagent task updateUpdate one local agent task assignmentagent fanoutPlan and start native fan-out lanesagent fanout planPreview fan-out lane setup and return commands without writingagent fanout startCreate task assignments and materialized child lanesagent provenanceRecord provider, model, and policy provenance across an agent runagent provenance beginBegin a provider/model provenance sessionagent provenance segmentRecord a provider, model, or policy change within the current sessionagent provenance endEnd the current or selected provenance sessionagent provenance showShow the current or selected provenance sessionagent provenance listList provenance sessionsagent presenceInspect attribution and work context for local agentsagent presence listList agent presence records known to this repositoryagent presence showShow the current or selected agent presence recordagent presence explainExplain why Heddle attached the current or selected presence recordagent presence completeMark the current or selected presence record completeagent timelineNavigate, fork, reset, and recover agent tool-call timelinesagent timeline statusShow the current timeline cursor, counts, and recovery statusagent timeline record-startRecord the start of a native tool timeline stepagent timeline record-finishRecord the finish of a native tool timeline stepagent timeline forkFork a timeline branch from a step or native harness tool callagent timeline resetReset the logical timeline cursor, optionally materializing checkout filesagent timeline recoverRecover a pending timeline materialization after an interrupted reset/seek
- heddle daemon Shipped
FUSE mount-daemon control plane — distinct from `agent`
daemon serveRun a foreground mount daemon for this repositorydaemon statusReport daemon liveness, version, uptime, and active mount count. No-op success when the daemon isn't runningdaemon stopAsk the running daemon to drain its mounts and exit. Sweeps any leftover registry entries with `fusermount -u` as a safety net before returning
Repository care
- heddle doctor Shipped
Explain repository health, or run targeted doctor checks
doctor docsDiff-check markdown documentation against the actual CLI surface
- heddle maintenance fsck Shipped
Verify repository integrity or explicitly repair one surface
maintenance fsck repairRepair an integrity surface, then verify itmaintenance fsck repair gitReconcile Git projection metadata or one projected ref
- heddle redact Shipped
Redact a sensitive blob in a state so reads return a stub instead of the content
redact applyDeclare a redaction on a blob in a state. The blob bytes stay on disk; reads return the stub. Use `heddle redact purge` afterward to physically remove the bytesredact listList every active redaction in the reporedact showShow a single redaction by its content-addressed idredact purgePhysically remove bytes for an existing redactionredact purge applyPhysically remove the blob bytes referenced by an existing redaction. Refuses if no redaction declared the blob firstredact purge listList every `Purge` oplog entry — who removed bytes, when, and which redaction the purge acted on
- heddle redact purge Shipped
Physically remove bytes for an existing redaction
redact purge applyPhysically remove the blob bytes referenced by an existing redaction. Refuses if no redaction declared the blob firstredact purge listList every `Purge` oplog entry — who removed bytes, when, and which redaction the purge acted on
- heddle completions Shipped
Print a tab-completion script for bash, zsh, or fish
- heddle shell completion Shipped
Generate a shell completion script on stdout
Other commands
- heddle import Shipped reference in progress
Bring an existing Git repository into Heddle.
import localImport a Git checkout on this computerimport urlHave the server import a public HTTPS Git URLimport statusWatch a durable import operation until it reaches a terminal stateimport retryRetry a failed durable import operation
- heddle help Shipped reference in progress
Curated, progressive-disclosure help
- heddle watch Shipped reference in progress
Stream live oplog activity
- heddle sync Shipped reference in progress
Refresh the current thread onto its target when safe
sync gitBidirectional sync with Git (export + import)
- heddle continue Shipped reference in progress
Continue the active operation without remembering the specific subcommand
- heddle abort Shipped reference in progress
Abort the active operation without remembering the specific subcommand
- heddle blame Shipped reference in progress
Show line-by-line attribution for a tracked file
- heddle query Shipped reference in progress
Structured query over the operation log. Filter by actor, time window, signal kind, symbol, thread, verbs. Returns structured results consumable by agents
- heddle visibility Shipped reference in progress
Declare and inspect a state's audience visibility tier
visibility setDeclare a visibility tier on a state. Public is the default and stays record-free (absence ≡ public); a non-public tier writes a per-state sidecar record and an oplog audit entryvisibility promotePromote a state to a less-restrictive tier by appending a superseding record. Requires an existing visibility record to supersedevisibility showShow a state's effective visibility tiervisibility listList every state that carries a non-public visibility tier
- heddle env Shipped reference in progress
Run a child with a confidential runtime profile
env createCreate a runtime profile from current environment valuesenv listList runtime profiles and slot names. Never prints valuesenv runRun a child with profile slots injected as environment variables
- heddle revert Shipped reference in progress
Revert changes from a state
- heddle shell Shipped reference in progress
Shell integration helpers (auto-cd on thread start/switch/cd)
shell initEmit a shell wrapper function on stdout. Source it from your shell rc to make `heddle start`, `heddle thread switch`, and `heddle thread cd` auto-`cd` into the target thread's worktreeshell completionGenerate a shell completion script on stdoutshell promptPrint a compact prompt segment: current thread, dirty marker, and remote divergence. Intended for PS1 helpers
- heddle complete Shipped reference in progress
Internal shell-completion candidate helper
- heddle bridge Shipped reference in progress
Explicit interoperability with other version-control formats
bridge gitExplicit Git projection operationsbridge git importImport Git commits to Heddle without changing source authoritybridge git exportExport Heddle states to Git
- heddle remote Shipped reference in progress
Manage remote repositories
remote listList configured remotesremote addAdd a remoteremote removeRemove a remoteremote set-defaultSet the default Heddle remote for pull and pushremote showShow remote details
- heddle auth Shipped reference in progress
Authenticate with a Heddle server
auth loginAuthenticate with a Heddle serverauth logoutRemove stored credentials for a serverauth statusShow current authentication statusauth inviteCreate or list signup invites owned by the signed-in accountauth invite listList signup invites owned by the signed-in accountauth trustInspect or explicitly replace the deployment descriptor root pinauth trust showShow the descriptor root pin controlling a server connectionauth trust replaceAtomically replace an automatic descriptor root pinauth derive-agentDerive a scoped, short-lived agent token offline. Advanced: not a first-screen nounauth create-service-tokenCreate a service token for CI/scripts with explicit native capabilities. Advanced: not a first-screen noun
- heddle invite Shipped reference in progress
Create or list signup invites (thin alias of `auth invite`)
invite listList signup invites owned by the signed-in account
- heddle grant Shipped reference in progress
Grant a principal access to a hosted spool
grant createGrant a principal a role on a hosted spoolgrant listList grants on a hosted spoolgrant deleteRemove a grant by its stable record ID shown by `heddle grant list`
- heddle promote Shipped reference in progress
Promote a personal hosted spool to a root-level spool
- heddle claim Shipped reference in progress
Offer this agent account for a human to claim
- heddle whoami Shipped reference in progress
Report the capture actor, then hosted auth
- heddle integration Shipped reference in progress
Manage ambient harness integrations
integration listList Heddle-managed harness integrationsintegration installInstall harness integrationsintegration doctorVerify installed harness integrationsintegration uninstallUninstall harness integrationsintegration upgradeRewrite Heddle-managed integrations in placeintegration relayInternal relay invoked by installed hooks/pluginsintegration stampFast identity-cursor write. Prefer the argv fast path in `main`
- heddle semantic Shipped reference in progress
Semantic analysis queries (call-graph hot-spots, churn, signature-stability surfaces)
semantic diffCompare the symbols stored in two states' attached semantic indexessemantic hotAggregate semantic-change events across recent history and surface the files or functions with the most activitysemantic refsQuery persisted refs-of, callers-of, or importers-of at a statesemantic indexBackfill the content-addressed merkle semantic index over history
- heddle netd Shipped reference in progress
Box-scoped network daemon control plane — distinct from `daemon` (FUSE mounts)
netd serveRun the foreground network daemon: bind the persistent device endpoint, keep relays online, hold warm weft sessions for hosted CLI verbs, and serve same-uid control RPCs. Never idle-exitsnetd statusReport network-daemon liveness and the advertised device node id. No-op success when the daemon isn't runningnetd stopAsk the running network daemon to close its endpoint and exit
- heddle maintenance Shipped reference in progress
Inspect and refresh rebuildable performance sidecars
maintenance fsckVerify repository integrity or explicitly repair one surfacemaintenance fsck repairRepair an integrity surface, then verify itmaintenance fsck repair gitReconcile Git projection metadata or one projected refmaintenance inspectInspect repository performance sidecars and repo shapemaintenance refreshRefresh repository performance sidecars without changing repository meaningmaintenance repackRepack native objects now through the resource-controlled schedulermaintenance gcGarbage collect unreachable objectsmaintenance oplogInspect and repair the operation logmaintenance oplog recoverSalvage a truncated or torn operation log and report what was recovered
- heddle hook Shipped reference in progress
Manage repository hooks
hook listList installed hookshook installInstall a hookhook uninstallUninstall a hookhook eventsShow the hook event catalog (W2/A15)