GitDocket docs

CLI commands.

A short reference for working from the terminal. Run commands inside your initialized repository.

Find the context

Command	Purpose
`docket overview --json`	Read the project briefing, active work, and next frontier.
`docket ready --json`	Find todo tasks whose dependencies are done.
`docket task list --all`	List tracked work, including done and closed items.
`docket search "welcome guide"`	Search the Markdown bundle.
`docket source workflows/docket-epic.md`	Read a bounded page of an exact bundle source path.

Manage tracked work

Replace <ID> with a real ID from your task list. Use the checked-in pickup and close workflows for implementation, verification, and documentation reconciliation.

Command	Purpose
`docket task create --title "Write the guide"`	Create a task with a generated ID.
`docket task start <ID> --json`	Start selected work and return its context packet.
`docket task log <ID> "Verified the guide links"`	Record a dated work note.
`docket task move <ID> review`	Change stored status through the state machine.
`docket task edit <ID> --priority p1`	Update a task’s fields.
`docket task stop`	Clear the active task; its status stays unchanged.
`docket task close <ID>`	Complete the item after the close workflow’s checks.

To close without completion, use docket task close <ID> --without-completion --note "Reason". Closing state alone is not evidence that the work was verified.

Maintain & browse

Command	Purpose
`docket init --agent codex`	Initialize a project and install an optional native adapter.
`docket lint`	Check schema, links, and workflow hygiene.
`docket index`	Regenerate the index and cache after direct Markdown edits.
`docket verify status`	Inspect spec-to-test linkage; this does not run tests.
`docket upgrade`	Merge updates to vendored workflows and regenerate adapters.
`docket serve`	Open the browser interface on this computer.

Use docket --help or docket task create --help for the exact flags in your installed version. Add --json where supported for programmatic output. This reference includes the 0.2.1 CLI; installed release capabilities can differ.

Local telemetry

Telemetry is off by default and requires enrollment per checkout. Observations stay outside your repository on this computer; Docket never uploads them. Document contents, prompts, search terms, and file paths are excluded.

docket telemetry status
docket telemetry enable
docket telemetry report
docket telemetry disable
docket telemetry delete

report summarizes observed operation counts, latency, errors, and sampled runtime memory. disable stops collection; delete removes this checkout’s enrollment and retained observations. Reports you export yourself remain yours to manage.