Skip to main content

Canon — spec-driven development platform

Project description

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

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

canonhq-1.67.0.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

canonhq-1.67.0-py3-none-any.whl (565.2 kB view details)

Uploaded Python 3

File details

Details for the file canonhq-1.67.0.tar.gz.

File metadata

  • Download URL: canonhq-1.67.0.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for canonhq-1.67.0.tar.gz
Algorithm Hash digest
SHA256 f3928c23d1c0f285c7cff3b8c46052d12dbcbcb51ad7268742f69ecd5a11a972
MD5 55efe4cfb5ffdca48e22b1dd2349fa09
BLAKE2b-256 410e3987b30753d9a5992875d0659be0671540aecc853ba260bd90ff97d6bef7

See more details on using hashes here.

Provenance

The following attestation bundles were made for canonhq-1.67.0.tar.gz:

Publisher: publish.yml on canonhq/canon-private

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file canonhq-1.67.0-py3-none-any.whl.

File metadata

  • Download URL: canonhq-1.67.0-py3-none-any.whl
  • Upload date:
  • Size: 565.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for canonhq-1.67.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e4af7c4648308e992776a4e359afd78a5a2e1244d93eb8b9257fb84184d788d
MD5 daed7008d775ddac60c1feac09c0aa77
BLAKE2b-256 9913e51c51d9191b2e2da753e1a261c3605e0d656a813fe2ffe0eac277434c1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for canonhq-1.67.0-py3-none-any.whl:

Publisher: publish.yml on canonhq/canon-private

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page