Quickstart

Use the same agent-ready, human-readable Project Canon to load scoped context, validate a change, and return Proof to a human or agent loop.

1. Load context for a file

Ask OpenCanon what applies to a file. It returns docs, conventions, validators, active Changes, impact surfaces, checks, and optional Git history.

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

2. List the rules in play

01opencanon canon list conventions
02opencanon rules --validator service-no-db-client
03opencanon rules --convention service-db-boundary

3. Run Proof on changed files

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

01opencanon validate --changed
02opencanon validate --changed --strict-warnings

4. Read feedback

The feedback command produces concise text designed to be fed back into an agent loop after edits or reviewed directly by a human.

01opencanon feedback --changed

5. Open browser diagnostics

The service and project runtime expose local browser URLs for inspecting Health and API responses while debugging.

01opencanon service open
02opencanon project open

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