Explore your architecture. Diagnose failures. Verify every fix.

Project checks · Interactive architecture maps · Coverage analysis · Traceable evidence

English · 简体中文

Canary is a project verification workspace for developers. Bring checks, architecture, coverage and error evidence together. Follow a failure into the code, then track verification after a fix. Integrate with existing CI through the CLI, stable exit codes and standard reports.

Features

• Unified checks — Run builds, type checks, lint and tests. Export JSON, JUnit and Markdown reports.
• Architecture maps — Explore modules, files and symbols in 2D and layered 3D views. Search nodes, filter dependencies and inspect source.
• Failure diagnosis — Inspect categorized issues, redacted logs and source locations. Link original failures to reruns and before/after comparisons.
• Coverage navigation — Map collected line, function and branch coverage to structure nodes and locate verification gaps.
• Traceable evidence — Connect code versions, check results and execution history through manifests, content hashes and run lineage.
• Agent workflows — Install the official project Skill and expose bounded diagnosis and verification tools through the CLI or MCP.
• Repair handoffs — Share scoped repair tasks, assess candidate changes, then verify regression evidence.
• Change verification — Add --base main to project runs and inspect changed-code coverage, explicit behavior and verification gaps against sealed source.
• Repair memory — Retain verified repair facts and retrieve related project history with explicit source scope and revalidation conditions.

See the support scope.

Quick start

Use Node.js 24 and Git, then run one installation command for your platform:

Canary is delivered through GitHub source and Releases. The installer builds a selected source version; no npm publication or npm account is required.

Windows / PowerShell

iwr -useb https://raw.githubusercontent.com/EVEDensity/Canary/main/scripts/install/install.ps1 | iex

macOS / Linux

curl -fsSL https://raw.githubusercontent.com/EVEDensity/Canary/main/scripts/install/install.sh | bash

Open a new terminal and run from your project or any subdirectory. No Canary configuration is required:

Stable releases are selected by default. Set CANARY_CHANNEL=main for development builds. Upgrade with canary upgrade, restore with canary upgrade --rollback, and inspect the installed commit with canary installation --json.

canary run --ci                  # Discover and execute project checks
canary run --port 4318 --no-open  # Open an interactive report

Open localhost:4318. From another directory, use canary run --ci --project <directory>.

Canary discovers Node build, type check, lint, formatting and test scripts, plus standard Python, Go and Rust test entry points. It uses the project's declared package manager; project dependencies and test services must be ready. See automatic checks.

Project configuration

Use the GitHub Action for commit-bound PR summaries, source annotations and downloadable evidence.

Automatic discovery uses your existing checks. Configure custom commands, timeouts and coverage using the configuration guide. Artifacts belong to the project’s .canary/ directory; add it to .gitignore.

Agent integration

Install the official verification Skill from your project or a subdirectory:

canary skill install
canary skill status --json

The default destination is .agents/skills/canary-verify. Managed updates, conflict protection, rollback and removal use the current Node runtime. The Skill guides the current task's checks and evidence; it grants no extra source, network or merge permission. See the Skill guide for alternate project directories and the GitHub Release ZIP. Client discovery and invocation have not been tested across every Agent Skills client.

Use the CLI guide for diagnosis, reproduction and verification, or the MCP guide to connect a host to one trusted project. Reviewed project experiences track selection separately from delivery to function adapter context. Delivery does not establish that the agent used the guidance or improved; HTTP and MCP adapters do not inject that context. See project experience.

Why Canary?

The name comes from the canary in the coal mine: an early warning signal. Canary brings that idea to software—run checks early, make failures visible, and verify fixes with traceable evidence.

Catch problems early. Understand failures. Verify fixes.

Documentation & contributing

• Installation & setup · Project checks
• Evaluation & coverage · Architecture & CI
• GitHub Actions · Failure reproduction
• Official Skill · CLI · MCP
• Adapters · Repository layout
• Contributing · Translations · Security policy

Add a language with pnpm i18n:add <locale> and validate it with pnpm i18n:check. Complete, reviewed resources appear automatically in the language menu after merging.

Issues, documentation improvements and code contributions are welcome. R22–R26 add trusted evidence/state handling, official Skill delivery, unified verification entry points, controlled repair handoffs and version-bound change analysis. R27–R30 remain planned; see the roadmap.

License

Apache-2.0. Bundled fonts and icons retain their respective license notices.