Skip to content

Latest commit

 

History

History
74 lines (68 loc) · 5.27 KB

cli.md

File metadata and controls

74 lines (68 loc) · 5.27 KB

The CLI by noun and verb

This page is a map, not a transcript. It names the docket commands and, for each, where the current, authoritative detail lives — so nothing here can drift out of step with the binary you actually have installed.

How to read the current value:

  • The noun list — every top-level command — is owned by docket --help. Run it to see what ships in your build.
  • The verbs and flags under a noun are owned by docket <noun> --help (for example, docket change --help). This page names verbs where they help you find your way, but never lists flags: they change with the binary, and the help output is the one place that is always right.
  • The capability catalog — the machine-readable list of every operation the docket binary offers, which skills read instead of hard-coding commands (a skill is a named, reusable instruction set an agent loads for one job) — is owned by docket capabilities --json. That JSON, not this page, is what the workflows resolve their commands from.

Nouns

Each line is a pointer: the command, what its verbs govern, and where to read the verbs.

  • docket adr — record, supersede, and reverse architecture decisions. Verbs: docket adr --help.
  • docket agent — enter harness agent roles (docket agent enter starts a Codex role as a foreground root thread). Verbs: docket agent --help.
  • docket capabilities — emit the binary's complete executable command catalog (read-only, repository-independent). Verbs: docket capabilities --help.
  • docket change — create and transition changes in the backlog. Verbs: docket change --help (docket schema lists the request keys, including hold).
  • docket context — assemble read-only context bundles for docket workflows (implementation, finalize, ticket updates). Verbs: docket context --help.
  • docket development — contributor operations against a docket checkout: install from a checkout and run the complete test suite. Verbs: docket development --help.
  • docket diagnostic — read-only diagnostics, including the resolved configuration (docket diagnostic config). Verbs: docket diagnostic --help.
  • docket evidence — record and verify the build evidence that certifies an exact tested commit. Verbs: docket evidence --help.
  • docket export — write a clean Markdown copy of a change, spec, plan, or results file, free of docket's links and generated blocks, and open it. Without an id it exports the change whose branch is checked out. Agent sessions reach the export through the docket-export skill. Details: docket export --help.
  • docket finalize — sequence a change's closing half: rebase, publish, merge, and closeout. Verbs: docket finalize --help.
  • docket gate — launch, observe, stop, and recover supervised local gate runs. Verbs: docket gate --help.
  • docket install — install docket's skills, agents, and dispatch material into your harnesses. Its verbs are docket install check, which reports whether this machine's installation is current and writes nothing, and docket install collect, which reclaims verified unreferenced installed version trees. Verbs: docket install --help.
  • docket learning — record and update learning findings. Verbs: docket learning --help.
  • docket maintenance — close out merged changes and retry close-out cleanup in one pass (docket status stays read-only). Verbs: docket maintenance --help.
  • docket open — open the board, or a change's record, spec, plan, results, or pull request, as a GitHub page or from the local metadata checkout. Without an id it opens the change whose branch is checked out. Details: docket open --help.
  • docket pr — publish the ready-for-review pull request for an in-progress change's tested head. Verbs: docket pr --help.
  • docket repository — initialize, migrate, check, and repair the docket repository topology; also prepare a repository for a workflow (the startup check), configure its test commands, and fast-forward the primary checkout to the integration branch. Verbs: docket repository --help.
  • docket run — track dispatched runs and verify a change's run from claim to its handoff (implemented with a PR, or a completed results artifact); also reset the count of implement-next halts in a row (docket run reset-halts). Verbs: docket run --help.
  • docket schema [<id>] — emit request/result payload schemas and allowed values (read-only, repository-independent). Narrow it to one operation by giving its id positionally or via --operation. Verbs: docket schema --help.
  • docket status — report backlog status, readiness, selection, and repository health (read-only). Verbs: docket status --help.
  • docket uninstall — remove recorded harness integrations while retaining the CLI and repository setup. Verbs: docket uninstall --help.
  • docket version — report the binary's build identity. Verbs: docket version --help.
  • docket workspace — prepare, commit the spec copy onto, inspect, and publish feature workspaces for in-progress changes, and check out an implemented change's pushed branch into its own worktree on this machine. Verbs: docket workspace --help.