Skip to content

Command reference

Most people use Orcaops through the installed skills. The CLI is the underlying interface for automation, diagnostics, inspection, and advanced integration.

This page covers every top-level command and the important command groups. Run orcaops <command> --help for the exact flags and nested verbs in your installed version.

Common conventions

  • Commands discover the git worktree root from any subdirectory.
  • --root <path> overrides discovery; ORCAOPS_ROOT provides the same override.
  • Read-oriented commands commonly support --json for automation.
  • Agent-facing capture and review commands accept structured payloads. Let the corresponding skill construct them unless you are building an integration.
  • Destructive maintenance commands are dry-run by default where noted and require an explicit --apply or purge flag.

Install and manage

CommandWhat it does
orcaops initInitialize a repository and install agent support; personal scope is the default and leaves tracked repository files unchanged.
orcaops updateReconcile generated support after upgrades or changes to scope, agents, prefix, hooks, or file posture.
orcaops configureOpen the interactive settings menu and preview changes before applying them.
orcaops linkConsolidate AGENTS.md and CLAUDE.md onto a canonical file plus symlink, with lossy-change confirmation.
orcaops uninstallRemove managed install surfaces; keep captured data unless --purge-data is explicitly supplied.
orcaops doctorDiagnose runtime, adapters, install state, authentication, evaluator packs, caches, and watch signals.
orcaops doctor --fix --dry-runPreview guarded installation repairs; omit --dry-run to apply the approved repair.
orcaops hook session-startEmit the agent session-start guidance installed by repository hooks; always exits successfully.
orcaops session-hooks <verb>Install, inspect, or uninstall machine-level session hooks in supported agents' user configs.
orcaops skills <verb>List, enable, or disable installed skill templates; run orcaops update after changing overrides.

See Configuration for the index to agent scope, session hooks, capture controls, generated files, and environment variables.

Inspect captured work

CommandWhat it does
orcaops status [--json]Show the current branch's artifact state and immediate next actions.
orcaops list [--state <state>]List artifacts and optionally filter by lifecycle state.
orcaops show <artifact-id>Render one complete artifact thread.
orcaops checkout <artifact-id>Pin one artifact as the current shell's focus; --clear removes the pin.
orcaops decisionsQuery recorded plan, checkpoint, and deferred decisions by branch, artifact, time window, or archive.
orcaops loose-endsReport open items, uncertainty, uncovered steps, open checkpoints, and missing summaries.
orcaops step brief <step-id>Produce a bounded task brief with criteria, guardrails, evidence, and sibling claim state for one plan step.
orcaops statsShow repository artifact/checkpoint/summary counts and session-token totals; --all-projects reads the archive.
orcaops usage [--artifact <id>]Show exact session/model totals or labeled per-artifact estimates and checkpoint spans.
orcaops search <query>Search captured plan, checkpoint, and summary content with FTS5.
orcaops resumeShow in-flight progress and a paste-ready continuation prompt.
orcaops why <file> / <file>:<line-or-symbol>Show complete newest-first history for a bare file, or trace a line or symbol to the captured artifact and checkpoint that touched it.
orcaops finish --input <path>Run pre-PR review, finalize the artifact, and render its digest.
orcaops digest [artifact-id]Render one artifact; add --branch-wide [--base <ref>] to combine all captured work in a PR range.
orcaops watchOpen Orcaops Watch, the live cross-project dashboard and local Task Review interface.

With --all-projects, list, decisions, loose-ends, stats, and search include both hot and retained archive projections for the current project. Duplicate artifact IDs use the freshest projection: the archive wins only when it is strictly newer, and a tie stays on hot. This makes the result complete when run inside a repository or linked worktree without scanning sibling worktree directories.

orcaops show remains current-repository-only. Use the cross-project decisions and loose-ends readers for archived detail from other projects. orcaops list --between <ref1>..<ref2> also remains repository-anchored because it resolves the git refs locally, but it includes retained archive history for the identified current project.

The Skills guide maps these capabilities to the plain-language requests normally used with an agent. The Task Review guide covers Orcaops Watch.

Capture lifecycle and evaluators

These commands are primarily called by lifecycle skills:

