Directories
¶
| Path | Synopsis |
|---|---|
|
Package attest implements the CANARY attestation mechanism: ed25519 signing and verification of the claims one `canary evidence run-go-test` run makes about itself.
|
Package attest implements the CANARY attestation mechanism: ed25519 signing and verification of the claims one `canary evidence run-go-test` run makes about itself. |
|
Package buildinfo holds the resolved binary version as a leaf value any package may read without importing cmd/canary or cobra.
|
Package buildinfo holds the resolved binary version as a leaf value any package may read without importing cmd/canary or cobra. |
|
CANARY: REQ=CP-268; FEATURE="MermaidRefs"; ASPECT=Engine; STATUS=TESTED; TEST=TestCANARY_CBIN_202_ExtractDiagramRefs,TestCANARY_CBIN_202_ScanDiagramRefsSkipsOversizedFile; UPDATED=2026-08-31
|
CANARY: REQ=CP-268; FEATURE="MermaidRefs"; ASPECT=Engine; STATUS=TESTED; TEST=TestCANARY_CBIN_202_ExtractDiagramRefs,TestCANARY_CBIN_202_ScanDiagramRefsSkipsOversizedFile; UPDATED=2026-08-31 |
|
cmds
|
|
|
drift
Package drift wires the pkg/drift engine into `canary drift`: it reads the token index built by `canary index` and reports, per requirement, whether the tree still matches the baseline — CURRENT, DRIFTED, or UNKNOWN — decided by content hash and git availability, never by a token's UPDATED= date.
|
Package drift wires the pkg/drift engine into `canary drift`: it reads the token index built by `canary index` and reports, per requirement, whether the tree still matches the baseline — CURRENT, DRIFTED, or UNKNOWN — decided by content hash and git availability, never by a token's UPDATED= date. |
|
evidence
Package evidence implements `canary evidence`: the commands that produce and accumulate the passing-test records `canary verify` consumes.
|
Package evidence implements `canary evidence`: the commands that produce and accumulate the passing-test records `canary verify` consumes. |
|
gap
CANARY: REQ=ENG-4317; FEATURE="GapCLI"; ASPECT=CLI; STATUS=IMPL; UPDATED=2025-10-17
|
CANARY: REQ=ENG-4317; FEATURE="GapCLI"; ASPECT=CLI; STATUS=IMPL; UPDATED=2025-10-17 |
|
implement
CANARY: REQ=CP-253; FEATURE="RequirementLookup"; ASPECT=API; STATUS=TESTED; UPDATED=2026-08-29
|
CANARY: REQ=CP-253; FEATURE="RequirementLookup"; ASPECT=API; STATUS=TESTED; UPDATED=2026-08-29 |
|
next
CANARY: REQ=CP-252; FEATURE="NextPriorityCommand"; ASPECT=CLI; STATUS=BENCHED; TEST=TestCANARY_CBIN_132_CLI_NextPrioritySelection,TestCANARY_CBIN_132_CLI_DBAndScanAgreeOnOrder,TestCANARY_CBIN_132_CLI_Candidate51IsFound,TestCANARY_CBIN_132_CLI_PromptResolvesUnderRoot,TestCANARY_C502_Next_ImportedEvidenceDoesNotUnblockByDefault; BENCH=BenchmarkCANARY_CBIN_132_CLI_PriorityQuery; OWNER=canary; UPDATED=2026-09-01
|
CANARY: REQ=CP-252; FEATURE="NextPriorityCommand"; ASPECT=CLI; STATUS=BENCHED; TEST=TestCANARY_CBIN_132_CLI_NextPrioritySelection,TestCANARY_CBIN_132_CLI_DBAndScanAgreeOnOrder,TestCANARY_CBIN_132_CLI_Candidate51IsFound,TestCANARY_CBIN_132_CLI_PromptResolvesUnderRoot,TestCANARY_C502_Next_ImportedEvidenceDoesNotUnblockByDefault; BENCH=BenchmarkCANARY_CBIN_132_CLI_PriorityQuery; OWNER=canary; UPDATED=2026-09-01 |
|
onboard
Package onboard analyzes a codebase that has few or no CANARY tokens and produces the agent hand-off needed to begin adoption: a language histogram, top-level directory layout, best-effort entry-point detection, any existing CANARY tokens, pre-seeded CANARY:MIGRATE guidance, the configured requirement-ID sources, the next available flatfile ID, and a next_steps checklist.
|
Package onboard analyzes a codebase that has few or no CANARY tokens and produces the agent hand-off needed to begin adoption: a language histogram, top-level directory layout, best-effort entry-point detection, any existing CANARY tokens, pre-seeded CANARY:MIGRATE guidance, the configured requirement-ID sources, the next available flatfile ID, and a next_steps checklist. |
|
project
CANARY: REQ=ENG-4319; FEATURE="ProjectCLI"; ASPECT=CLI; STATUS=IMPL; UPDATED=2025-10-18
|
CANARY: REQ=ENG-4319; FEATURE="ProjectCLI"; ASPECT=CLI; STATUS=IMPL; UPDATED=2025-10-18 |
|
specify
CANARY: REQ=ENG-4314; FEATURE="SpecModification"; ASPECT=CLI; STATUS=IMPL; DOC=user:docs/user/spec-modification-guide.md; DOC_HASH=676eb2a18c9d002a; UPDATED=2025-10-17
|
CANARY: REQ=ENG-4314; FEATURE="SpecModification"; ASPECT=CLI; STATUS=IMPL; DOC=user:docs/user/spec-modification-guide.md; DOC_HASH=676eb2a18c9d002a; UPDATED=2025-10-17 |
|
ticket
Package ticket wires pkg/ticket into `canary ticket sync`: computing a codified ticket-source synchronization plan from indexed tokens and the configured `sources:` registry, and — only when JIRA credentials are present and --apply is set — applying it via the JIRA REST client and writing a completed plan plus a remap map for `canary upgrade --map`.
|
Package ticket wires pkg/ticket into `canary ticket sync`: computing a codified ticket-source synchronization plan from indexed tokens and the configured `sources:` registry, and — only when JIRA credentials are present and --apply is set — applying it via the JIRA REST client and writing a completed plan plus a remap map for `canary upgrade --map`. |
|
upgrade
Package upgrade wires the pkg/upgrade legacy-token rewriter into the CLI.
|
Package upgrade wires the pkg/upgrade legacy-token rewriter into the CLI. |
|
verify
Package verify implements `canary verify`: the evidence-backed answer to "are this project's claims true right now?".
|
Package verify implements `canary verify`: the evidence-backed answer to "are this project's claims true right now?". |
|
view
Package view aggregates everything known about one requirement — tokens, files, tests, dependencies, spec/plan, diagrams, ticket link — into one bounded, agent-friendly answer.
|
Package view aggregates everything known about one requirement — tokens, files, tests, dependencies, spec/plan, diagrams, ticket link — into one bounded, agent-friendly answer. |
|
CANARY: REQ=ENG-4317; FEATURE="ProjectConfig"; ASPECT=Storage; STATUS=IMPL; UPDATED=2026-09-01
|
CANARY: REQ=ENG-4317; FEATURE="ProjectConfig"; ASPECT=Storage; STATUS=IMPL; UPDATED=2026-09-01 |
|
Package contract carries the two facts a refused CLI contract needs on both sides of the command boundary: the sentinel a command returns once it has printed its JSON refusal, and the exit status main gives it.
|
Package contract carries the two facts a refused CLI contract needs on both sides of the command boundary: the sentinel a command returns once it has printed its JSON refusal, and the exit status main gives it. |
|
Package drift decides, per requirement, whether the tree in front of it still matches the index baseline `canary index` recorded.
|
Package drift decides, per requirement, whether the tree in front of it still matches the index baseline `canary index` recorded. |
|
Package evidence holds strict parsing of CANARY evidence records and the single completion function ("has every claimed requirement been proven at the current commit") that downstream verification consumes.
|
Package evidence holds strict parsing of CANARY evidence records and the single completion function ("has every claimed requirement been proven at the current commit") that downstream verification consumes. |
|
Package external resolves whether a CANARY requirement ID is satisfied as an external dependency — one owned by a ticket-source (e.g.
|
Package external resolves whether a CANARY requirement ID is satisfied as an external dependency — one owned by a ticket-source (e.g. |
|
CANARY: REQ=ENG-4317; FEATURE="GapService"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-17
|
CANARY: REQ=ENG-4317; FEATURE="GapService"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-17 |
|
Package gotest turns passing tests/benches (as parsed by the leaf package pkg/gotestevents) into evidence records, independent of the `canary evidence` command package.
|
Package gotest turns passing tests/benches (as parsed by the leaf package pkg/gotestevents) into evidence records, independent of the `canary evidence` command package. |
|
Package gotestevents parses `go test -json` event streams into passing tests/benches and re-derives whether an evidence.Record is actually backed by them.
|
Package gotestevents parses `go test -json` event streams into passing tests/benches and re-derives whether an evidence.Record is actually backed by them. |
|
CANARY: REQ=CP-253; FEATURE="FuzzyMatcher"; ASPECT=Engine; STATUS=TESTED; TEST=TestCANARY_CBIN_133_Engine_Levenshtein; OWNER=canary; UPDATED=2026-08-29
|
CANARY: REQ=CP-253; FEATURE="FuzzyMatcher"; ASPECT=Engine; STATUS=TESTED; TEST=TestCANARY_CBIN_133_Engine_Levenshtein; OWNER=canary; UPDATED=2026-08-29 |
|
CANARY: REQ=ENG-4313; FEATURE="MigrateFrom"; ASPECT=CLI; STATUS=IMPL; OWNER=canary; UPDATED=2025-10-16
|
CANARY: REQ=ENG-4313; FEATURE="MigrateFrom"; ASPECT=CLI; STATUS=IMPL; OWNER=canary; UPDATED=2025-10-16 |
|
CANARY: REQ=ENG-4316; FEATURE="AspectIDGenerator"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-16
|
CANARY: REQ=ENG-4316; FEATURE="AspectIDGenerator"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-16 |
|
Package safewrite is the single way this tool replaces a file on disk.
|
Package safewrite is the single way this tool replaces a file on disk. |
|
Package sources resolves requirement-ID prefixes to their origin: a local flatfile series (e.g.
|
Package sources resolves requirement-ID prefixes to their origin: a local flatfile series (e.g. |
|
CANARY: REQ=ENG-4314; FEATURE="ExactIDLookup"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-16
|
CANARY: REQ=ENG-4314; FEATURE="ExactIDLookup"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-16 |
|
CANARY: REQ=ENG-4319; FEATURE="ContextManagement"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-18
|
CANARY: REQ=ENG-4319; FEATURE="ContextManagement"; ASPECT=Engine; STATUS=IMPL; UPDATED=2025-10-18 |
|
testutil
CANARY: REQ=ENG-4319; FEATURE="TestInfrastructure"; ASPECT=Storage; STATUS=IMPL; UPDATED=2025-10-18
|
CANARY: REQ=ENG-4319; FEATURE="TestInfrastructure"; ASPECT=Storage; STATUS=IMPL; UPDATED=2025-10-18 |
|
Package ticket computes and applies ticket-source synchronization plans: comparing a requirement's rollup CANARY status against its owning non-flatfile source's remote status (proposing "transition" actions), and codifying flatfile-to-ticket promotion as paired "create_issue" + "remap" actions.
|
Package ticket computes and applies ticket-source synchronization plans: comparing a requirement's rollup CANARY status against its owning non-flatfile source's remote status (proposing "transition" actions), and codifying flatfile-to-ticket promotion as paired "create_issue" + "remap" actions. |
|
Package upgrade rewrites legacy on-disk CANARY token shapes into the current parseable form: unicode hyphens inside IDs into ASCII hyphens, unpadded flatfile IDs into zero-padded IDs, bare legacy ID segments into keyed REQ= tokens, bug tokens missing FEATURE= into scan-parseable single lines, STATUS=FIXED into STATUS=REMOVED, missing UPDATED= into stamped tokens, the old multi-line bug-create continuation shape into one line, and (when an ID map is supplied) old requirement IDs into new ones across both CANARY tokens and GAP_ANALYSIS.md "✅ <ID>" claim lines.
|
Package upgrade rewrites legacy on-disk CANARY token shapes into the current parseable form: unicode hyphens inside IDs into ASCII hyphens, unpadded flatfile IDs into zero-padded IDs, bare legacy ID segments into keyed REQ= tokens, bug tokens missing FEATURE= into scan-parseable single lines, STATUS=FIXED into STATUS=REMOVED, missing UPDATED= into stamped tokens, the old multi-line bug-create continuation shape into one line, and (when an ID map is supplied) old requirement IDs into new ones across both CANARY tokens and GAP_ANALYSIS.md "✅ <ID>" claim lines. |
Click to show internal directories.
Click to hide internal directories.