Quickstart

Load rules for a file, validate changes, and return findings to the agent loop.

1. Load context for a file

Ask OpenCanon what applies to a file. It returns docs, decisions, validators, and optional Git history.

context
sh
opencanon context --files src/services/company.service.ts

2. List the rules in play

rules
sh
opencanon rules --validator service-no-db-client
opencanon rules --decision service-db-boundary

3. Validate changed files

--changed uses Git-backed discovery to scope work to the current working tree.

validate
sh
opencanon validate --changed
opencanon validate --changed --strict-warnings

4. Read agent feedback

The feedback command produces concise text designed to be fed back into an agent loop after edits.

feedback
sh
opencanon feedback --changed

5. Open the workbench

The daemon serves a local UI for browsing rules beside code.

workbench
sh
opencanon daemon open

From here, read Concepts for the model and Validators for adding rules.