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.60.2.tar.gz (1.4 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.60.2-py3-none-any.whl (507.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for canonhq-1.60.2.tar.gz
Algorithm Hash digest
SHA256 7f63404adf7a8355652083cc7d4e2ba41d81f01aeabf842173bc8a058ceb89de
MD5 be1b2641f00deffc3d4922a048ed5b96
BLAKE2b-256 65689937921df7c9d4bf634b84f3b351fc38aa1f22ce183c0e607351219e2018

See more details on using hashes here.

Provenance

The following attestation bundles were made for canonhq-1.60.2.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.60.2-py3-none-any.whl.

File metadata

  • Download URL: canonhq-1.60.2-py3-none-any.whl
  • Upload date:
  • Size: 507.7 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.60.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a4dd542bda8d541e36648fced5fb7482ed5d9e3eda6ac33719c067621e9e9b84
MD5 b5ea1b24d7371ff47bc3d77d025f1c1b
BLAKE2b-256 abcf1361f3b56edf24880b503b3b7614296093edc5bd0c18f54bce4c5b30d81d

See more details on using hashes here.

Provenance

The following attestation bundles were made for canonhq-1.60.2-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