CLI

The opencanon binary is the primary product surface. It talks to the local service, starts project runtimes on demand, and exposes the same model to humans, hooks, MCP, and CI.

Context

context

01opencanon context --files src/services/company.service.ts
02opencanon context --list-exceptions

Loads scoped Project Canon, Proof checks, Knowledge evidence, impact context, and optional Git history for files or topics.

Project Canon

canon

01opencanon canon list areas
02opencanon canon list specs
03opencanon changes list

Lists durable Areas and Specs plus active Changes that agents can follow.

Rules

rules

01opencanon rules --validator service-no-db-client
02opencanon rules --convention service-db-boundary
03opencanon rules --tree --validator service-no-db-client

Lists convention summaries, scopes, generated docs, runtime checks, and fixture coverage. --tree shows the file scope.

Graph Search

graph-search

01opencanon search loadCompany --kind symbol --symbol-kind function --scope "src/services/**"
02opencanon symbols loadCompany --kind function --scope "src/services/**"
03opencanon graph callers loadCompany
04opencanon graph callees loadCompany
05opencanon refactor rename-symbol loadCompany fetchCompany --file src/services/company.service.ts --format json

Searches the indexed TS/JS graph, filters symbols by kind and file scope, and inspects caller/callee edges before a change or refactor.

Validate

validate

01opencanon validate --changed
02opencanon validate --project --profile
03opencanon validate --check-fixtures
04opencanon validate --changed --strict-warnings

Commit Gates

gate

01opencanon gate pending --format json
02opencanon gate approve <gate-id> \
03  --summary "User explicitly approved the blocked change." \
04  --via agent

Validators can emit commit gates for intent-sensitive changes. Pending gates are written during changed-file validation. Agents should inspect the staged diff and gate evidence, ask the user for explicit Approve or Reject, and only then record the scoped approval before retrying the commit.

Feedback

feedback

01opencanon feedback --changed
02opencanon feedback --changed --strict-warnings

Writes concise findings for an agent after edits.

Runtime

runtime

01opencanon service start
02opencanon service status
03opencanon project status
04opencanon project index
05opencanon project logs --tail 200
06opencanon project stop

Runtime Updates

update

01opencanon update check --manifest ./opencanon-runtime-manifest.json
02opencanon update apply --manifest ./opencanon-runtime-manifest.json --dry-run

Updates read a manifest, select the current engine target, and verify checksums before writing runtime assets. Writes fail while the service or current project runtime is running. After a real install, run opencanon doctor --fix in initialized projects to refresh managed agent guidance and setup artifacts.

Baselines

baseline

01opencanon baseline check
02opencanon baseline update

Baselines record known findings so validators can distinguish existing debt from new drift.

Diagnostics

diagnostics

01opencanon doctor
02opencanon benchmark --sizes 1000,10000,50000 --file-kb 8 --source-snapshot-only

Local State

state

01opencanon state status
02opencanon state reset --confirm