canonhq 1.67.3

Canon — spec-driven development platform

Canon

Spec-driven development, automated.

Canon is an AI-native documentation platform. Write structured specs in markdown, and AI agents handle PR reviews, ticket sync, and code verification — keeping product, engineering, and business aligned.

This is the private monorepo. The open-source repo is at canonhq/canon.

Features

• Spec-Aware PR Reviews — Analyzes PRs against relevant specs, identifies which acceptance criteria are addressed, flags gaps
• Bidirectional Ticket Sync — Spec sections sync to Jira, Linear, or GitHub Issues in both directions
• Code-Aware Verification — AI verifies that acceptance criteria are actually implemented, not just that tickets were closed
• Coverage Dashboard — Track spec completion across your org by repo, team, and status
• CLI & MCP Server — Plan, verify, status, sync commands. MCP server for AI coding agents.
• Claude Code Plugin — Spec-aware skills for spec-driven development workflows

Quick Start

Install the GitHub App on your organization:

Install Canon

Or use the CLI:

pip install canonhq
canon setup
canon status

Documentation

• Docs Site — Full documentation
• Self-Hosting Guide
• Agent Behavior
• Vision

Development

With Devbox (recommended)

Devbox provides a reproducible environment with all tools:

curl -fsSL https://get.jetify.com/devbox | bash   # one-time install
devbox shell                                        # enter environment
devbox run test                                     # run tests
devbox run lint                                     # lint + format check
devbox run dev                                      # start dev server

Without Devbox

uv sync --extra dev --extra cloud
uv run pytest
uv run ruff check
uv run uvicorn canon.main:app --reload

See docs/contributing/testing.md for the full testing guide (integration tests, scenario tests, contract recording).

License

BSL 1.1 — converts to Apache 2.0 after four years per release.