@journeykit/canon 0.27.0 → 0.28.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 +245 -89
- package/dist/skills/reference/brief-align.md +4 -2
- package/dist/skills/reference/brief-clarify.md +7 -5
- package/dist/skills/reference/brief-harden.md +4 -2
- package/dist/skills/reference/brief-polish.md +7 -5
- package/dist/skills/reference/brief-shape.md +4 -2
- package/dist/skills/reference/canon-artifact-ingest.md +11 -7
- package/dist/skills/reference/canon-authoring.md +16 -2
- package/dist/skills/reference/canon-context.md +21 -11
- package/dist/skills/reference/canon-fmt.md +10 -2
- package/dist/skills/reference/canon-gate.md +107 -69
- package/dist/skills/reference/canon-inventory.md +23 -15
- package/dist/skills/reference/canon-learn.md +23 -19
- package/dist/skills/reference/canon-plan-import.md +10 -7
- package/dist/skills/reference/canon-plugins.md +15 -8
- package/dist/skills/reference/canon-policy.md +20 -16
- package/dist/skills/reference/canon-report-dashboard.md +30 -19
- package/dist/skills/reference/canon-retrieve.md +13 -10
- package/dist/skills/reference/canon-review.md +96 -68
- package/dist/skills/reference/canon-session-ingest.md +7 -3
- package/dist/skills/reference/canon-storage.md +65 -39
- package/dist/skills/reference/canon-subject.md +116 -79
- package/dist/skills/reference/canon-vocab.md +1 -1
- package/dist/skills/reference/role-implementer.md +295 -64
- package/dist/skills/reference/role-orchestrator.md +547 -55
- package/dist/skills/reference/role-planner.md +189 -32
- package/dist/skills/reference/role-reviewer.md +257 -58
- package/dist/skills/scripts/canon-retrieve-pre-dispatch.sh +10 -5
- package/man/canon-adapter-authorize.1 +44 -0
- package/man/canon-adapter-validate.1 +44 -0
- package/man/canon-adapter.1 +46 -0
- package/man/canon-artifacts-move.1 +63 -0
- package/man/canon-artifacts-store.1 +54 -0
- package/man/canon-artifacts-verify.1 +48 -0
- package/man/canon-artifacts.1 +45 -0
- package/man/canon-brief-approve.1 +62 -0
- package/man/canon-brief-check.1 +44 -0
- package/man/canon-brief-show.1 +50 -0
- package/man/canon-brief.1 +63 -0
- package/man/canon-change-new.1 +66 -0
- package/man/canon-change.1 +42 -0
- package/man/canon-completion.1 +60 -0
- package/man/canon-context-pack-add.1 +47 -0
- package/man/canon-context-pack-show.1 +44 -0
- package/man/canon-context-pack-verify.1 +44 -0
- package/man/canon-context-pack.1 +50 -0
- package/man/canon-context.1 +44 -0
- package/man/canon-dashboard.1 +50 -0
- package/man/canon-demo-init.1 +44 -0
- package/man/canon-demo-review.1 +44 -0
- package/man/canon-demo.1 +47 -0
- package/man/canon-dispatch-begin.1 +80 -0
- package/man/canon-dispatch-diff.1 +41 -0
- package/man/canon-dispatch-end.1 +60 -0
- package/man/canon-dispatch.1 +45 -0
- package/man/canon-divergence-accept.1 +68 -0
- package/man/canon-divergence-add.1 +97 -0
- package/man/canon-divergence-defer.1 +71 -0
- package/man/canon-divergence-list.1 +56 -0
- package/man/canon-divergence-resolve.1 +68 -0
- package/man/canon-divergence.1 +51 -0
- package/man/canon-evidence-add.1 +168 -0
- package/man/canon-evidence-approval-payload.1 +65 -0
- package/man/canon-evidence-audit.1 +121 -0
- package/man/canon-evidence.1 +57 -0
- package/man/canon-export.1 +108 -0
- package/man/canon-feature-new.1 +62 -0
- package/man/canon-feature.1 +39 -0
- package/man/canon-finding-add.1 +196 -0
- package/man/canon-finding-close.1 +117 -0
- package/man/canon-finding-list.1 +59 -0
- package/man/canon-finding.1 +67 -0
- package/man/canon-format.1 +49 -0
- package/man/canon-gate-check.1 +44 -0
- package/man/canon-gate-install-hooks.1 +59 -0
- package/man/canon-gate-promote.1 +62 -0
- package/man/canon-gate.1 +50 -0
- package/man/canon-ingest-plans.1 +53 -0
- package/man/canon-ingest-records.1 +56 -0
- package/man/canon-ingest-sessions.1 +62 -0
- package/man/canon-ingest.1 +50 -0
- package/man/canon-init.1 +98 -0
- package/man/canon-inventory-sync.1 +50 -0
- package/man/canon-inventory.1 +39 -0
- package/man/canon-ledger-compact.1 +50 -0
- package/man/canon-ledger.1 +54 -0
- package/man/canon-migrate.1 +89 -0
- package/man/canon-plugin-sync.1 +53 -0
- package/man/canon-plugin.1 +39 -0
- package/man/canon-policy-approve.1 +50 -0
- package/man/canon-policy-show.1 +41 -0
- package/man/canon-policy.1 +52 -0
- package/man/canon-prompt-add.1 +47 -0
- package/man/canon-prompt-show.1 +41 -0
- package/man/canon-prompt.1 +43 -0
- package/man/canon-purge.1 +70 -0
- package/man/canon-query.1 +111 -0
- package/man/canon-regime-show.1 +50 -0
- package/man/canon-regime.1 +39 -0
- package/man/canon-report-build.1 +44 -0
- package/man/canon-report-check.1 +41 -0
- package/man/canon-report-snapshot.1 +47 -0
- package/man/canon-report.1 +45 -0
- package/man/canon-retrieve.1 +56 -0
- package/man/canon-review-change.1 +98 -0
- package/man/canon-review-scenario.1 +98 -0
- package/man/canon-review.1 +42 -0
- package/man/canon-scenario-new.1 +80 -0
- package/man/canon-scenario.1 +39 -0
- package/man/canon-schema.1 +63 -0
- package/man/canon-selftest.1 +69 -0
- package/man/canon-skills-check.1 +47 -0
- package/man/canon-skills-doctor.1 +47 -0
- package/man/canon-skills-install.1 +53 -0
- package/man/canon-skills-show.1 +104 -0
- package/man/canon-skills.1 +48 -0
- package/man/canon-status.1 +51 -0
- package/man/canon-strategy-approval-payload.1 +53 -0
- package/man/canon-strategy-promote.1 +59 -0
- package/man/canon-strategy-rollback.1 +62 -0
- package/man/canon-strategy.1 +45 -0
- package/man/canon-subject-adopt.1 +53 -0
- package/man/canon-subject-move.1 +80 -0
- package/man/canon-subject-new.1 +65 -0
- package/man/canon-subject-show.1 +44 -0
- package/man/canon-subject-unadopt.1 +63 -0
- package/man/canon-subject.1 +51 -0
- package/man/canon-task-done.1 +47 -0
- package/man/canon-task.1 +42 -0
- package/man/canon-tier-age.1 +50 -0
- package/man/canon-tier.1 +39 -0
- package/man/canon.1 +169 -0
- package/package.json +9 -5
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-context-pack 1 "context-pack 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-context\-pack \- Create, inspect, and verify reproducible context packs
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon context\-pack\fR [\fB\-\-as\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIsubcommands\fR>
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Create, inspect, and verify reproducible context packs
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
30
|
+
Print help
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
33
|
+
Print version
|
|
34
|
+
.SH SUBCOMMANDS
|
|
35
|
+
.TP
|
|
36
|
+
canon\-context\-pack\-add(1)
|
|
37
|
+
Create an immutable context pack from a repository\-local JSON manifest
|
|
38
|
+
.TP
|
|
39
|
+
canon\-context\-pack\-show(1)
|
|
40
|
+
Show a context pack after verifying its manifest and content objects
|
|
41
|
+
.TP
|
|
42
|
+
canon\-context\-pack\-verify(1)
|
|
43
|
+
Verify a context pack\*(Aqs manifest and immutable content objects
|
|
44
|
+
.SH EXTRA
|
|
45
|
+
Examples:
|
|
46
|
+
canon context\-pack add \-\-manifest .canon/context\-manifest.json
|
|
47
|
+
canon context\-pack show sha256:<pack\-digest> \-\-repo . \-\-json
|
|
48
|
+
canon context\-pack verify sha256:<pack\-digest>
|
|
49
|
+
.SH VERSION
|
|
50
|
+
v0.28.0
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-context 1 "context 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-context \- Show what you can author here: record kinds, fields, enums, policies
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon context\fR [\fB\-\-as\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-fields\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Show what you can author here: record kinds, fields, enums, policies
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-repo\fR \fI<DIR>\fR
|
|
30
|
+
The repo to act on (default: the nearest ancestor directory holding a canon.yaml)
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-json\fR
|
|
33
|
+
Output JSON instead of the human\-readable form
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-fields\fR \fI<FIELDS>\fR
|
|
36
|
+
With \-\-json, keep only these top\-level surface sections (comma\-separated); an unknown field is refused (camelCase and snake_case both match)
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
39
|
+
Print help
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
42
|
+
Print version
|
|
43
|
+
.SH VERSION
|
|
44
|
+
v0.28.0
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-dashboard 1 "dashboard 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-dashboard \- Serve the local status dashboard
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon dashboard\fR [\fB\-\-as\fR] [\fB\-\-repo\fR] [\fB\-\-snapshot\fR] [\fB\-\-port\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Serve the local status dashboard
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-repo\fR \fI<DIR>\fR
|
|
30
|
+
The repo to act on (default: the nearest ancestor directory holding a canon.yaml)
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-snapshot\fR \fI<DIR>\fR
|
|
33
|
+
Snapshot dir to serve (default: regenerated fresh each run)
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-port\fR \fI<N>\fR [default: 4173]
|
|
36
|
+
Local port to bind (0 = OS\-assigned free port)
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-json\fR
|
|
39
|
+
Print one JSON document naming the address it serves (`data.url`), then serve until stopped; the human lines go to stderr
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-input\fR \fI<JSON|FILE|\->\fR
|
|
42
|
+
The arguments as JSON: an object (one run) or an array / NDJSON file or `\-` (a batch); keys are the option names in camelCase, `operands` an array
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
45
|
+
Print help
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
48
|
+
Print version
|
|
49
|
+
.SH VERSION
|
|
50
|
+
v0.28.0
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-demo-init 1 "init 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-demo\-init \- Scaffold the demo repo (gate starts RED)
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon demo init\fR [\fB\-\-as\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Scaffold the demo repo (gate starts RED)
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-repo\fR \fI<DIR>\fR [default: .]
|
|
30
|
+
Directory to set up (used as\-is)
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-json\fR
|
|
33
|
+
Output JSON instead of the human\-readable form
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-input\fR \fI<JSON|FILE|\->\fR
|
|
36
|
+
The arguments as JSON: an object (one run) or an array / NDJSON file or `\-` (a batch); keys are the option names in camelCase, `operands` an array
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
39
|
+
Print help
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
42
|
+
Print version
|
|
43
|
+
.SH VERSION
|
|
44
|
+
v0.28.0
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-demo-review 1 "review 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-demo\-review \- Record the missing reviewer evidence (gate turns GREEN)
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon demo review\fR [\fB\-\-as\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Record the missing reviewer evidence (gate turns GREEN)
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-repo\fR \fI<DIR>\fR
|
|
30
|
+
The repo to act on (default: the nearest ancestor directory holding a canon.yaml)
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-json\fR
|
|
33
|
+
Output JSON instead of the human\-readable form
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-input\fR \fI<JSON|FILE|\->\fR
|
|
36
|
+
The arguments as JSON: an object (one run) or an array / NDJSON file or `\-` (a batch); keys are the option names in camelCase, `operands` an array
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
39
|
+
Print help
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
42
|
+
Print version
|
|
43
|
+
.SH VERSION
|
|
44
|
+
v0.28.0
|
package/man/canon-demo.1
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-demo 1 "demo 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-demo \- Try the evidence loop end\-to\-end in a throwaway demo repo
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon demo\fR [\fB\-\-as\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIsubcommands\fR>
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Try the evidence loop end\-to\-end in a throwaway demo repo
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
30
|
+
Print help
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
33
|
+
Print version
|
|
34
|
+
.SH SUBCOMMANDS
|
|
35
|
+
.TP
|
|
36
|
+
canon\-demo\-init(1)
|
|
37
|
+
Scaffold the demo repo (gate starts RED)
|
|
38
|
+
.TP
|
|
39
|
+
canon\-demo\-review(1)
|
|
40
|
+
Record the missing reviewer evidence (gate turns GREEN)
|
|
41
|
+
.SH EXTRA
|
|
42
|
+
Examples:
|
|
43
|
+
canon demo init \-\-repo /tmp/canon\-demo && cd /tmp/canon\-demo
|
|
44
|
+
canon gate check # RED
|
|
45
|
+
canon demo review && canon gate check # GREEN
|
|
46
|
+
.SH VERSION
|
|
47
|
+
v0.28.0
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-dispatch-begin 1 "begin 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-dispatch\-begin \- Mint a Run manifest with retrieved guidance and context/policy lineage
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon dispatch begin\fR [\fB\-\-as\fR] [\fB\-\-role\fR] <\fB\-\-regime\fR> [\fB\-\-actor\-id\fR] [\fB\-\-session\-id\fR] [\fB\-\-provider\fR] [\fB\-\-model\fR] [\fB\-\-skill\-id\fR] [\fB\-\-skill\-digest\fR] [\fB\-\-manifest\fR] [\fB\-\-prompt\-bundle\fR] [\fB\-\-task\-id\fR] [\fB\-\-parent\-run\-id\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Mint a Run manifest with retrieved guidance and context/policy lineage
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-role\fR \fI<ROLE>\fR
|
|
30
|
+
Role about to run; must equal \-\-regime\*(Aqs leading segment
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-regime\fR \fI<KEY>\fR
|
|
33
|
+
Full regime key (<role>/<repo>/<area>/<hash>) to retrieve guidance for
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-actor\-id\fR \fI<ACTOR_ID>\fR [default: canon]
|
|
36
|
+
The dispatching agent\*(Aqs id (recorded as the run\*(Aqs actor)
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-session\-id\fR \fI<SESSION_ID>\fR
|
|
39
|
+
The acting session (recorded as actor.session_id); optional
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-provider\fR \fI<NAME>\fR
|
|
42
|
+
Declared provider metadata (copied verbatim; never inferred from \-\-actor\-id)
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-\-model\fR \fI<NAME>\fR
|
|
45
|
+
Declared model metadata (copied verbatim)
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-skill\-id\fR \fI<ID>\fR
|
|
48
|
+
Skill that contributed to this run
|
|
49
|
+
.TP
|
|
50
|
+
\fB\-\-skill\-digest\fR \fI<DIGEST>\fR
|
|
51
|
+
Declared skill digest; requires \-\-skill\-id
|
|
52
|
+
.TP
|
|
53
|
+
\fB\-\-manifest\fR \fI<FILE>\fR
|
|
54
|
+
Explicit repository\-relative ContextPack input manifest
|
|
55
|
+
.TP
|
|
56
|
+
\fB\-\-prompt\-bundle\fR \fI<NAME@VERSION>\fR
|
|
57
|
+
Registered prompt bundle to select (`name@version`)
|
|
58
|
+
.TP
|
|
59
|
+
\fB\-\-task\-id\fR \fI<TASK_ID>\fR
|
|
60
|
+
Plan task this run serves (<change_id>#<n>); validated against the plan corpus
|
|
61
|
+
.TP
|
|
62
|
+
\fB\-\-parent\-run\-id\fR \fI<RUN_ID>\fR
|
|
63
|
+
RunId (ULID) of the run that dispatched this one
|
|
64
|
+
.TP
|
|
65
|
+
\fB\-\-repo\fR \fI<DIR>\fR
|
|
66
|
+
The repo to act on (default: the nearest ancestor directory holding a canon.yaml)
|
|
67
|
+
.TP
|
|
68
|
+
\fB\-\-json\fR
|
|
69
|
+
Output JSON instead of the human\-readable form
|
|
70
|
+
.TP
|
|
71
|
+
\fB\-\-input\fR \fI<JSON|FILE|\->\fR
|
|
72
|
+
The arguments as JSON: an object (one run) or an array / NDJSON file or `\-` (a batch); keys are the option names in camelCase, `operands` an array
|
|
73
|
+
.TP
|
|
74
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
75
|
+
Print help
|
|
76
|
+
.TP
|
|
77
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
78
|
+
Print version
|
|
79
|
+
.SH VERSION
|
|
80
|
+
v0.28.0
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-dispatch-diff 1 "diff 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-dispatch\-diff \- Diff the declared plan DAG against the observed execution graph
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon dispatch diff\fR [\fB\-\-as\fR] [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Diff the declared plan DAG against the observed execution graph
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-repo\fR \fI<DIR>\fR
|
|
30
|
+
The repo to act on (default: the nearest ancestor directory holding a canon.yaml)
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-json\fR
|
|
33
|
+
Output JSON instead of the human\-readable form
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
36
|
+
Print help
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
39
|
+
Print version
|
|
40
|
+
.SH VERSION
|
|
41
|
+
v0.28.0
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-dispatch-end 1 "end 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-dispatch\-end \- Close a dispatched run with a terminal status and an ended_at
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon dispatch end\fR [\fB\-\-as\fR] <\fB\-\-run\-outcome\fR> [\fB\-\-repo\fR] [\fB\-\-json\fR] [\fB\-\-input\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIRUN_ID\fR>
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Close a dispatched run with a terminal status and an ended_at
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-run\-outcome\fR \fI<RUN_OUTCOME>\fR
|
|
30
|
+
Terminal outcome: succeeded or failed
|
|
31
|
+
.br
|
|
32
|
+
|
|
33
|
+
.br
|
|
34
|
+
\fIPossible values:\fR
|
|
35
|
+
.RS 14
|
|
36
|
+
.IP \(bu 2
|
|
37
|
+
succeeded
|
|
38
|
+
.IP \(bu 2
|
|
39
|
+
failed
|
|
40
|
+
.RE
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-repo\fR \fI<DIR>\fR
|
|
43
|
+
The repo to act on (default: the nearest ancestor directory holding a canon.yaml)
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-json\fR
|
|
46
|
+
Output JSON instead of the human\-readable form
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-input\fR \fI<JSON|FILE|\->\fR
|
|
49
|
+
The arguments as JSON: an object (one run) or an array / NDJSON file or `\-` (a batch); keys are the option names in camelCase, `operands` an array
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
52
|
+
Print help
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
55
|
+
Print version
|
|
56
|
+
.TP
|
|
57
|
+
<\fIRUN_ID\fR>
|
|
58
|
+
The RunId (ULID) minted by `canon dispatch begin`
|
|
59
|
+
.SH VERSION
|
|
60
|
+
v0.28.0
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-dispatch 1 "dispatch 0.28.0"
|
|
4
|
+
.SH NAME
|
|
5
|
+
canon\-dispatch \- Begin an agent run with retrieved guidance recorded
|
|
6
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon dispatch\fR [\fB\-\-as\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIsubcommands\fR>
|
|
8
|
+
.SH DESCRIPTION
|
|
9
|
+
Begin an agent run with retrieved guidance recorded
|
|
10
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
30
|
+
Print help
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
33
|
+
Print version
|
|
34
|
+
.SH SUBCOMMANDS
|
|
35
|
+
.TP
|
|
36
|
+
canon\-dispatch\-begin(1)
|
|
37
|
+
Mint a Run manifest with retrieved guidance and context/policy lineage
|
|
38
|
+
.TP
|
|
39
|
+
canon\-dispatch\-end(1)
|
|
40
|
+
Close a dispatched run with a terminal status and an ended_at
|
|
41
|
+
.TP
|
|
42
|
+
canon\-dispatch\-diff(1)
|
|
43
|
+
Diff the declared plan DAG against the observed execution graph
|
|
44
|
+
.SH VERSION
|
|
45
|
+
v0.28.0
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-divergence-accept 1 "accept 0.28.0"
|
|
4
|
+
.SH NAME
|
|
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
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon divergence accept\fR [\fB\-\-as\fR] [\fB\-\-project\-id\fR] <\fB\-\-reason\fR> <\fB\-\-tracking\fR> [\fB\-\-expiry\fR] <\fB\-\-actor\-id\fR> [\fB\-\-role\fR] [\fB\-\-session\-id\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
|
+
.SH DESCRIPTION
|
|
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
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-project\-id\fR \fI<PROJECT_ID>\fR
|
|
30
|
+
Spec corpus id of the scenarios. Required only when canon.yaml configures more than one spec root
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-reason\fR \fI<TEXT>\fR
|
|
33
|
+
Why the gap is accepted
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-tracking\fR \fI<TEXT>\fR
|
|
36
|
+
Where the gap is tracked: an issue URL or reference
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-expiry\fR \fI<TIMESTAMP>\fR
|
|
39
|
+
The date (YYYY\-MM\-DD, UTC) the acceptance stops holding; none means it holds until new evidence
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-actor\-id\fR \fI<ACTOR_ID>\fR
|
|
42
|
+
The reviewer recording this (recorded as the divergence\*(Aqs reviewer and actor)
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-\-role\fR \fI<ROLE>\fR
|
|
45
|
+
Must be reviewer (default: the declared role, \-\-as / CANON_ROLE; required when none is declared)
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-session\-id\fR \fI<SESSION_ID>\fR
|
|
48
|
+
The accepting session (recorded as actor.session_id); it must not be one that attested the scenario\*(Aqs evidence
|
|
49
|
+
.TP
|
|
50
|
+
\fB\-\-repo\fR \fI<DIR>\fR
|
|
51
|
+
The repo to act on (default: the nearest ancestor directory holding a canon.yaml)
|
|
52
|
+
.TP
|
|
53
|
+
\fB\-\-json\fR
|
|
54
|
+
Output JSON instead of the human\-readable form
|
|
55
|
+
.TP
|
|
56
|
+
\fB\-\-input\fR \fI<JSON|FILE|\->\fR
|
|
57
|
+
The arguments as JSON: an object (one run) or an array / NDJSON file or `\-` (a batch); keys are the option names in camelCase, `operands` an array
|
|
58
|
+
.TP
|
|
59
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
60
|
+
Print help
|
|
61
|
+
.TP
|
|
62
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
63
|
+
Print version
|
|
64
|
+
.TP
|
|
65
|
+
<\fISCENARIO_ID\fR>
|
|
66
|
+
The accepted scenarios (`<area>.<surface>.<nn>`), one acceptance each, all or nothing
|
|
67
|
+
.SH VERSION
|
|
68
|
+
v0.28.0
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
.ie \n(.g .ds Aq \(aq
|
|
2
|
+
.el .ds Aq '
|
|
3
|
+
.TH canon-divergence-add 1 "add 0.28.0"
|
|
4
|
+
.SH NAME
|
|
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
|
+
.SH SYNOPSIS
|
|
7
|
+
\fBcanon divergence add\fR [\fB\-\-as\fR] [\fB\-\-project\-id\fR] [\fB\-\-rev\fR] [\fB\-\-state\fR] [\fB\-\-reason\fR] [\fB\-\-expiry\fR] [\fB\-\-round\fR] <\fB\-\-actor\-id\fR> [\fB\-\-session\-id\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
|
+
.SH DESCRIPTION
|
|
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
|
+
.SH OPTIONS
|
|
11
|
+
.TP
|
|
12
|
+
\fB\-\-as\fR \fI<ROLE>\fR
|
|
13
|
+
The role you act as: planner, implementer, reviewer or orchestrator. Overrides `CANON_ROLE`. `schema` and `context` list only the role\*(Aqs commands, `status` keeps its steps, and `\-\-role` on `evidence add` / `evidence audit` / `review scenario` / `review change` defaults to it
|
|
14
|
+
.br
|
|
15
|
+
|
|
16
|
+
.br
|
|
17
|
+
\fIPossible values:\fR
|
|
18
|
+
.RS 14
|
|
19
|
+
.IP \(bu 2
|
|
20
|
+
planner
|
|
21
|
+
.IP \(bu 2
|
|
22
|
+
implementer
|
|
23
|
+
.IP \(bu 2
|
|
24
|
+
reviewer
|
|
25
|
+
.IP \(bu 2
|
|
26
|
+
orchestrator
|
|
27
|
+
.RE
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-project\-id\fR \fI<PROJECT_ID>\fR
|
|
30
|
+
Spec corpus id of the scenario. Required only when canon.yaml configures more than one spec root
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-rev\fR \fI<REV>\fR [default: HEAD]
|
|
33
|
+
The commit this record is about: any git revision (`HEAD~1`, a branch, a tag, a short sha); the full sha is recorded with the code tree it saw. The default HEAD records the working tree as it stands (uncommitted code included), and a commit made from it has the same code tree. Outside git, or with no commit, the command refuses (NO_COMMIT)
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-state\fR \fI<STATE>\fR [default: open]
|
|
36
|
+
The divergence state to record (deferred needs \-\-reason and \-\-expiry)
|
|
37
|
+
.br
|
|
38
|
+
|
|
39
|
+
.br
|
|
40
|
+
\fIPossible values:\fR
|
|
41
|
+
.RS 14
|
|
42
|
+
.IP \(bu 2
|
|
43
|
+
open
|
|
44
|
+
.IP \(bu 2
|
|
45
|
+
still\-divergent
|
|
46
|
+
.IP \(bu 2
|
|
47
|
+
resolved
|
|
48
|
+
.IP \(bu 2
|
|
49
|
+
deferred
|
|
50
|
+
.RE
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-reason\fR \fI<TEXT>\fR
|
|
53
|
+
Why the divergence is recorded; required with `\-\-state deferred`
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-expiry\fR \fI<TIMESTAMP>\fR
|
|
56
|
+
When a deferral lapses (RFC3339 or YYYY\-MM\-DD, UTC); required with `\-\-state deferred`
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-round\fR \fI<N>\fR [default: 1]
|
|
59
|
+
The review round this version belongs to (1\-based)
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-actor\-id\fR \fI<ACTOR_ID>\fR
|
|
62
|
+
The reviewer recording this (recorded as the divergence\*(Aqs reviewer and actor)
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-session\-id\fR \fI<SESSION_ID>\fR
|
|
65
|
+
The acting session (recorded as actor.session_id); optional
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-\-detail\fR \fI<TEXT>\fR
|
|
68
|
+
Free\-text detail recorded on the version (optional)
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-role\fR \fI<ROLE>\fR
|
|
71
|
+
The role this record is attributed to (default: the role declared with \-\-as / CANON_ROLE)
|
|
72
|
+
.TP
|
|
73
|
+
\fB\-\-promote\fR
|
|
74
|
+
Promote the record this run staged, in the same run; records others staged stay staged (the default under canon.yaml `write: { promote: auto }`)
|
|
75
|
+
.TP
|
|
76
|
+
\fB\-\-no\-promote\fR
|
|
77
|
+
Keep this write staged even under canon.yaml `write: { promote: auto }`
|
|
78
|
+
.TP
|
|
79
|
+
\fB\-\-repo\fR \fI<DIR>\fR
|
|
80
|
+
The repo to act on (default: the nearest ancestor directory holding a canon.yaml)
|
|
81
|
+
.TP
|
|
82
|
+
\fB\-\-json\fR
|
|
83
|
+
Output JSON instead of the human\-readable form
|
|
84
|
+
.TP
|
|
85
|
+
\fB\-\-input\fR \fI<JSON|FILE|\->\fR
|
|
86
|
+
The arguments as JSON: an object (one run) or an array / NDJSON file or `\-` (a batch); keys are the option names in camelCase, `operands` an array
|
|
87
|
+
.TP
|
|
88
|
+
\fB\-h\fR, \fB\-\-help\fR
|
|
89
|
+
Print help
|
|
90
|
+
.TP
|
|
91
|
+
\fB\-V\fR, \fB\-\-version\fR
|
|
92
|
+
Print version
|
|
93
|
+
.TP
|
|
94
|
+
<\fISCENARIO_ID\fR>
|
|
95
|
+
The scenario (`<area>.<surface>.<nn>`)
|
|
96
|
+
.SH VERSION
|
|
97
|
+
v0.28.0
|