@journeykit/canon 0.29.0 → 0.31.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 +48 -22
- package/dist/skills/reference/brief-polish.md +4 -4
- package/dist/skills/reference/brief-shape.md +38 -7
- package/dist/skills/reference/canon-authoring.md +6 -6
- package/dist/skills/reference/canon-gate.md +49 -34
- 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-report-dashboard.md +12 -8
- package/dist/skills/reference/canon-review.md +26 -25
- package/dist/skills/reference/canon-storage.md +20 -3
- package/dist/skills/reference/canon-subject.md +132 -98
- package/dist/skills/reference/role-implementer.md +42 -28
- package/dist/skills/reference/role-orchestrator.md +40 -24
- package/dist/skills/reference/role-planner.md +32 -17
- package/dist/skills/reference/role-reviewer.md +48 -30
- 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 +7 -4
- package/man/canon-brief-check.1 +2 -2
- package/man/canon-brief-show.1 +2 -2
- 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 +6 -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 +23 -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 +25 -3
- package/man/canon-plugin-sync.1 +2 -2
- package/man/canon-plugin.1 +2 -2
- package/man/canon-policy-approve.1 +2 -2
- 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
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-dispatch-begin 1 "begin 0.
|
|
3
|
+
.TH canon-dispatch-begin 1 "begin 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-dispatch\-begin \- Mint a Run manifest with retrieved guidance and context/policy lineage
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon dispatch begin\fR [\fB\-\-as\fR] [\fB\-\-role\fR] <\fB\-\-regime\fR> [\fB\-\-actor
|
|
7
|
+
\fBcanon dispatch begin\fR [\fB\-\-as\fR] [\fB\-\-role\fR] <\fB\-\-regime\fR> [\fB\-\-actor\fR] [\fB\-\-session\fR] [\fB\-\-provider\fR] [\fB\-\-model\fR] [\fB\-\-skill\fR] [\fB\-\-skill\-digest\fR] [\fB\-\-manifest\fR] [\fB\-\-prompt\-bundle\fR] [\fB\-\-task\fR] [\fB\-\-parent\-run\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
|
Mint a Run manifest with retrieved guidance and context/policy lineage
|
|
10
10
|
.SH OPTIONS
|
|
@@ -32,23 +32,23 @@ Role about to run; must equal \-\-regime\*(Aqs leading segment
|
|
|
32
32
|
\fB\-\-regime\fR \fI<KEY>\fR
|
|
33
33
|
Full regime key (<role>/<repo>/<area>/<hash>) to retrieve guidance for
|
|
34
34
|
.TP
|
|
35
|
-
\fB\-\-actor
|
|
35
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR [default: canon]
|
|
36
36
|
The dispatching agent\*(Aqs id (recorded as the run\*(Aqs actor)
|
|
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
41
|
\fB\-\-provider\fR \fI<NAME>\fR
|
|
42
|
-
Declared provider metadata (copied verbatim; never inferred from \-\-actor
|
|
42
|
+
Declared provider metadata (copied verbatim; never inferred from \-\-actor)
|
|
43
43
|
.TP
|
|
44
44
|
\fB\-\-model\fR \fI<NAME>\fR
|
|
45
45
|
Declared model metadata (copied verbatim)
|
|
46
46
|
.TP
|
|
47
|
-
\fB\-\-skill
|
|
47
|
+
\fB\-\-skill\fR \fI<ID>\fR
|
|
48
48
|
Skill that contributed to this run
|
|
49
49
|
.TP
|
|
50
50
|
\fB\-\-skill\-digest\fR \fI<DIGEST>\fR
|
|
51
|
-
Declared skill digest; requires \-\-skill
|
|
51
|
+
Declared skill digest; requires \-\-skill
|
|
52
52
|
.TP
|
|
53
53
|
\fB\-\-manifest\fR \fI<FILE>\fR
|
|
54
54
|
Explicit repository\-relative ContextPack input manifest
|
|
@@ -56,10 +56,10 @@ Explicit repository\-relative ContextPack input manifest
|
|
|
56
56
|
\fB\-\-prompt\-bundle\fR \fI<NAME@VERSION>\fR
|
|
57
57
|
Registered prompt bundle to select (`name@version`)
|
|
58
58
|
.TP
|
|
59
|
-
\fB\-\-task
|
|
59
|
+
\fB\-\-task\fR \fI<TASK_ID>\fR
|
|
60
60
|
Plan task this run serves (<change_id>#<n>); validated against the plan corpus
|
|
61
61
|
.TP
|
|
62
|
-
\fB\-\-parent\-run
|
|
62
|
+
\fB\-\-parent\-run\fR \fI<RUN_ID>\fR
|
|
63
63
|
RunId (ULID) of the run that dispatched this one
|
|
64
64
|
.TP
|
|
65
65
|
\fB\-\-repo\fR \fI<DIR>\fR
|
|
@@ -77,4 +77,4 @@ Print help
|
|
|
77
77
|
\fB\-V\fR, \fB\-\-version\fR
|
|
78
78
|
Print version
|
|
79
79
|
.SH VERSION
|
|
80
|
-
v0.
|
|
80
|
+
v0.31.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-dispatch-diff 1 "diff 0.
|
|
3
|
+
.TH canon-dispatch-diff 1 "diff 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-dispatch\-diff \- Diff the declared plan DAG against the observed execution graph
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -38,4 +38,4 @@ Print help
|
|
|
38
38
|
\fB\-V\fR, \fB\-\-version\fR
|
|
39
39
|
Print version
|
|
40
40
|
.SH VERSION
|
|
41
|
-
v0.
|
|
41
|
+
v0.31.0
|
package/man/canon-dispatch-end.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-dispatch-end 1 "end 0.
|
|
3
|
+
.TH canon-dispatch-end 1 "end 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-dispatch\-end \- Close a dispatched run with a terminal status and an ended_at
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -57,4 +57,4 @@ Print version
|
|
|
57
57
|
<\fIRUN_ID\fR>
|
|
58
58
|
The RunId (ULID) minted by `canon dispatch begin`
|
|
59
59
|
.SH VERSION
|
|
60
|
-
v0.
|
|
60
|
+
v0.31.0
|
package/man/canon-dispatch.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-dispatch 1 "dispatch 0.
|
|
3
|
+
.TH canon-dispatch 1 "dispatch 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-dispatch \- Begin an agent run with retrieved guidance recorded
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -42,4 +42,4 @@ Close a dispatched run with a terminal status and an ended_at
|
|
|
42
42
|
canon\-dispatch\-diff(1)
|
|
43
43
|
Diff the declared plan DAG against the observed execution graph
|
|
44
44
|
.SH VERSION
|
|
45
|
-
v0.
|
|
45
|
+
v0.31.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-divergence-accept 1 "accept 0.
|
|
3
|
+
.TH canon-divergence-accept 1 "accept 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-divergence\-accept \- Accept a divergent scenario as a tracked known gap (a reviewer step): its latest evidence must be divergent and not the accepting actor\*(Aqs or session\*(Aqs. The acceptance pins that evidence, so new evidence ends it, and lapses at \-\-expiry; until then the ship guard counts the cell as covered while `status` and `gate check` list it as `accepted\-divergence`
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon divergence accept\fR [\fB\-\-as\fR] [\fB\-\-project
|
|
7
|
+
\fBcanon divergence accept\fR [\fB\-\-as\fR] [\fB\-\-project\fR] <\fB\-\-reason\fR> <\fB\-\-tracking\fR> [\fB\-\-expiry\fR] <\fB\-\-actor\fR> [\fB\-\-role\fR] [\fB\-\-session\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
|
Accept a divergent scenario as a tracked known gap (a reviewer step): its latest evidence must be divergent and not the accepting actor\*(Aqs or session\*(Aqs. The acceptance pins that evidence, so new evidence ends it, and lapses at \-\-expiry; until then the ship guard counts the cell as covered while `status` and `gate check` list it as `accepted\-divergence`
|
|
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 scenarios. Required only when canon.yaml configures more than one spec root
|
|
31
31
|
.TP
|
|
32
32
|
\fB\-\-reason\fR \fI<TEXT>\fR
|
|
@@ -38,13 +38,13 @@ Where the gap is tracked: an issue URL or reference
|
|
|
38
38
|
\fB\-\-expiry\fR \fI<TIMESTAMP>\fR
|
|
39
39
|
The date (YYYY\-MM\-DD, UTC) the acceptance stops holding; none means it holds until new evidence
|
|
40
40
|
.TP
|
|
41
|
-
\fB\-\-actor
|
|
41
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR
|
|
42
42
|
The reviewer recording this (recorded as the divergence\*(Aqs reviewer and actor)
|
|
43
43
|
.TP
|
|
44
44
|
\fB\-\-role\fR \fI<ROLE>\fR
|
|
45
45
|
Must be reviewer (default: the declared role, \-\-as / CANON_ROLE; required when none is declared)
|
|
46
46
|
.TP
|
|
47
|
-
\fB\-\-session
|
|
47
|
+
\fB\-\-session\fR \fI<SESSION_ID>\fR
|
|
48
48
|
The accepting session (recorded as actor.session_id); it must not be one that attested the scenario\*(Aqs evidence
|
|
49
49
|
.TP
|
|
50
50
|
\fB\-\-repo\fR \fI<DIR>\fR
|
|
@@ -65,4 +65,4 @@ Print version
|
|
|
65
65
|
<\fISCENARIO_ID\fR>
|
|
66
66
|
The accepted scenarios (`<area>.<surface>.<nn>`), one acceptance each, all or nothing
|
|
67
67
|
.SH VERSION
|
|
68
|
-
v0.
|
|
68
|
+
v0.31.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-divergence-add 1 "add 0.
|
|
3
|
+
.TH canon-divergence-add 1 "add 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-divergence\-add \- Add a divergence candidate, staged with no run_seq yet (commit it with `canon gate promote \-\-kind divergence`, or in the same run with \-\-promote / `write: { promote: auto }`)
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon divergence add\fR [\fB\-\-as\fR] [\fB\-\-project
|
|
7
|
+
\fBcanon divergence add\fR [\fB\-\-as\fR] [\fB\-\-project\fR] [\fB\-\-rev\fR] [\fB\-\-state\fR] [\fB\-\-reason\fR] [\fB\-\-expiry\fR] [\fB\-\-round\fR] <\fB\-\-actor\fR> [\fB\-\-session\fR] [\fB\-\-detail\fR] [\fB\-\-role\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
|
Add a divergence candidate, staged with no run_seq yet (commit it with `canon gate promote \-\-kind divergence`, or in the same run with \-\-promote / `write: { promote: auto }`)
|
|
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
|
|
31
31
|
.TP
|
|
32
32
|
\fB\-\-rev\fR \fI<REV>\fR [default: HEAD]
|
|
@@ -58,10 +58,10 @@ When a deferral lapses (RFC3339 or YYYY\-MM\-DD, UTC); required with `\-\-state
|
|
|
58
58
|
\fB\-\-round\fR \fI<N>\fR [default: 1]
|
|
59
59
|
The review round this version belongs to (1\-based)
|
|
60
60
|
.TP
|
|
61
|
-
\fB\-\-actor
|
|
61
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR
|
|
62
62
|
The reviewer recording this (recorded as the divergence\*(Aqs reviewer and actor)
|
|
63
63
|
.TP
|
|
64
|
-
\fB\-\-session
|
|
64
|
+
\fB\-\-session\fR \fI<SESSION_ID>\fR
|
|
65
65
|
The acting session (recorded as actor.session_id); optional
|
|
66
66
|
.TP
|
|
67
67
|
\fB\-\-detail\fR \fI<TEXT>\fR
|
|
@@ -94,4 +94,4 @@ Print version
|
|
|
94
94
|
<\fISCENARIO_ID\fR>
|
|
95
95
|
The scenario (`<area>.<surface>.<nn>`)
|
|
96
96
|
.SH VERSION
|
|
97
|
-
v0.
|
|
97
|
+
v0.31.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-divergence-defer 1 "defer 0.
|
|
3
|
+
.TH canon-divergence-defer 1 "defer 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-divergence\-defer \- Directly record a deferred divergence (requires \-\-reason/\-\-expiry)
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon divergence defer\fR [\fB\-\-as\fR] [\fB\-\-project
|
|
7
|
+
\fBcanon divergence defer\fR [\fB\-\-as\fR] [\fB\-\-project\fR] [\fB\-\-rev\fR] [\fB\-\-round\fR] <\fB\-\-actor\fR> [\fB\-\-session\fR] <\fB\-\-reason\fR> <\fB\-\-expiry\fR> [\fB\-\-role\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
|
Directly record a deferred divergence (requires \-\-reason/\-\-expiry)
|
|
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
|
|
31
31
|
.TP
|
|
32
32
|
\fB\-\-rev\fR \fI<REV>\fR [default: HEAD]
|
|
@@ -35,10 +35,10 @@ The commit this record is about: any git revision (`HEAD~1`, a branch, a tag, a
|
|
|
35
35
|
\fB\-\-round\fR \fI<N>\fR [default: 1]
|
|
36
36
|
The review round this version belongs to (1\-based)
|
|
37
37
|
.TP
|
|
38
|
-
\fB\-\-actor
|
|
38
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR
|
|
39
39
|
The reviewer recording this (recorded as the divergence\*(Aqs reviewer and actor)
|
|
40
40
|
.TP
|
|
41
|
-
\fB\-\-session
|
|
41
|
+
\fB\-\-session\fR \fI<SESSION_ID>\fR
|
|
42
42
|
The acting session (recorded as actor.session_id); optional
|
|
43
43
|
.TP
|
|
44
44
|
\fB\-\-reason\fR \fI<TEXT>\fR
|
|
@@ -68,4 +68,4 @@ Print version
|
|
|
68
68
|
<\fISCENARIO_ID\fR>
|
|
69
69
|
The scenario (`<area>.<surface>.<nn>`)
|
|
70
70
|
.SH VERSION
|
|
71
|
-
v0.
|
|
71
|
+
v0.31.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-divergence-list 1 "list 0.
|
|
3
|
+
.TH canon-divergence-list 1 "list 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-divergence\-list \- List the current divergence burn\-down state
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -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.31.0
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-divergence-resolve 1 "resolve 0.
|
|
3
|
+
.TH canon-divergence-resolve 1 "resolve 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-divergence\-resolve \- Directly record a resolved divergence
|
|
6
6
|
.SH SYNOPSIS
|
|
7
|
-
\fBcanon divergence resolve\fR [\fB\-\-as\fR] [\fB\-\-project
|
|
7
|
+
\fBcanon divergence resolve\fR [\fB\-\-as\fR] [\fB\-\-project\fR] [\fB\-\-rev\fR] [\fB\-\-round\fR] <\fB\-\-actor\fR> [\fB\-\-session\fR] [\fB\-\-detail\fR] [\fB\-\-role\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
|
Directly record a resolved divergence
|
|
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
|
|
31
31
|
.TP
|
|
32
32
|
\fB\-\-rev\fR \fI<REV>\fR [default: HEAD]
|
|
@@ -35,10 +35,10 @@ The commit this record is about: any git revision (`HEAD~1`, a branch, a tag, a
|
|
|
35
35
|
\fB\-\-round\fR \fI<N>\fR [default: 1]
|
|
36
36
|
The review round this version belongs to (1\-based)
|
|
37
37
|
.TP
|
|
38
|
-
\fB\-\-actor
|
|
38
|
+
\fB\-\-actor\fR \fI<ACTOR_ID>\fR
|
|
39
39
|
The reviewer recording this (recorded as the divergence\*(Aqs reviewer and actor)
|
|
40
40
|
.TP
|
|
41
|
-
\fB\-\-session
|
|
41
|
+
\fB\-\-session\fR \fI<SESSION_ID>\fR
|
|
42
42
|
The acting session (recorded as actor.session_id); optional
|
|
43
43
|
.TP
|
|
44
44
|
\fB\-\-detail\fR \fI<TEXT>\fR
|
|
@@ -65,4 +65,4 @@ Print version
|
|
|
65
65
|
<\fISCENARIO_ID\fR>
|
|
66
66
|
The scenario (`<area>.<surface>.<nn>`)
|
|
67
67
|
.SH VERSION
|
|
68
|
-
v0.
|
|
68
|
+
v0.31.0
|
package/man/canon-divergence.1
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
.ie \n(.g .ds Aq \(aq
|
|
2
2
|
.el .ds Aq '
|
|
3
|
-
.TH canon-divergence 1 "divergence 0.
|
|
3
|
+
.TH canon-divergence 1 "divergence 0.31.0"
|
|
4
4
|
.SH NAME
|
|
5
5
|
canon\-divergence \- Stage, promote, resolve, and inspect spec divergences
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -48,4 +48,4 @@ Accept a divergent scenario as a tracked known gap (a reviewer step): its latest
|
|
|
48
48
|
canon\-divergence\-list(1)
|
|
49
49
|
List the current divergence burn\-down state
|
|
50
50
|
.SH VERSION
|
|
51
|
-
v0.
|
|
51
|
+
v0.31.0
|
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.31.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.31.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.31.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.31.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.31.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.31.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.31.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.31.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.31.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.31.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.31.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.31.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.31.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.31.0
|