CommandWhat it does
orcaops capture planCapture or revise the task plan.
orcaops capture checkpoint openDeclare the coherent plan-step scope before changing the worktree.
orcaops capture checkpoint closeRecord what completed, changed, was verified, was decided, and remains uncertain.
orcaops capture checkpoint abandonCancel an opened checkpoint without claiming its work.
orcaops capture pre-pr-checkRun the final evaluator pass without freezing the artifact.
orcaops capture summaryFinalize the artifact outcome, validation, open items, and deferred decisions.
orcaops block acknowledge / dismissResolve a block-severity evaluator violation under its configured policy.
orcaops eval listList discovered evaluators, enablement, engines, trust state, and operational health.
orcaops eval show <ref>Render one resolved evaluator as its source YAML or parsed JSON.
orcaops eval schema <kind>Print the author-facing schema for a spec, manifest, or command result envelope.
orcaops eval add-pack <source> [pack-id]Register an evaluator pack from a package or local path.
orcaops eval remove-pack <pack-id>Remove a registered pack, its evaluator overrides, and its user-local trust grant.
orcaops eval enable / disable <pack/id>Toggle one exactly discovered evaluator.
orcaops eval trust <pack>Inspect and grant user-local capabilities required by third-party evaluator code.
orcaops eval run --ref <ref>Run one discovered evaluator against an existing artifact and persist the result.
orcaops eval test --ref <ref> --fixture <path>Test an evaluator against a JSON fixture without persisting a real run.
orcaops eval fork-pack <pack> --to <path>Copy a resolved pack into an editable local directory.
orcaops eval update-pack <pack>Re-resolve and validate a registered pack.

See Evaluators and Authoring evaluator packs before granting or shipping executable evaluator code.

Provenance, snapshots, and maintenance

CommandWhat it does
orcaops fingerprint showInspect a closed checkpoint's captured diff-fingerprint metadata and manifest.
orcaops fingerprint deriveRecompute a manifest from pinned trees and verify its hash without persisting output.
orcaops diff --attributionMatch live or committed diff hunks to the checkpoints that produced them.
orcaops diff --reconcileReport in-window commits not accounted for by checkpoints.
orcaops export agent-traceExport per-line provenance as a Cursor agent-trace record, file, or explicit local git note.
orcaops snapshots checkoutMaterialize a checkpoint-boundary tree in a scratch worktree.
orcaops snapshots diff <range>Diff checkpoint boundaries or a boundary against the plan baseline.
orcaops snapshots prunePreview local snapshot-ref pruning; --apply deletes the selected refs.
orcaops lineageRefresh captured lineage after a merge, rebase, or amend changes branch ancestry.
orcaops rebuildRebuild the disposable SQLite projection from durable local event logs.
orcaops seed [--dry-run]Preview or apply the consent-gated one-time git-history backfill.
orcaops seed statusShow history coverage, failures, progress, and remembered discovery declines.
orcaops gcReport stale pins, abandoned summarized artifacts, stale reviews, and nonterminal orphans; --apply deletes candidates.
orcaops archive <verb>Enable, disable, inspect, repair, resolve, or explicitly prune the home-directory archive.

See Local data before pruning capture or archive state.

Task Review engine

The orcaops-task-review skill normally drives this surface. The most relevant groups are:

CommandWhat it does
orcaops review data --branch <branch>Derive the bounded review floor and diff; --rebuild-cache replaces an older disposable cache.
orcaops review routine-startPin inputs, mint a two-lane run, and serve the capture-blind forensic payload.
orcaops review routine-submitValidate a lane submission, serve the next input, or finalize the accepted routine.
orcaops review journalRead or append local reviewer disposition events.
orcaops review comments / commentRead, add, reply to, resolve, or reopen local Task Review comments.

The Task Review protocol is the full integration contract, including payloads, status dimensions, limits, and repair behavior.

Authentication and Cloud

CommandWhat it does
orcaops login / orcaops logout / orcaops whoamiCreate, clear, or inspect the current Orcaops Cloud session.
orcaops auth-stateEmit the simple connection state: connected, expired, or not connected.
orcaops org switchChange the active organization.
orcaops push <artifact-id>Upload a captured artifact and complete any Cloud source-plan pin.
orcaops push-statusList artifacts whose local events have not reached Cloud.
orcaops resync [--force]Retry pending artifact pushes, normally respecting per-artifact backoff.
orcaops plan upload <file>Upload a local plan as a Cloud review draft.
orcaops plan pull <id-or-slug>Pull an approved plan into the local cache for pinning.
orcaops plan review <verb>List/view review state; pull, diff, comment, propose, push, record a verdict, or wait for approval.
orcaops review status / pullInspect and download the Cloud PR review-feedback transcript.
orcaops review reply / watchReply to a Cloud review thread or wait for another human pass.

Cloud is optional. Read Cloud collaboration, Authentication, and Plan review for the human workflows and data boundary.