Files
Hop/wiki/CLI-Reference.md
T
Hop 68d8bf2f7d Install portable agent-neutral Hop skill and documentation
Hop-State: A_06FN69X2VW0BAXG4A4DT6V0
Hop-Proposal: R_06FN69VET1STZNKPWK913K8
Hop-Task: T_06FN637799RW5Q7WH9H6PJR
Hop-Attempt: AT_06FN63779BJRBK1VFQ94GRR
2026-07-11 14:48:54 -07:00

2.5 KiB

CLI reference

Add --json anywhere in a command for machine-readable output. Successful responses use this envelope:

{
  "ok": true,
  "data": {}
}

The JSON shape is an alpha contract and may evolve before the first tagged release.

Project and prompt lifecycle

Command Purpose
hop init [path] Initialize Hop without moving the Git branch or index
hop begin ... Interactive-agent entry point: initialize if needed, capture prompt, continue session
hop prompt ... Controller-managed prompt or follow-up capture
hop checkpoint STATE Freeze current attempt progress
hop check STATE -- COMMAND... Validate an immutable checkpoint
hop propose [--summary TEXT] STATE Freeze a candidate proposal
hop land PROPOSAL [-- COMMAND...] Accept and synchronize the visible root
hop refresh PROPOSAL Explicitly prepare/reuse conflict reconciliation

hop start aliases hop prompt; hop reconcile aliases hop refresh.

Controller and synchronization commands

Command Purpose
hop accept PROPOSAL [-- COMMAND...] Accept internally without changing visible files
hop sync Materialize the current accepted tree from a safe accepted ancestor
hop undo Create a forward-only acceptance that restores the previous accepted tree
hop doctor [--repair] Validate database/object/ref consistency

Inspection

Command Purpose
hop status Accepted head, attempts, and visible-root status
hop graph State graph
hop state STATE One state and its provenance
hop env STATE Shell exports for an attempt
hop diff STATE Diff represented by a state
hop history Accepted lineage
hop version Installed version

Agent integration bundle

hop skill install [--path SKILLS_DIR] [--force]
hop skill print

Without --path, Hop installs the same Hop-managed skill files at ~/.agents/skills/hop and ${CODEX_HOME:-~/.codex}/skills/hop. With --path, it installs only to SKILLS_DIR/hop.

Exit codes

Code Meaning
0 Success
1 Git, SQLite, filesystem, or internal failure
2 Invalid usage
20 Merge conflict; reconciliation workspace was prepared
21 Attempt or accepted head changed during compare-and-swap
22 Validation command failed
23 Visible-root divergence or overwrite collision

Exit 20 is a continuation signal for an agent, not a request for the user to manually merge files.