DocsReference

CLI

One command, canon. Run it in a product repo, or pass the repo's path.

Edit on GitHub

Set up

Command What it does
canon init set canon up for a product: write .context/context.yaml and the missing .context/ files
canon add add a knowledge pack (rules and vendor docs in search), e.g. canon add expo
canon doctor check that canon's tools, and any this repo declares, are installed
canon hooks install a pre-push hook that runs canon check
canon status one screen: canon version, config, check summary

Check

Command What it does
canon check check that a product follows the standards (read-only)
canon standards list the standards that apply to a repo
canon copies compare a product's shared files with copies.source; --sync overwrites the drifted ones

Flow

Command What it does
canon pipeline the repo's stages in order, and where each stands
canon approve record that a person reviewed and approved a pipeline gate, dated now
canon flow how far each local Claude conversation about a product got, and how long each step took
canon weigh run the decision gate on a request without doing it
canon learn how often the gate stops work, and proposals to change the rules

Read

Command What it does
canon search search knowledge: keywords, meaning and rerank, through qmd
canon sync refresh pack docs and the search index, move the pinned canon version, then check
canon ui serve every product wiki and the design galleries on localhost
canon mcp start the search MCP server over the knowledge index (stdio)