CLI Overview - canonic

The canonic CLI (alias: can) is a thin transport adapter: it parses options, selects the output format, and dispatches to the same protocol-neutral core service that also backs the MCP server. No business logic lives in the CLI layer itself.

Global flags

Flag	Description
`--json` / `-j`	Emit raw structured JSON instead of formatted text. Every capability command’s JSON output matches its MCP tool payload byte-for-byte.
`--version`	Show the canonic version and exit.

Bare `canonic`

Running canonic with no subcommand (and without --json) launches the interactive setup wizard. With --json and no subcommand, it exits with an error instead. Interactive mode requires a terminal.

`canonic overview`

Show active metrics grouped by domain with plain-language sample questions: the recommended first command for a new user or agent, giving a scannable map of what’s askable before drilling into sl describe or query.

canonic overview
canonic overview --domain warehouse

Flag	Description
`--domain`	Filter to a single domain (owning-source name).

Command groups

Group	Purpose
`connection`	Manage source connections in `canonic.yaml`.
`sl`	Semantic layer: resolve, compile, describe.
`mcp`	Control the local MCP daemon.
`knowledge`	Search and author knowledge pages.
`eval`	Run the local-model accuracy baseline harness.

Top-level commands

Command	Purpose
`overview`	Show active metrics grouped by domain with sample questions (documented above).
`setup`	Interactive project setup wizard.
`ingest`	Reconcile configured sources into reviewable context diffs.
`review`	Interactively review pending proposals.
`apply`	Batch-apply pending proposals from a run directory.
`query`	Resolve, compile, and execute a semantic query read-only.
`sql`	Execute a read-only SQL string on a named connection.
`assert`	Run the accuracy harness over all loaded assertions (CI gate).
`status`	Show the current project root, config version, and local state.
`validate`	Validate every contract against the project’s semantic sources (read-only, no connection).
`audit`	Show event-log figures: counts, errors, latency, freshness.
`completion`	Generate a shell completion script.