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, search, and dashboard commands with rich terminal output. 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
canon dashboard

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.70.5.tar.gz (1.8 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.70.5-py3-none-any.whl (585.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for canonhq-1.70.5.tar.gz
Algorithm Hash digest
SHA256 45b2a6bb518807c83aa4d78feb39b1af28e801280c4192c04c988647d74b8bbe
MD5 6c71a7037583e48f2012a778f0c04c06
BLAKE2b-256 2a6f429c5f860b29251fa7385b26549c55f8e5e842297a81d8b3af357e1fe997

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: canonhq-1.70.5-py3-none-any.whl
  • Upload date:
  • Size: 585.4 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.70.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b615b18ce455cc50bd4c12a0ad0f4ad2bd5a9cd762984095549da5fba53a481a
MD5 4434bb5ec8a13500e0f41eac1f1400f1
BLAKE2b-256 85ec235be07f69e1fb34a8c303fb73aec05b472ee06100512e51e6371a7849c2

See more details on using hashes here.

Provenance

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