Companion CLI Command Reference

This page is the copy/paste reference for the stable command surface of snipara-companion. The package source is authoritative for command names and flags; this page focuses on the commands most agents and operators use in a normal workflow.

Secondary helper

Optional local tooling

Companion is the local continuity layer. Hosted MCP remains the primary source and memory surface; use workflow resume when a managed workflow needs to continue after compaction or handoff.

Canonical forms at a glance

Use workflow run for workflow-mode selection, run for the Project Intelligence judgment/release flow, code impact for the canonical impact gate, and final-commit for final managed-workflow closeout.

Stable command reference

Command	Use it for
`workflow run --mode <mode>`	Run a workflow preset using the exact mode values listed below.
`workflow phase-commit <phaseId>`	Persist one managed phase outcome and advance the workflow.
`workflow resume`	Restore managed workflow state and hosted memory after compaction or handoff.
`final-commit`	Canonical command for the final managed workflow outcome and closeout report.
`workflow final-commit`	Compatibility alias for final-commit.
`task-commit`	Capture a durable task outcome after meaningful work; it is not a phase commit.
`code impact`	Canonical agent-ready code impact gate with automatic source selection.
`impact`	Root-level compatibility alias for code impact.
`code local impact`	Run the non-canonical local code overlay impact query.
`run`	Run the Project Intelligence judgment and release-oriented flow.
`doctor`	Run Companion diagnostics and report configuration or integration issues.
`collaboration guard`	Evaluate a collaboration guard profile, for example pre-deploy.
`feature init <slug>`	Create a reviewable feature specification scaffold.
`feature plan <slug>`	Generate a technical plan from the feature specification.
`feature tasks <slug>`	Generate executable tasks from the technical plan.
`feature start <slug>`	Start the existing managed workflow from generated feature tasks.

Workflow mode values

The CLI accepts exactly lite, standard, auto, full, and orchestrate for workflow run --mode. The guide labels describe the same runtime values:

CLI value	Guide label	Behavior
`lite`	LITE	Small, known-scope work with no mandatory hosted context call.
`standard`	STANDARD	Normal work with context and code-graph follow-up when needed.
`auto`	AUTO	Routes by task intent to lite, standard, full, or orchestrate.
`full`	FULL	Managed, phased work with durable context and plan support.
`orchestrate`	FULL + ORCHESTRATED	Explicit deeper orchestration for multi-agent or proof-gate work.

Command distinctions

run and workflow run are different commands. The root run invokes the Project Intelligence judgment/release flow; workflow run invokes a workflow mode preset.
final-commit is canonical. workflow final-commit remains a compatibility alias for the same final workflow capture.
code impact is canonical. The root impact spelling is a compatibility alias; code local impact is the separate local-overlay query.
task-commit records a durable task outcome. workflow phase-commit records a managed phase and advances the workflow; neither replaces the other.

Feature preparation

The feature commands create and bridge a spec, plan, and executable task list into the existing managed workflow. They do not create a second workflow state machine.

snipara-companion feature init oauth-onboarding --goal "Make OAuth onboarding recoverable"

snipara-companion feature plan oauth-onboarding

snipara-companion feature tasks oauth-onboarding

snipara-companion feature start oauth-onboarding

Advanced / internal surfaces

These commands are real CLI surfaces, but they are not the default path for a first workflow. Use them when a project, release, or integration explicitly needs the associated artifact or gate.

Advanced/internal: treat these as operational or review surfaces. Check snipara-companion --help and the package reference before scripting them into a product integration.

Surface	Role
`workflow scaffold`	Generate a reusable managed workflow plan from a built-in preset.
`workflow runtime-checkpoint`	Capture resume-ready state for a runtime-bound phase.
`workflow impact-gate`	Audit committed workflow phases that have not been pushed.
`workflow producer-report`	Inspect local Producer Loop artifacts and calibration evidence.
`workflow producer-review`	Mark a local Producer Loop artifact reviewed or rejected.
`context-control`	Review or reconcile local Context as Code state.
`agent-context`	Resolve role-scoped context policy and evidence artifacts.

Copy/paste paths

snipara-companion workflow run --mode standard --query "map auth impact"

snipara-companion workflow run --mode full --query "plan the auth refactor"

snipara-companion workflow phase-commit implementation --summary "Tests passed"

snipara-companion final-commit --summary "Completed the refactor"

snipara-companion collaboration guard --profile pre-deploy --enforce

For the broader Companion operating model, see the Companion integration guide.