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.

See the support scope.

Quick start

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

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:

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.

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
• 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. Upcoming work focuses on PR diagnosis, repair verification and change verification gaps. See the roadmap.

License

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