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:
Or use the CLI:
pip install canonhq
canon setup
canon status
canon dashboard
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.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file canonhq-1.82.0.tar.gz.
File metadata
- Download URL: canonhq-1.82.0.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ce87a3bc0cc922130af3d9a5192747b3d7b034b9fcbae60465031f1aacc9bbf8
|
|
| MD5 |
2f91ebffc23ca43d2163ee704376be49
|
|
| BLAKE2b-256 |
de6bea3e58c60ec4206751a6243cb624b736d7fda8390e6965b85f9e9a87a532
|
Provenance
The following attestation bundles were made for canonhq-1.82.0.tar.gz:
Publisher:
publish.yml on canonhq/canon-private
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
canonhq-1.82.0.tar.gz -
Subject digest:
ce87a3bc0cc922130af3d9a5192747b3d7b034b9fcbae60465031f1aacc9bbf8 - Sigstore transparency entry: 1597872329
- Sigstore integration time:
-
Permalink:
canonhq/canon-private@95db8fe0f956f2fd18fc4c30b27abe0768df890e -
Branch / Tag:
refs/heads/main - Owner: https://github.com/canonhq
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@95db8fe0f956f2fd18fc4c30b27abe0768df890e -
Trigger Event:
push
-
Statement type:
File details
Details for the file canonhq-1.82.0-py3-none-any.whl.
File metadata
- Download URL: canonhq-1.82.0-py3-none-any.whl
- Upload date:
- Size: 608.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
12920df88fc834f4895a4e088d87c07048a9f64f421b885c9cffeb4609b2d704
|
|
| MD5 |
a7979d1749ed9b37fc47edee516445d8
|
|
| BLAKE2b-256 |
750b07a08016a127994d0a0a08f1ef1356ccdb80dcb34337dec865ebb31be644
|
Provenance
The following attestation bundles were made for canonhq-1.82.0-py3-none-any.whl:
Publisher:
publish.yml on canonhq/canon-private
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
canonhq-1.82.0-py3-none-any.whl -
Subject digest:
12920df88fc834f4895a4e088d87c07048a9f64f421b885c9cffeb4609b2d704 - Sigstore transparency entry: 1597872535
- Sigstore integration time:
-
Permalink:
canonhq/canon-private@95db8fe0f956f2fd18fc4c30b27abe0768df890e -
Branch / Tag:
refs/heads/main - Owner: https://github.com/canonhq
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@95db8fe0f956f2fd18fc4c30b27abe0768df890e -
Trigger Event:
push
-
Statement type:
