@journeykit/canon 0.30.0 → 0.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/skills/SKILL.src.md +77 -32
- package/dist/skills/reference/brief-align.md +2 -2
- package/dist/skills/reference/brief-clarify.md +2 -2
- package/dist/skills/reference/brief-harden.md +2 -2
- package/dist/skills/reference/brief-polish.md +8 -8
- package/dist/skills/reference/brief-shape.md +40 -9
- package/dist/skills/reference/canon-authoring.md +6 -6
- package/dist/skills/reference/canon-gate.md +45 -36
- package/dist/skills/reference/canon-learn.md +2 -2
- package/dist/skills/reference/canon-plan-import.md +2 -2
- package/dist/skills/reference/canon-plugins.md +6 -6
- package/dist/skills/reference/canon-policy.md +7 -4
- package/dist/skills/reference/canon-report-dashboard.md +17 -10
- package/dist/skills/reference/canon-review.md +24 -24
- package/dist/skills/reference/canon-storage.md +2 -2
- package/dist/skills/reference/canon-subject.md +137 -103
- package/dist/skills/reference/role-implementer.md +52 -36
- package/dist/skills/reference/role-orchestrator.md +68 -38
- package/dist/skills/reference/role-planner.md +99 -45
- package/dist/skills/reference/role-reviewer.md +69 -43
- package/man/canon-adapter-authorize.1 +2 -2
- package/man/canon-adapter-validate.1 +2 -2
- package/man/canon-adapter.1 +2 -2
- package/man/canon-artifacts-move.1 +2 -2
- package/man/canon-artifacts-store.1 +2 -2
- package/man/canon-artifacts-verify.1 +2 -2
- package/man/canon-artifacts.1 +2 -2
- package/man/canon-brief-approve.1 +17 -5
- package/man/canon-brief-check.1 +2 -2
- package/man/canon-brief-show.1 +6 -3
- package/man/canon-brief.1 +8 -7
- package/man/canon-change-new.1 +4 -4
- package/man/canon-change.1 +3 -3
- package/man/canon-completion.1 +2 -2
- package/man/canon-context-pack-add.1 +2 -2
- package/man/canon-context-pack-show.1 +2 -2
- package/man/canon-context-pack-verify.1 +2 -2
- package/man/canon-context-pack.1 +2 -2
- package/man/canon-context.1 +2 -2
- package/man/canon-dashboard.1 +2 -2
- package/man/canon-demo-init.1 +2 -2
- package/man/canon-demo-review.1 +2 -2
- package/man/canon-demo.1 +2 -2
- package/man/canon-dispatch-begin.1 +10 -10
- package/man/canon-dispatch-diff.1 +2 -2
- package/man/canon-dispatch-end.1 +2 -2
- package/man/canon-dispatch.1 +2 -2
- package/man/canon-divergence-accept.1 +15 -6
- package/man/canon-divergence-add.1 +6 -6
- package/man/canon-divergence-defer.1 +6 -6
- package/man/canon-divergence-list.1 +2 -2
- package/man/canon-divergence-resolve.1 +6 -6
- package/man/canon-divergence.1 +2 -2
- package/man/canon-evidence-add.1 +16 -16
- package/man/canon-evidence-approval-payload.1 +10 -10
- package/man/canon-evidence-audit.1 +10 -10
- package/man/canon-evidence.1 +3 -3
- package/man/canon-export.1 +2 -2
- package/man/canon-feature-new.1 +6 -6
- package/man/canon-feature.1 +2 -2
- package/man/canon-finding-add.1 +11 -11
- package/man/canon-finding-close.1 +8 -8
- package/man/canon-finding-list.1 +4 -4
- package/man/canon-finding.1 +4 -4
- package/man/canon-format.1 +2 -2
- package/man/canon-gate-check.1 +2 -2
- package/man/canon-gate-install-hooks.1 +2 -2
- package/man/canon-gate-promote.1 +2 -2
- package/man/canon-gate.1 +2 -2
- package/man/canon-ingest-plans.1 +2 -2
- package/man/canon-ingest-records.1 +4 -4
- package/man/canon-ingest-sessions.1 +2 -2
- package/man/canon-ingest.1 +2 -2
- package/man/canon-init.1 +2 -2
- package/man/canon-inventory-sync.1 +2 -2
- package/man/canon-inventory.1 +2 -2
- package/man/canon-ledger-compact.1 +2 -2
- package/man/canon-ledger.1 +2 -2
- package/man/canon-migrate.1 +20 -3
- package/man/canon-plugin-sync.1 +2 -2
- package/man/canon-plugin.1 +2 -2
- package/man/canon-policy-approve.1 +9 -3
- package/man/canon-policy-show.1 +2 -2
- package/man/canon-policy.1 +2 -2
- package/man/canon-prompt-add.1 +2 -2
- package/man/canon-prompt-show.1 +2 -2
- package/man/canon-prompt.1 +2 -2
- package/man/canon-purge.1 +2 -2
- package/man/canon-query.1 +5 -5
- package/man/canon-regime-show.1 +2 -2
- package/man/canon-regime.1 +2 -2
- package/man/canon-report-build.1 +2 -2
- package/man/canon-report-check.1 +2 -2
- package/man/canon-report-snapshot.1 +2 -2
- package/man/canon-report.1 +2 -2
- package/man/canon-retrieve.1 +5 -5
- package/man/canon-review-change.1 +6 -6
- package/man/canon-review-scenario.1 +6 -6
- package/man/canon-review.1 +2 -2
- package/man/canon-scenario-new.1 +10 -10
- package/man/canon-scenario.1 +2 -2
- package/man/canon-schema.1 +2 -2
- package/man/canon-search.1 +104 -0
- package/man/canon-selftest.1 +2 -2
- package/man/canon-skills-check.1 +2 -2
- package/man/canon-skills-doctor.1 +2 -2
- package/man/canon-skills-install.1 +2 -2
- package/man/canon-skills-show.1 +2 -2
- package/man/canon-skills.1 +2 -2
- package/man/canon-status.1 +7 -2
- package/man/canon-strategy-approval-payload.1 +2 -2
- package/man/canon-strategy-promote.1 +2 -2
- package/man/canon-strategy-rollback.1 +5 -5
- package/man/canon-strategy.1 +2 -2
- package/man/canon-subject-adopt.1 +4 -4
- package/man/canon-subject-move.1 +5 -5
- package/man/canon-subject-new.1 +5 -5
- package/man/canon-subject-show.1 +2 -2
- package/man/canon-subject-unadopt.1 +5 -5
- package/man/canon-subject.1 +2 -2
- package/man/canon-task-done.1 +2 -2
- package/man/canon-task.1 +2 -2
- package/man/canon-tier-age.1 +2 -2
- package/man/canon-tier.1 +2 -2
- package/man/canon-trace.1 +56 -0
- package/man/canon.1 +8 -2
- package/package.json +4 -4
package/man/canon-evidence-add.1
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-evidence-add 1 "add 0.
|
|
3
|
+
.TH canon-evidence-add 1 "add 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-evidence\-add \- Record one attributed EvidenceRecord for a task or scenario (promoted in the same run under `write: { promote: auto }` or with \-\-promote; under `write.promote: manual`, commit it with `canon gate promote`)
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon evidence add\fR [\fB\-\-as\fR] [\fB\-\-task
|
|
7
|
+
\fBcanon evidence add\fR [\fB\-\-as\fR] [\fB\-\-task\fR] [\fB\-\-project\fR] [\fB\-\-class\fR] [\fB\-\-ref\fR] [\fB\-\-verdict\fR] [\fB\-\-summary\fR] [\fB\-\-command\-result\fR] [\fB\-\-scenario\fR] [\fB\-\-run\fR] [\fB\-\-surface\-ref\fR] [\fB\-\-actor\fR] [\fB\-\-role\fR] [\fB\-\-session\fR] [\fB\-\-approver\fR] [\fB\-\-approval\-role\fR] [\fB\-\-signature\-file\fR] [\fB\-\-approval\-at\fR] [\fB\-\-rev\fR] [\fB\-\-artifact\fR] [\fB\-\-report\fR] [\fB\-\-report\-case\fR] [\fB\-\-all\-scenarios\fR] [\fB\-\-max\-artifact\-mib\fR] [\fB\-\-override\-reason\fR] [\fB\-\-promote\fR] [\fB\-\-no\-promote\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Record one attributed EvidenceRecord for a task or scenario (promoted in the same run under `write: { promote: auto }` or with \-\-promote; under `write.promote: manual`, commit it with `canon gate promote`)
|
|
10
10
|
.SH OPTIONS
|
|
@@ -26,11 +26,11 @@ reviewer
|
|
|
26
26
|
orchestrator
|
|
27
27
|
.RE
|
|
28
28
|
.TP
|
|
29
|
-
\fB\-\-task
|
|
30
|
-
Plan task this evidence attests to (<change_id>#<n>); required unless \-\-scenario
|
|
29
|
+
\fB\-\-task\fR \fI<TASK_ID>\fR
|
|
30
|
+
Plan task this evidence attests to (<change_id>#<n>); required unless \-\-scenario is given
|
|
31
31
|
.TP
|
|
32
|
-
\fB\-\-project
|
|
33
|
-
Spec corpus id for \-\-scenario
|
|
32
|
+
\fB\-\-project\fR \fI<PROJECT_ID>\fR
|
|
33
|
+
Spec corpus id for \-\-scenario (canon keys a scenario by the composite (project_id, scenario_id)). Must name a spec root configured in canon.yaml, or the add is refused (UNKNOWN_SPEC_ROOT) before anything is written
|
|
34
34
|
.TP
|
|
35
35
|
\fB\-\-class\fR \fI<CLASS>\fR
|
|
36
36
|
What CLASS of evidence is attested to (test\-run, review, ...); default `test\-run` when a \-\-report is given. `audit` is refused: an external evaluator\*(Aqs re\-audit is `canon evidence audit`
|
|
@@ -59,22 +59,22 @@ One\-line note, with or without \-\-task; a task\*(Aqs flipped row shows it as t
|
|
|
59
59
|
\fB\-\-command\-result\fR \fI<TEXT>\fR
|
|
60
60
|
The real captured output backing \-\-summary (requires \-\-summary; scanned for fabrication markers)
|
|
61
61
|
.TP
|
|
62
|
-
\fB\-\-scenario
|
|
62
|
+
\fB\-\-scenario\fR \fI<SCENARIO_ID>\fR
|
|
63
63
|
Scenario this evidence also joins to
|
|
64
64
|
.TP
|
|
65
|
-
\fB\-\-run
|
|
65
|
+
\fB\-\-run\fR \fI<RUN_ID>\fR
|
|
66
66
|
RunId (ULID) of the run that produced this evidence
|
|
67
67
|
.TP
|
|
68
68
|
\fB\-\-surface\-ref\fR \fI<PATH_OR_EFFECT>\fR
|
|
69
69
|
Explicit risk binding: repository\-relative path or effect:<kebab\-slug>; persisted as surface_ref
|
|
70
70
|
.TP
|
|
71
|
-
\fB\-\-actor
|
|
71
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR [default: canon]
|
|
72
72
|
The attesting actor\*(Aqs id (recorded as the attestation\*(Aqs author; line breaks refused)
|
|
73
73
|
.TP
|
|
74
74
|
\fB\-\-role\fR \fI<ROLE>\fR
|
|
75
75
|
The attesting role; `canon gate promote` derives its run_seq partition key from it. Default: the declared role (\-\-as / CANON_ROLE); required when none is declared
|
|
76
76
|
.TP
|
|
77
|
-
\fB\-\-session
|
|
77
|
+
\fB\-\-session\fR \fI<SESSION_ID>\fR
|
|
78
78
|
The attesting session (recorded as actor.session_id). Under require_review.distinct_actor a review from this session does not count
|
|
79
79
|
.TP
|
|
80
80
|
\fB\-\-approver\fR \fI<NAME>\fR
|
|
@@ -110,13 +110,13 @@ EXPERIMENTAL: bind and parse a test report, `junit:<path>`, `cucumber:<path>` or
|
|
|
110
110
|
EXPERIMENTAL: also bind this report case (a Rust test: its function name); repeatable. Cases whose own scenario id is this one are always bound
|
|
111
111
|
.TP
|
|
112
112
|
\fB\-\-all\-scenarios\fR
|
|
113
|
-
One record per indexed scenario of \-\-project
|
|
113
|
+
One record per indexed scenario of \-\-project that owns a case in the \-\-report(s), all or nothing (see below)
|
|
114
114
|
.TP
|
|
115
115
|
\fB\-\-max\-artifact\-mib\fR \fI<N>\fR [default: 25]
|
|
116
116
|
Per\-file size limit for the artifact store (.canon/artifacts/sha256/), in MiB; a larger bound file is refused
|
|
117
117
|
.TP
|
|
118
118
|
\fB\-\-override\-reason\fR \fI<TEXT>\fR
|
|
119
|
-
Attest anyway while a subject this record attests for has a brief awaiting the human\*(Aqs answer (one line, recorded on the record with \-\-actor
|
|
119
|
+
Attest anyway while a subject this record attests for has a brief awaiting the human\*(Aqs answer (one line, recorded on the record with \-\-actor)
|
|
120
120
|
.TP
|
|
121
121
|
\fB\-\-promote\fR
|
|
122
122
|
Promote the record this run staged, in the same run; records others staged stay staged (the default under canon.yaml `write: { promote: auto }`)
|
|
@@ -145,13 +145,13 @@ The gate skips the staleness, trust\-ladder, release\-trust, and divergence dime
|
|
|
145
145
|
Detached approvals require an external signature; canon never signs on the user\*(Aqs behalf.
|
|
146
146
|
|
|
147
147
|
EXPERIMENTAL BINDING (\-\-artifact, \-\-report).
|
|
148
|
-
Canon reads files your runner or agent already wrote; it never runs a test. \-\-artifact binds any file by sha256; \-\-report junit:<path>, cucumber:<path> or swift\-testing:<path> (the JSON\-lines event stream of `swift test \-\-experimental\-event\-stream\-output`) also records the matched case and its outcome (a faithful verdict needs every bound case to pass). Every case whose own scenario id (the first id in its classname, then name, a Swift Testing display name, then function name, or a Cucumber tag) is this one is bound; a case that only mentions it is not; \-\-report\-case adds more. With \-\-task and no \-\-scenario
|
|
148
|
+
Canon reads files your runner or agent already wrote; it never runs a test. \-\-artifact binds any file by sha256; \-\-report junit:<path>, cucumber:<path> or swift\-testing:<path> (the JSON\-lines event stream of `swift test \-\-experimental\-event\-stream\-output`) also records the matched case and its outcome (a faithful verdict needs every bound case to pass). Every case whose own scenario id (the first id in its classname, then name, a Swift Testing display name, then function name, or a Cucumber tag) is this one is bound; a case that only mentions it is not; \-\-report\-case adds more. With \-\-task and no \-\-scenario, every case in the report is bound. Bound files are copied into .canon/artifacts/sha256/<hex> (commit them with the ledger; per\-file limit \-\-max\-artifact\-mib, default 25), and canon gate check re\-hashes them: a bound file whose bytes are gone is stale\-evidence. Strength requirements are opt\-in via policy experimental.evidence_binding (off by default).
|
|
149
149
|
|
|
150
150
|
ONE REPORT, MANY SCENARIOS (\-\-all\-scenarios).
|
|
151
151
|
With \-\-report, writes one record per indexed scenario that owns a case in the report, each with its own cases and its own verdict: \-\-verdict when given, else derived (faithful when every case passed, divergent when one failed, not\-applicable when one was skipped). A case whose id is not indexed is named and skipped. All or nothing: any refusal (a claimed faithful verdict over a failed case, a fabrication marker, an unapproved brief, a dropped binding) writes no record. The records share the stored report file.
|
|
152
152
|
|
|
153
153
|
FILES BELONG TO TESTS (\-\-artifact).
|
|
154
|
-
A record binds the attachments of the cases it owns: JUnit `[[ATTACHMENT|<path>]]` lines in a test\*(Aqs <system\-out> (Playwright\*(Aqs reporter; the path is relative to the report\*(Aqs directory) and Cucumber JSON embeddings, in a batch and with \-\-scenario
|
|
154
|
+
A record binds the attachments of the cases it owns: JUnit `[[ATTACHMENT|<path>]]` lines in a test\*(Aqs <system\-out> (Playwright\*(Aqs reporter; the path is relative to the report\*(Aqs directory) and Cucumber JSON embeddings, in a batch and with \-\-scenario alike. A missing, out\-of\-repo or oversized attachment is refused naming the case and the path. With \-\-all\-scenarios a bare \-\-artifact <path> is refused (it would bind to every record); bind a file to one scenario with \-\-artifact <scenario\-id>=<path> (the part before the first `=` counts only when shaped like a scenario id; write ./<path> for a file named otherwise).
|
|
155
155
|
|
|
156
156
|
A WRITE THAT BREAKS A REVIEW PIN SAYS SO.
|
|
157
157
|
When the new record supersedes evidence a current pinned review saw, one line per review now stale names the reviewer, the scenario and the `canon review scenario` command that re\-pins it (`\-\-rev` names the commit).
|
|
@@ -160,9 +160,9 @@ RE\-ATTESTING NEVER DROPS A BINDING SILENTLY (\-\-drop\-attachment).
|
|
|
160
160
|
For a scenario, a record that leaves out a file the scenario\*(Aqs latest record binds is refused (exit 2) until it re\-binds the file (new bytes at the same path are fine) or names it with \-\-drop\-attachment <path> (repeatable) \-\-drop\-reason <text>. The drop is recorded on the record and listed by canon status. Task\-only evidence has no drop guard.
|
|
161
161
|
|
|
162
162
|
NOTHING IS ATTESTED BEFORE THE BRIEF IS APPROVED (\-\-override\-reason).
|
|
163
|
-
While a subject this record attests for (the scenario\*(Aqs @subject owner, or any subject adopting the task\*(Aqs change) has
|
|
163
|
+
While a subject this record attests for (the scenario\*(Aqs @subject owner, or any subject adopting the task\*(Aqs change) has an unapproved brief the record answers to, the add is refused. A scenario tagged @flow:<change>.<F\-id> answers to the changes its tags name; an untagged one to every adopted change whose brief has an `Approved:` line (an edit since refuses it), or, with none, to its subject\*(Aqs newest tagged change or newest adopted change; a task to its own change; an unapproved chore or a pending draft never blocks evidence (exit 1, nothing staged): stop, report the brief and wait for the human\*(Aqs answer. \-\-override\-reason <text> attests anyway; the reason, the waived subjects and \-\-actor are recorded on the record and listed by canon status and canon gate check. A subject with no proposal.md to answer is unaffected; review scenario and finding add are never refused.
|
|
164
164
|
|
|
165
165
|
AUDITS.
|
|
166
166
|
An external evaluator\*(Aqs re\-audit is `canon evidence audit <SCENARIO_ID>`, not `\-\-kind audit`.
|
|
167
167
|
.SH VERSION
|
|
168
|
-
v0.
|
|
168
|
+
v0.32.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-evidence-approval-payload 1 "approval-payload 0.
|
|
3
|
+
.TH canon-evidence-approval-payload 1 "approval-payload 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-evidence\-approval\-payload \- Emit exact bytes for external `ssh\-keygen \-Y sign \-n canon\-approval\-v1`
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon evidence approval\-payload\fR [\fB\-\-as\fR] [\fB\-\-task
|
|
7
|
+
\fBcanon evidence approval\-payload\fR [\fB\-\-as\fR] [\fB\-\-task\fR] [\fB\-\-project\fR] [\fB\-\-scenario\fR] [\fB\-\-run\fR] [\fB\-\-rev\fR] [\fB\-\-surface\-ref\fR] <\fB\-\-approver\fR> <\fB\-\-approval\-at\fR> [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Emit exact bytes for external `ssh\-keygen \-Y sign \-n canon\-approval\-v1`
|
|
10
10
|
.SH OPTIONS
|
|
@@ -26,16 +26,16 @@ reviewer
|
|
|
26
26
|
orchestrator
|
|
27
27
|
.RE
|
|
28
28
|
.TP
|
|
29
|
-
\fB\-\-task
|
|
30
|
-
The plan task the approval is for (<change_id>#<n>); give this or \-\-scenario
|
|
29
|
+
\fB\-\-task\fR \fI<TASK_ID>\fR
|
|
30
|
+
The plan task the approval is for (<change_id>#<n>); give this or \-\-scenario
|
|
31
31
|
.TP
|
|
32
|
-
\fB\-\-project
|
|
33
|
-
Spec corpus id for \-\-scenario
|
|
32
|
+
\fB\-\-project\fR \fI<PROJECT_ID>\fR
|
|
33
|
+
Spec corpus id for \-\-scenario. Required only when canon.yaml configures more than one spec root
|
|
34
34
|
.TP
|
|
35
|
-
\fB\-\-scenario
|
|
36
|
-
The scenario the approval is for; give this or \-\-task
|
|
35
|
+
\fB\-\-scenario\fR \fI<SCENARIO_ID>\fR
|
|
36
|
+
The scenario the approval is for; give this or \-\-task
|
|
37
37
|
.TP
|
|
38
|
-
\fB\-\-run
|
|
38
|
+
\fB\-\-run\fR \fI<RUN_ID>\fR
|
|
39
39
|
The dispatch run the approved work belongs to
|
|
40
40
|
.TP
|
|
41
41
|
\fB\-\-rev\fR \fI<REV>\fR [default: HEAD]
|
|
@@ -62,4 +62,4 @@ Print help
|
|
|
62
62
|
\fB\-V\fR, \fB\-\-version\fR
|
|
63
63
|
Print version
|
|
64
64
|
.SH VERSION
|
|
65
|
-
v0.
|
|
65
|
+
v0.32.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-evidence-audit 1 "audit 0.
|
|
3
|
+
.TH canon-evidence-audit 1 "audit 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-evidence\-audit \- Record an external evaluator\*(Aqs re\-audit of one scenario (class `audit`; the verdict follows \-\-audit\-result; canon never runs the evaluator)
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon evidence audit\fR [\fB\-\-as\fR] [\fB\-\-project
|
|
7
|
+
\fBcanon evidence audit\fR [\fB\-\-as\fR] [\fB\-\-project\fR] <\fB\-\-ref\fR> [\fB\-\-summary\fR] [\fB\-\-command\-result\fR] [\fB\-\-run\fR] [\fB\-\-actor\fR] [\fB\-\-role\fR] [\fB\-\-session\fR] [\fB\-\-rev\fR] [\fB\-\-artifact\fR] [\fB\-\-report\fR] [\fB\-\-report\-case\fR] [\fB\-\-max\-artifact\-mib\fR] <\fB\-\-evaluator\fR> <\fB\-\-evaluator\-version\fR> <\fB\-\-evaluator\-digest\fR> <\fB\-\-audit\-result\fR> [\fB\-\-override\-reason\fR] [\fB\-\-promote\fR] [\fB\-\-no\-promote\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fISCENARIO_ID\fR>
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Record an external evaluator\*(Aqs re\-audit of one scenario (class `audit`; the verdict follows \-\-audit\-result; canon never runs the evaluator)
|
|
10
10
|
.SH OPTIONS
|
|
@@ -26,7 +26,7 @@ reviewer
|
|
|
26
26
|
orchestrator
|
|
27
27
|
.RE
|
|
28
28
|
.TP
|
|
29
|
-
\fB\-\-project
|
|
29
|
+
\fB\-\-project\fR \fI<PROJECT_ID>\fR
|
|
30
30
|
Spec corpus id of the scenario. Required only when canon.yaml configures more than one spec root; refused (UNKNOWN_SPEC_ROOT) when it names none
|
|
31
31
|
.TP
|
|
32
32
|
\fB\-\-ref\fR \fI<TEXT>\fR
|
|
@@ -38,16 +38,16 @@ One\-line note (scanned for fabrication markers; line breaks refused)
|
|
|
38
38
|
\fB\-\-command\-result\fR \fI<TEXT>\fR
|
|
39
39
|
The real captured output backing \-\-summary (requires \-\-summary; scanned for fabrication markers)
|
|
40
40
|
.TP
|
|
41
|
-
\fB\-\-run
|
|
41
|
+
\fB\-\-run\fR \fI<RUN_ID>\fR
|
|
42
42
|
RunId (ULID) of the run that produced this evidence
|
|
43
43
|
.TP
|
|
44
|
-
\fB\-\-actor
|
|
44
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR [default: canon]
|
|
45
45
|
The attesting actor\*(Aqs id (recorded as the attestation\*(Aqs author; line breaks refused)
|
|
46
46
|
.TP
|
|
47
47
|
\fB\-\-role\fR \fI<ROLE>\fR
|
|
48
48
|
The attesting role; `canon gate promote` derives its run_seq partition key from it. Default: the declared role (\-\-as / CANON_ROLE); required when none is declared
|
|
49
49
|
.TP
|
|
50
|
-
\fB\-\-session
|
|
50
|
+
\fB\-\-session\fR \fI<SESSION_ID>\fR
|
|
51
51
|
The attesting session (recorded as actor.session_id)
|
|
52
52
|
.TP
|
|
53
53
|
\fB\-\-rev\fR \fI<REV>\fR [default: HEAD]
|
|
@@ -65,7 +65,7 @@ EXPERIMENTAL: also bind this report case (a Rust test: its function name); repea
|
|
|
65
65
|
\fB\-\-max\-artifact\-mib\fR \fI<N>\fR [default: 25]
|
|
66
66
|
Per\-file size limit for the artifact store (.canon/artifacts/sha256/), in MiB; a larger bound file is refused
|
|
67
67
|
.TP
|
|
68
|
-
\fB\-\-evaluator
|
|
68
|
+
\fB\-\-evaluator\fR \fI<ID>\fR
|
|
69
69
|
The external evaluator that re\-audited the scenario (canon never runs it)
|
|
70
70
|
.TP
|
|
71
71
|
\fB\-\-evaluator\-version\fR \fI<TEXT>\fR
|
|
@@ -90,7 +90,7 @@ indeterminate
|
|
|
90
90
|
.RE
|
|
91
91
|
.TP
|
|
92
92
|
\fB\-\-override\-reason\fR \fI<TEXT>\fR
|
|
93
|
-
Attest anyway while a subject this record attests for has a brief awaiting the human\*(Aqs answer (one line, recorded on the record with \-\-actor
|
|
93
|
+
Attest anyway while a subject this record attests for has a brief awaiting the human\*(Aqs answer (one line, recorded on the record with \-\-actor)
|
|
94
94
|
.TP
|
|
95
95
|
\fB\-\-promote\fR
|
|
96
96
|
Promote the record this run staged, in the same run; records others staged stay staged (the default under canon.yaml `write: { promote: auto }`)
|
|
@@ -116,6 +116,6 @@ Print version
|
|
|
116
116
|
<\fISCENARIO_ID\fR>
|
|
117
117
|
The re\-audited scenario (`<area>.<surface>.<nn>`)
|
|
118
118
|
.SH EXTRA
|
|
119
|
-
Records an external evaluator\*(Aqs re\-audit of one scenario: \-\-evaluator
|
|
119
|
+
Records an external evaluator\*(Aqs re\-audit of one scenario: \-\-evaluator, \-\-evaluator\-version, \-\-evaluator\-digest <sha256>, \-\-audit\-result confirmed|refuted|indeterminate, and optional \-\-report/\-\-artifact counterexamples, bound and stored like any report. canon never generates or runs the audit. An audit never becomes the scenario\*(Aqs declared verdict; a refuted latest audit is false\-success in canon gate check, whatever the declared verdict says.
|
|
120
120
|
.SH VERSION
|
|
121
|
-
v0.
|
|
121
|
+
v0.32.0
|
package/man/canon-evidence.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-evidence 1 "evidence 0.
|
|
3
|
+
.TH canon-evidence 1 "evidence 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-evidence \- Author a staged, attributed evidence attestation for a plan task
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -43,7 +43,7 @@ canon\-evidence\-audit(1)
|
|
|
43
43
|
Record an external evaluator\*(Aqs re\-audit of one scenario (class `audit`; the verdict follows \-\-audit\-result; canon never runs the evaluator)
|
|
44
44
|
.SH EXTRA
|
|
45
45
|
Examples:
|
|
46
|
-
canon evidence add \-\-task
|
|
46
|
+
canon evidence add \-\-task my\-change#3.1 \-\-class test\-run \-\-ref \*(Aqcargo test \-p canon\-cli\*(Aq \-\-role implementer
|
|
47
47
|
|
|
48
48
|
The loop:
|
|
49
49
|
canon evidence add ... Record an EvidenceRecord (promoted in the same run under
|
|
@@ -54,4 +54,4 @@ each add to commit it (assigns run_seq).
|
|
|
54
54
|
|
|
55
55
|
See `canon evidence add \-\-help` for exactly what the gate does and does not check.
|
|
56
56
|
.SH VERSION
|
|
57
|
-
v0.
|
|
57
|
+
v0.32.0
|
package/man/canon-export.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-export 1 "export 0.
|
|
3
|
+
.TH canon-export 1 "export 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-export \- Export a redacted retention manifest without deleting records
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -105,4 +105,4 @@ Print help
|
|
|
105
105
|
\fB\-V\fR, \fB\-\-version\fR
|
|
106
106
|
Print version
|
|
107
107
|
.SH VERSION
|
|
108
|
-
v0.
|
|
108
|
+
v0.32.0
|
package/man/canon-feature-new.1
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-feature-new 1 "new 0.
|
|
3
|
+
.TH canon-feature-new 1 "new 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-feature\-new \- Create a fresh .feature file for a new area.surface
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon feature new\fR [\fB\-\-as\fR] <\fB\-\-title\fR> [\fB\-\-actor
|
|
7
|
+
\fBcanon feature new\fR [\fB\-\-as\fR] <\fB\-\-title\fR> [\fB\-\-actor\fR] [\fB\-\-session\fR] [\fB\-\-project\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fISURFACE\fR>
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Create a fresh .feature file for a new area.surface
|
|
10
10
|
.SH OPTIONS
|
|
@@ -29,16 +29,16 @@ orchestrator
|
|
|
29
29
|
\fB\-\-title\fR \fI<TEXT>\fR
|
|
30
30
|
The Feature: header label
|
|
31
31
|
.TP
|
|
32
|
-
\fB\-\-actor
|
|
32
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR [default: canon\-scaffold]
|
|
33
33
|
Agent id written into provenance (env: CANON_ACTOR)
|
|
34
34
|
.RS
|
|
35
35
|
May also be specified with the \fBCANON_ACTOR\fR environment variable.
|
|
36
36
|
.RE
|
|
37
37
|
.TP
|
|
38
|
-
\fB\-\-session
|
|
38
|
+
\fB\-\-session\fR \fI<SESSION_ID>\fR
|
|
39
39
|
The acting session (recorded as actor.session_id); optional
|
|
40
40
|
.TP
|
|
41
|
-
\fB\-\-project
|
|
41
|
+
\fB\-\-project\fR \fI<PROJECT_ID>\fR
|
|
42
42
|
Which configured `specs.roots[]` entry to write under, by its id. Required only when the repo configures more than one
|
|
43
43
|
.TP
|
|
44
44
|
\fB\-\-repo\fR \fI<DIR>\fR
|
|
@@ -59,4 +59,4 @@ Print version
|
|
|
59
59
|
<\fISURFACE\fR>
|
|
60
60
|
<area>.<surface> the fresh .feature file scaffolds
|
|
61
61
|
.SH VERSION
|
|
62
|
-
v0.
|
|
62
|
+
v0.32.0
|
package/man/canon-feature.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-feature 1 "feature 0.
|
|
3
|
+
.TH canon-feature 1 "feature 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-feature \- Scaffold a new .feature spec file
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -36,4 +36,4 @@ Print version
|
|
|
36
36
|
canon\-feature\-new(1)
|
|
37
37
|
Create a fresh .feature file for a new area.surface
|
|
38
38
|
.SH VERSION
|
|
39
|
-
v0.
|
|
39
|
+
v0.32.0
|
package/man/canon-finding-add.1
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-finding-add 1 "add 0.
|
|
3
|
+
.TH canon-finding-add 1 "add 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-finding\-add \- Record one code\-review finding (promoted in the same run under `write: { promote: auto }` or with \-\-promote; under `write.promote: manual`, commit it with `canon gate promote`)
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon finding add\fR [\fB\-\-as\fR] <\fB\-\-change
|
|
7
|
+
\fBcanon finding add\fR [\fB\-\-as\fR] <\fB\-\-change\fR> <\fB\-\-round\fR> <\fB\-\-seq\fR> <\fB\-\-severity\fR> [\fB\-\-disposition\fR] <\fB\-\-actor\fR> <\fB\-\-summary\fR> [\fB\-\-rev\fR] [\fB\-\-resolution\-rev\fR] [\fB\-\-introduced\-rev\fR] [\fB\-\-introduced\-unknown\fR] [\fB\-\-review\fR] [\fB\-\-file\-ref\fR] [\fB\-\-scenario\fR] [\fB\-\-role\fR] [\fB\-\-session\fR] [\fB\-\-promote\fR] [\fB\-\-no\-promote\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Record one code\-review finding (promoted in the same run under `write: { promote: auto }` or with \-\-promote; under `write.promote: manual`, commit it with `canon gate promote`)
|
|
10
10
|
.SH OPTIONS
|
|
@@ -26,7 +26,7 @@ reviewer
|
|
|
26
26
|
orchestrator
|
|
27
27
|
.RE
|
|
28
28
|
.TP
|
|
29
|
-
\fB\-\-change
|
|
29
|
+
\fB\-\-change\fR \fI<CHANGE_ID>\fR
|
|
30
30
|
The change under review (e.g. s43\-findings\-are\-records) — first component of the natural key
|
|
31
31
|
.TP
|
|
32
32
|
\fB\-\-round\fR \fI<N>\fR
|
|
@@ -67,7 +67,7 @@ rejected
|
|
|
67
67
|
deferred
|
|
68
68
|
.RE
|
|
69
69
|
.TP
|
|
70
|
-
\fB\-\-actor
|
|
70
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR
|
|
71
71
|
The reviewer who raised it, recorded as the finding\*(Aqs reviewer and author (line breaks refused)
|
|
72
72
|
.TP
|
|
73
73
|
\fB\-\-summary\fR \fI<TEXT>\fR
|
|
@@ -85,19 +85,19 @@ The SOURCED introducing commit, any git revision (resolved to the full sha). No
|
|
|
85
85
|
\fB\-\-introduced\-unknown\fR
|
|
86
86
|
Say the introducing commit is not known, instead of \-\-introduced\-rev. A new blocker or should\-fix needs one of the two; a note needs neither. Stored in its own field, never in the commit slot
|
|
87
87
|
.TP
|
|
88
|
-
\fB\-\-review
|
|
88
|
+
\fB\-\-review\fR \fI<REVIEW_ID>\fR
|
|
89
89
|
The review this finding came out of: the review id `canon review scenario` or `canon review change` printed. Refused when no review in the ledger or the archive carries it; a close copies it
|
|
90
90
|
.TP
|
|
91
91
|
\fB\-\-file\-ref\fR \fI<TEXT>\fR
|
|
92
92
|
Where in the tree, as path/to/file.rs:120\-134 (line breaks refused)
|
|
93
93
|
.TP
|
|
94
|
-
\fB\-\-scenario
|
|
94
|
+
\fB\-\-scenario\fR \fI<SCENARIO_ID>\fR
|
|
95
95
|
A scenario this finding is about (repeatable). After a `fixed` close, fresh evidence for these scenarios alone re\-verifies the fix; with none named, every evidenced scenario of the subject does. Each must be a scenario the index knows; a close inherits the list
|
|
96
96
|
.TP
|
|
97
97
|
\fB\-\-role\fR \fI<ROLE>\fR [default: reviewer]
|
|
98
98
|
Attribution only — unlike `canon evidence add`, no partition key derives from it
|
|
99
99
|
.TP
|
|
100
|
-
\fB\-\-session
|
|
100
|
+
\fB\-\-session\fR \fI<SESSION_ID>\fR
|
|
101
101
|
The authoring session (recorded as actor.session_id)
|
|
102
102
|
.TP
|
|
103
103
|
\fB\-\-promote\fR
|
|
@@ -187,15 +187,15 @@ would relocate the hand\-typing from the release notes into the record.
|
|
|
187
187
|
\-\-seq is REQUIRED, never auto\-assigned: two concurrent adds would read the
|
|
188
188
|
same highest seq and both pick the next one, landing two records under one
|
|
189
189
|
finding\*(Aqs identity and inflating the count. An already\-occupied
|
|
190
|
-
(\-\-change
|
|
190
|
+
(\-\-change, \-\-round, \-\-seq) is refused, naming it.
|
|
191
191
|
|
|
192
192
|
Refused before anything is staged:
|
|
193
193
|
\- a blocker or should\-fix with neither \-\-introduced\-rev nor
|
|
194
194
|
\-\-introduced\-unknown, and \-\-introduced\-rev together with \-\-introduced\-unknown
|
|
195
|
-
\- a \-\-review
|
|
195
|
+
\- a \-\-review that no review in the ledger or the archive carries
|
|
196
196
|
\- \-\-disposition fixed with no \-\-resolution\-rev, and \-\-resolution\-rev with
|
|
197
197
|
any other disposition
|
|
198
|
-
\- a line separator in \-\-summary, \-\-file\-ref or \-\-actor
|
|
198
|
+
\- a line separator in \-\-summary, \-\-file\-ref or \-\-actor: a
|
|
199
199
|
finding is rendered as ONE row, so a separator appends a second row that
|
|
200
200
|
no record backs
|
|
201
201
|
|
|
@@ -205,4 +205,4 @@ The loop:
|
|
|
205
205
|
Under `write.promote: manual` (no `write:` key), run `canon gate promote` to
|
|
206
206
|
commit it.
|
|
207
207
|
.SH VERSION
|
|
208
|
-
v0.
|
|
208
|
+
v0.32.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-finding-close 1 "close 0.
|
|
3
|
+
.TH canon-finding-close 1 "close 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-finding\-close \- Move an already\-committed finding\*(Aqs disposition (promoted in the same run under `write: { promote: auto }` or with \-\-promote; under `write.promote: manual`, commit it with `canon gate promote`)
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon finding close\fR [\fB\-\-as\fR] <\fB\-\-round\fR> <\fB\-\-seq\fR> <\fB\-\-disposition\fR> [\fB\-\-resolution\-rev\fR] [\fB\-\-reason\fR] [\fB\-\-actor
|
|
7
|
+
\fBcanon finding close\fR [\fB\-\-as\fR] <\fB\-\-round\fR> <\fB\-\-seq\fR> <\fB\-\-disposition\fR> [\fB\-\-resolution\-rev\fR] [\fB\-\-reason\fR] [\fB\-\-actor\fR] [\fB\-\-role\fR] [\fB\-\-session\fR] [\fB\-\-promote\fR] [\fB\-\-no\-promote\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fICHANGE_ID\fR>
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Move an already\-committed finding\*(Aqs disposition (promoted in the same run under `write: { promote: auto }` or with \-\-promote; under `write.promote: manual`, commit it with `canon gate promote`)
|
|
10
10
|
.SH OPTIONS
|
|
@@ -55,13 +55,13 @@ The commit that closed it, any git revision (resolved to the full sha, with the
|
|
|
55
55
|
\fB\-\-reason\fR \fI<TEXT>\fR
|
|
56
56
|
Why it was closed, one line. Required for rejected and deferred, optional for fixed and open; stored on the closing version and shown by `finding list`
|
|
57
57
|
.TP
|
|
58
|
-
\fB\-\-actor
|
|
58
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR [default: canon]
|
|
59
59
|
The actor recorded as authoring the TRANSITION — not the original finding\*(Aqs author, which is preserved on the record this supersedes
|
|
60
60
|
.TP
|
|
61
61
|
\fB\-\-role\fR \fI<ROLE>\fR [default: reviewer]
|
|
62
62
|
Attribution only — no partition key derives from it
|
|
63
63
|
.TP
|
|
64
|
-
\fB\-\-session
|
|
64
|
+
\fB\-\-session\fR \fI<SESSION_ID>\fR
|
|
65
65
|
The session that authored the TRANSITION (recorded as actor.session_id)
|
|
66
66
|
.TP
|
|
67
67
|
\fB\-\-promote\fR
|
|
@@ -109,9 +109,9 @@ natural key to the latest version, so the finding is still counted once.
|
|
|
109
109
|
the second version, so a hand\-written body must clear the same bar.
|
|
110
110
|
|
|
111
111
|
Examples:
|
|
112
|
-
canon finding close
|
|
112
|
+
canon finding close s44\-spec\-derived\-worklist \-\-round 1 \-\-seq 1 \\
|
|
113
113
|
\-\-disposition fixed \-\-resolution\-rev $(git rev\-parse HEAD)
|
|
114
|
-
canon finding close
|
|
115
|
-
\-\-disposition rejected
|
|
114
|
+
canon finding close s44\-spec\-derived\-worklist \-\-round 1 \-\-seq 9 \\
|
|
115
|
+
\-\-disposition rejected \-\-reason "not a defect"
|
|
116
116
|
.SH VERSION
|
|
117
|
-
v0.
|
|
117
|
+
v0.32.0
|
package/man/canon-finding-list.1
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-finding-list 1 "list 0.
|
|
3
|
+
.TH canon-finding-list 1 "list 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-finding\-list \- List a change\*(Aqs committed findings at their latest version: round, seq, severity, disposition, reviewer and summary
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon finding list\fR [\fB\-\-as\fR] <\fB\-\-change
|
|
7
|
+
\fBcanon finding list\fR [\fB\-\-as\fR] <\fB\-\-change\fR> [\fB\-\-open\fR] [\fB\-\-json\fR] [\fB\-\-repo\fR] [\fB\-\-limit\fR] [\fB\-\-cursor\fR] [\fB\-\-all\fR] [\fB\-\-fields\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
List a change\*(Aqs committed findings at their latest version: round, seq, severity, disposition, reviewer and summary
|
|
10
10
|
.SH OPTIONS
|
|
@@ -26,7 +26,7 @@ reviewer
|
|
|
26
26
|
orchestrator
|
|
27
27
|
.RE
|
|
28
28
|
.TP
|
|
29
|
-
\fB\-\-change
|
|
29
|
+
\fB\-\-change\fR \fI<CHANGE_ID>\fR
|
|
30
30
|
The change whose findings to list
|
|
31
31
|
.TP
|
|
32
32
|
\fB\-\-open\fR
|
|
@@ -56,4 +56,4 @@ Print help
|
|
|
56
56
|
\fB\-V\fR, \fB\-\-version\fR
|
|
57
57
|
Print version
|
|
58
58
|
.SH VERSION
|
|
59
|
-
v0.
|
|
59
|
+
v0.32.0
|
package/man/canon-finding.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-finding 1 "finding 0.
|
|
3
|
+
.TH canon-finding 1 "finding 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-finding \- Record one code\-review finding as a durable record
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -43,8 +43,8 @@ canon\-finding\-list(1)
|
|
|
43
43
|
List a change\*(Aqs committed findings at their latest version: round, seq, severity, disposition, reviewer and summary
|
|
44
44
|
.SH EXTRA
|
|
45
45
|
Examples:
|
|
46
|
-
canon finding add \-\-change
|
|
47
|
-
\-\-severity blocker \-\-disposition open \-\-actor
|
|
46
|
+
canon finding add \-\-change s43\-findings\-are\-records \-\-round 1 \-\-seq 1 \\
|
|
47
|
+
\-\-severity blocker \-\-disposition open \-\-actor review\-voice \\
|
|
48
48
|
\-\-summary \*(Aqa release metric is asserted, never computed\*(Aq
|
|
49
49
|
canon finding close s43\-findings\-are\-records \-\-round 1 \-\-seq 1 \\
|
|
50
50
|
\-\-disposition fixed \-\-resolution\-rev $(git rev\-parse HEAD)
|
|
@@ -64,4 +64,4 @@ RECORDED OBSERVATION, NOT PROOF — canon never verifies that the defect
|
|
|
64
64
|
existed, that it was fixed, or that \-\-introduced\-rev is the true cause.
|
|
65
65
|
See `canon finding add \-\-help` for exactly what it does and does not establish.
|
|
66
66
|
.SH VERSION
|
|
67
|
-
v0.
|
|
67
|
+
v0.32.0
|
package/man/canon-format.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-format 1 "format 0.
|
|
3
|
+
.TH canon-format 1 "format 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-format \- Validate a spec/artifact corpus against canon\*(Aqs format
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -46,4 +46,4 @@ Examples:
|
|
|
46
46
|
canon format spec
|
|
47
47
|
canon format spec \-\-repo ~/work/myrepo
|
|
48
48
|
.SH VERSION
|
|
49
|
-
v0.
|
|
49
|
+
v0.32.0
|
package/man/canon-gate-check.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-gate-check 1 "check 0.
|
|
3
|
+
.TH canon-gate-check 1 "check 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-gate\-check \- Run the coverage/ledger/staleness/trust checks (0 clean, 1 red, 2 usage)
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -41,4 +41,4 @@ Print help
|
|
|
41
41
|
\fB\-V\fR, \fB\-\-version\fR
|
|
42
42
|
Print version
|
|
43
43
|
.SH VERSION
|
|
44
|
-
v0.
|
|
44
|
+
v0.32.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-gate-install-hooks 1 "install-hooks 0.
|
|
3
|
+
.TH canon-gate-install-hooks 1 "install-hooks 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-gate\-install\-hooks \- Install the gate hook into .claude/settings.json / .codex/hooks.json
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -56,4 +56,4 @@ Print help
|
|
|
56
56
|
\fB\-V\fR, \fB\-\-version\fR
|
|
57
57
|
Print version
|
|
58
58
|
.SH VERSION
|
|
59
|
-
v0.
|
|
59
|
+
v0.32.0
|
package/man/canon-gate-promote.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-gate-promote 1 "promote 0.
|
|
3
|
+
.TH canon-gate-promote 1 "promote 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-gate\-promote \- Promote staged records (evidence, findings, divergences) to the committed ledger
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -59,4 +59,4 @@ Print help
|
|
|
59
59
|
\fB\-V\fR, \fB\-\-version\fR
|
|
60
60
|
Print version
|
|
61
61
|
.SH VERSION
|
|
62
|
-
v0.
|
|
62
|
+
v0.32.0
|
package/man/canon-gate.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-gate 1 "gate 0.
|
|
3
|
+
.TH canon-gate 1 "gate 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-gate \- Run evidence gates, promote staged records, install hooks
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -47,4 +47,4 @@ Examples:
|
|
|
47
47
|
canon task done my\-change#3
|
|
48
48
|
canon gate install\-hooks
|
|
49
49
|
.SH VERSION
|
|
50
|
-
v0.
|
|
50
|
+
v0.32.0
|
package/man/canon-ingest-plans.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-ingest-plans 1 "plans 0.
|
|
3
|
+
.TH canon-ingest-plans 1 "plans 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-ingest\-plans \- Import plans as Change/Task records: canon\*(Aqs own .canon/changes, then the configured external sources (openspec, superpowers)
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -50,4 +50,4 @@ Print help
|
|
|
50
50
|
\fB\-V\fR, \fB\-\-version\fR
|
|
51
51
|
Print version
|
|
52
52
|
.SH VERSION
|
|
53
|
-
v0.
|
|
53
|
+
v0.32.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-ingest-records 1 "records 0.
|
|
3
|
+
.TH canon-ingest-records 1 "records 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-ingest\-records \- Import review/divergence/task/handoff records and derive verdicts
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon ingest records\fR [\fB\-\-as\fR] [\fB\-\-watch\fR] [\fB\-\-interval\-secs\fR] [\fB\-\-repo\fR] [\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-run
|
|
7
|
+
\fBcanon ingest records\fR [\fB\-\-as\fR] [\fB\-\-watch\fR] [\fB\-\-interval\-secs\fR] [\fB\-\-repo\fR] [\fB\-\-dry\-run\fR] [\fB\-\-json\fR] [\fB\-\-run\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
Import review/divergence/task/handoff records and derive verdicts
|
|
10
10
|
.SH OPTIONS
|
|
@@ -41,7 +41,7 @@ Validate fully and report what would be written, without writing anything
|
|
|
41
41
|
\fB\-\-json\fR
|
|
42
42
|
Output JSON instead of the human\-readable form
|
|
43
43
|
.TP
|
|
44
|
-
\fB\-\-run
|
|
44
|
+
\fB\-\-run\fR \fI<RUN_ID>\fR
|
|
45
45
|
Attribute this pass\*(Aqs trajectories to a dispatched run (a RunId minted by `canon dispatch begin`)
|
|
46
46
|
.TP
|
|
47
47
|
\fB\-\-input\fR \fI<JSON|FILE|\->\fR
|
|
@@ -53,4 +53,4 @@ Print help
|
|
|
53
53
|
\fB\-V\fR, \fB\-\-version\fR
|
|
54
54
|
Print version
|
|
55
55
|
.SH VERSION
|
|
56
|
-
v0.
|
|
56
|
+
v0.32.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-ingest-sessions 1 "sessions 0.
|
|
3
|
+
.TH canon-ingest-sessions 1 "sessions 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-ingest\-sessions \- Import agent CLI session transcripts (omp/pi, Claude Code, Codex, Hermes)
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -59,4 +59,4 @@ Print help
|
|
|
59
59
|
\fB\-V\fR, \fB\-\-version\fR
|
|
60
60
|
Print version
|
|
61
61
|
.SH VERSION
|
|
62
|
-
v0.
|
|
62
|
+
v0.32.0
|
package/man/canon-ingest.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-ingest 1 "ingest 0.
|
|
3
|
+
.TH canon-ingest 1 "ingest 0.32.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-ingest \- Import agent sessions, records, and plans into canon\*(Aqs store
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -47,4 +47,4 @@ Examples:
|
|
|
47
47
|
canon ingest records
|
|
48
48
|
canon ingest plans
|
|
49
49
|
.SH VERSION
|
|
50
|
-
v0.
|
|
50
|
+
v0.32.0
|