@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.
Files changed (133) hide show
  1. package/dist/skills/SKILL.src.md +245 -89
  2. package/dist/skills/reference/brief-align.md +4 -2
  3. package/dist/skills/reference/brief-clarify.md +7 -5
  4. package/dist/skills/reference/brief-harden.md +4 -2
  5. package/dist/skills/reference/brief-polish.md +7 -5
  6. package/dist/skills/reference/brief-shape.md +4 -2
  7. package/dist/skills/reference/canon-artifact-ingest.md +11 -7
  8. package/dist/skills/reference/canon-authoring.md +16 -2
  9. package/dist/skills/reference/canon-context.md +21 -11
  10. package/dist/skills/reference/canon-fmt.md +10 -2
  11. package/dist/skills/reference/canon-gate.md +107 -69
  12. package/dist/skills/reference/canon-inventory.md +23 -15
  13. package/dist/skills/reference/canon-learn.md +23 -19
  14. package/dist/skills/reference/canon-plan-import.md +10 -7
  15. package/dist/skills/reference/canon-plugins.md +15 -8
  16. package/dist/skills/reference/canon-policy.md +20 -16
  17. package/dist/skills/reference/canon-report-dashboard.md +30 -19
  18. package/dist/skills/reference/canon-retrieve.md +13 -10
  19. package/dist/skills/reference/canon-review.md +96 -68
  20. package/dist/skills/reference/canon-session-ingest.md +7 -3
  21. package/dist/skills/reference/canon-storage.md +65 -39
  22. package/dist/skills/reference/canon-subject.md +116 -79
  23. package/dist/skills/reference/canon-vocab.md +1 -1
  24. package/dist/skills/reference/role-implementer.md +295 -64
  25. package/dist/skills/reference/role-orchestrator.md +547 -55
  26. package/dist/skills/reference/role-planner.md +189 -32
  27. package/dist/skills/reference/role-reviewer.md +257 -58
  28. package/dist/skills/scripts/canon-retrieve-pre-dispatch.sh +10 -5
  29. package/man/canon-adapter-authorize.1 +44 -0
  30. package/man/canon-adapter-validate.1 +44 -0
  31. package/man/canon-adapter.1 +46 -0
  32. package/man/canon-artifacts-move.1 +63 -0
  33. package/man/canon-artifacts-store.1 +54 -0
  34. package/man/canon-artifacts-verify.1 +48 -0
  35. package/man/canon-artifacts.1 +45 -0
  36. package/man/canon-brief-approve.1 +62 -0
  37. package/man/canon-brief-check.1 +44 -0
  38. package/man/canon-brief-show.1 +50 -0
  39. package/man/canon-brief.1 +63 -0
  40. package/man/canon-change-new.1 +66 -0
  41. package/man/canon-change.1 +42 -0
  42. package/man/canon-completion.1 +60 -0
  43. package/man/canon-context-pack-add.1 +47 -0
  44. package/man/canon-context-pack-show.1 +44 -0
  45. package/man/canon-context-pack-verify.1 +44 -0
  46. package/man/canon-context-pack.1 +50 -0
  47. package/man/canon-context.1 +44 -0
  48. package/man/canon-dashboard.1 +50 -0
  49. package/man/canon-demo-init.1 +44 -0
  50. package/man/canon-demo-review.1 +44 -0
  51. package/man/canon-demo.1 +47 -0
  52. package/man/canon-dispatch-begin.1 +80 -0
  53. package/man/canon-dispatch-diff.1 +41 -0
  54. package/man/canon-dispatch-end.1 +60 -0
  55. package/man/canon-dispatch.1 +45 -0
  56. package/man/canon-divergence-accept.1 +68 -0
  57. package/man/canon-divergence-add.1 +97 -0
  58. package/man/canon-divergence-defer.1 +71 -0
  59. package/man/canon-divergence-list.1 +56 -0
  60. package/man/canon-divergence-resolve.1 +68 -0
  61. package/man/canon-divergence.1 +51 -0
  62. package/man/canon-evidence-add.1 +168 -0
  63. package/man/canon-evidence-approval-payload.1 +65 -0
  64. package/man/canon-evidence-audit.1 +121 -0
  65. package/man/canon-evidence.1 +57 -0
  66. package/man/canon-export.1 +108 -0
  67. package/man/canon-feature-new.1 +62 -0
  68. package/man/canon-feature.1 +39 -0
  69. package/man/canon-finding-add.1 +196 -0
  70. package/man/canon-finding-close.1 +117 -0
  71. package/man/canon-finding-list.1 +59 -0
  72. package/man/canon-finding.1 +67 -0
  73. package/man/canon-format.1 +49 -0
  74. package/man/canon-gate-check.1 +44 -0
  75. package/man/canon-gate-install-hooks.1 +59 -0
  76. package/man/canon-gate-promote.1 +62 -0
  77. package/man/canon-gate.1 +50 -0
  78. package/man/canon-ingest-plans.1 +53 -0
  79. package/man/canon-ingest-records.1 +56 -0
  80. package/man/canon-ingest-sessions.1 +62 -0
  81. package/man/canon-ingest.1 +50 -0
  82. package/man/canon-init.1 +98 -0
  83. package/man/canon-inventory-sync.1 +50 -0
  84. package/man/canon-inventory.1 +39 -0
  85. package/man/canon-ledger-compact.1 +50 -0
  86. package/man/canon-ledger.1 +54 -0
  87. package/man/canon-migrate.1 +89 -0
  88. package/man/canon-plugin-sync.1 +53 -0
  89. package/man/canon-plugin.1 +39 -0
  90. package/man/canon-policy-approve.1 +50 -0
  91. package/man/canon-policy-show.1 +41 -0
  92. package/man/canon-policy.1 +52 -0
  93. package/man/canon-prompt-add.1 +47 -0
  94. package/man/canon-prompt-show.1 +41 -0
  95. package/man/canon-prompt.1 +43 -0
  96. package/man/canon-purge.1 +70 -0
  97. package/man/canon-query.1 +111 -0
  98. package/man/canon-regime-show.1 +50 -0
  99. package/man/canon-regime.1 +39 -0
  100. package/man/canon-report-build.1 +44 -0
  101. package/man/canon-report-check.1 +41 -0
  102. package/man/canon-report-snapshot.1 +47 -0
  103. package/man/canon-report.1 +45 -0
  104. package/man/canon-retrieve.1 +56 -0
  105. package/man/canon-review-change.1 +98 -0
  106. package/man/canon-review-scenario.1 +98 -0
  107. package/man/canon-review.1 +42 -0
  108. package/man/canon-scenario-new.1 +80 -0
  109. package/man/canon-scenario.1 +39 -0
  110. package/man/canon-schema.1 +63 -0
  111. package/man/canon-selftest.1 +69 -0
  112. package/man/canon-skills-check.1 +47 -0
  113. package/man/canon-skills-doctor.1 +47 -0
  114. package/man/canon-skills-install.1 +53 -0
  115. package/man/canon-skills-show.1 +104 -0
  116. package/man/canon-skills.1 +48 -0
  117. package/man/canon-status.1 +51 -0
  118. package/man/canon-strategy-approval-payload.1 +53 -0
  119. package/man/canon-strategy-promote.1 +59 -0
  120. package/man/canon-strategy-rollback.1 +62 -0
  121. package/man/canon-strategy.1 +45 -0
  122. package/man/canon-subject-adopt.1 +53 -0
  123. package/man/canon-subject-move.1 +80 -0
  124. package/man/canon-subject-new.1 +65 -0
  125. package/man/canon-subject-show.1 +44 -0
  126. package/man/canon-subject-unadopt.1 +63 -0
  127. package/man/canon-subject.1 +51 -0
  128. package/man/canon-task-done.1 +47 -0
  129. package/man/canon-task.1 +42 -0
  130. package/man/canon-tier-age.1 +50 -0
  131. package/man/canon-tier.1 +39 -0
  132. package/man/canon.1 +169 -0
  133. package/package.json +9 -5
@@ -0,0 +1,39 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH canon-tier 1 "tier 0.28.0"
4
+ .SH NAME
5
+ canon\-tier \- Age records between storage tiers
6
+ .SH SYNOPSIS
7
+ \fBcanon tier\fR [\fB\-\-as\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIsubcommands\fR>
8
+ .SH DESCRIPTION
9
+ Age records between storage tiers
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\-tier\-age(1)
37
+ Apply canon.yaml aging rules, moving old records to their destination tier
38
+ .SH VERSION
39
+ v0.28.0
package/man/canon.1 ADDED
@@ -0,0 +1,169 @@
1
+ .ie \n(.g .ds Aq \(aq
2
+ .el .ds Aq '
3
+ .TH canon 1 "canon 0.28.0"
4
+ .SH NAME
5
+ canon \- Specs, evidence gates, and agent memory for your repo
6
+ .SH SYNOPSIS
7
+ \fBcanon\fR [\fB\-\-as\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIsubcommands\fR>
8
+ .SH DESCRIPTION
9
+ canon keeps a repo\*(Aqs specs, review evidence, and agent strategy memory in one place: author .feature specs, task done completion on real evidence, ingest agent sessions, and retrieve role\-scoped guidance.
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 (see a summary with \*(Aq\-h\*(Aq)
31
+ .TP
32
+ \fB\-V\fR, \fB\-\-version\fR
33
+ Print version
34
+ .SH SUBCOMMANDS
35
+ .TP
36
+ canon\-init(1)
37
+ Set up canon in a repo (canon.yaml, a starter policy, the AGENTS.md block, a plans home)
38
+ .TP
39
+ canon\-migrate(1)
40
+ Bring a repo from an earlier canon up to date: the 0.17 layout (specs, changes, approvals, skills, .gitignore), the 0.28 hooks, scripts and skill stub (backed up under .canon/migrate\-backup/), the 0.23 latest\-only ledger (superseded versions to .canon/archive) and 0.23 review pins
41
+ .TP
42
+ canon\-policy(1)
43
+ Record who approved the gate\*(Aqs policy (.canon/policy.yaml) and which bytes
44
+ .TP
45
+ canon\-demo(1)
46
+ Try the evidence loop end\-to\-end in a throwaway demo repo
47
+ .TP
48
+ canon\-status(1)
49
+ Show where this repo stands: subjects by status, their gaps, and the next commands
50
+ .TP
51
+ canon\-context(1)
52
+ Show what you can author here: record kinds, fields, enums, policies
53
+ .TP
54
+ canon\-context\-pack(1)
55
+ Create, inspect, and verify reproducible context packs
56
+ .TP
57
+ canon\-adapter(1)
58
+ Validate a provider\-neutral adapter response without executing a provider
59
+ .TP
60
+ canon\-prompt(1)
61
+ Register and select versioned prompt bundles
62
+ .TP
63
+ canon\-format(1)
64
+ Validate a spec/artifact corpus against canon\*(Aqs format
65
+ .TP
66
+ canon\-feature(1)
67
+ Scaffold a new .feature spec file
68
+ .TP
69
+ canon\-scenario(1)
70
+ Add a tagged scenario to a .feature spec file
71
+ .TP
72
+ canon\-subject(1)
73
+ Create and manage subjects (durable product units)
74
+ .TP
75
+ canon\-change(1)
76
+ Write a plan change (.canon/changes/<slug>/brief.md) and adopt it into a subject
77
+ .TP
78
+ canon\-brief(1)
79
+ Check a change\*(Aqs brief (PRD format) and see the next steps; never edits
80
+ .TP
81
+ canon\-inventory(1)
82
+ Index a validated .feature corpus into the scenario ledger
83
+ .TP
84
+ canon\-gate(1)
85
+ Run evidence gates, promote staged records, install hooks
86
+ .TP
87
+ canon\-task(1)
88
+ Flip a plan task\*(Aqs checkbox once committed evidence supports it
89
+ .TP
90
+ canon\-evidence(1)
91
+ Author a staged, attributed evidence attestation for a plan task
92
+ .TP
93
+ canon\-artifacts(1)
94
+ Check or move the evidence artifact store (local, or an object\-store tier)
95
+ .TP
96
+ canon\-finding(1)
97
+ Record one code\-review finding as a durable record
98
+ .TP
99
+ canon\-review(1)
100
+ Record an attributed review verdict
101
+ .TP
102
+ canon\-divergence(1)
103
+ Stage, promote, resolve, and inspect spec divergences
104
+ .TP
105
+ canon\-ingest(1)
106
+ Import agent sessions, records, and plans into canon\*(Aqs store
107
+ .TP
108
+ canon\-retrieve(1)
109
+ Fetch role\-scoped strategy guidance
110
+ .TP
111
+ canon\-strategy(1)
112
+ Promote a proven strategy into the git\-tracked tier
113
+ .TP
114
+ canon\-dispatch(1)
115
+ Begin an agent run with retrieved guidance recorded
116
+ .TP
117
+ canon\-regime(1)
118
+ Build a canonical regime key for hook scripts
119
+ .TP
120
+ canon\-query(1)
121
+ Read stored records across every storage tier
122
+ .TP
123
+ canon\-export(1)
124
+ Export a redacted retention manifest without deleting records
125
+ .TP
126
+ canon\-purge(1)
127
+ Remove allowlisted records older than a cutoff: the bare run previews the removal set and its planDigest, `\-\-commit \-\-plan\-digest <DIGEST>` deletes it
128
+ .TP
129
+ canon\-report(1)
130
+ Build, check, or snapshot the status report
131
+ .TP
132
+ canon\-dashboard(1)
133
+ Serve the local status dashboard
134
+ .TP
135
+ canon\-plugin(1)
136
+ Sync plugin overlay records onto the ledger
137
+ .TP
138
+ canon\-skills(1)
139
+ Install canon\*(Aqs agent guides into a repo
140
+ .TP
141
+ canon\-tier(1)
142
+ Age records between storage tiers
143
+ .TP
144
+ canon\-ledger(1)
145
+ Keep the ledger to the current version of each record
146
+ .TP
147
+ canon\-selftest(1)
148
+ Run canon\*(Aqs built\-in fixture self\-tests
149
+ .TP
150
+ canon\-schema(1)
151
+ Describe canon\*(Aqs own commands: list them, or show one command\*(Aqs arguments, options, effect and exit codes
152
+ .TP
153
+ canon\-completion(1)
154
+ Write the shell completion script for canon (bash, zsh or fish)
155
+ .SH EXTRA
156
+ Examples:
157
+ canon init Set up canon in the current repo
158
+ canon demo init Scaffold a throwaway demo repo to try the evidence loop
159
+ canon format spec Validate a spec corpus
160
+ canon gate check Run the evidence gate
161
+
162
+ Learn more:
163
+ Use `canon <command> \-\-help` for details on any command.
164
+ `canon skills show canon` prints the guide built into this binary;
165
+ `canon skills install` writes a short stub of it per selected provider,
166
+ plus the script sidecar; `skills check` and `skills doctor` inspect the
167
+ target without deleting user files.
168
+ .SH VERSION
169
+ v0.28.0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@journeykit/canon",
3
- "version": "0.27.0",
3
+ "version": "0.28.0",
4
4
  "description": "canon — harness knowledge substrate. JS launcher: platform detection + native binary resolution.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -10,8 +10,12 @@
10
10
  },
11
11
  "files": [
12
12
  "bin.js",
13
- "dist/**/*"
13
+ "dist/**/*",
14
+ "man"
14
15
  ],
16
+ "directories": {
17
+ "man": "./man"
18
+ },
15
19
  "publishConfig": {
16
20
  "registry": "https://registry.npmjs.org/",
17
21
  "access": "public"
@@ -30,9 +34,9 @@
30
34
  },
31
35
  "dependencies": {},
32
36
  "optionalDependencies": {
33
- "@journeykit/canon-core-darwin-arm64": "0.27.0",
34
- "@journeykit/canon-core-linux-x64": "0.27.0",
35
- "@journeykit/canon-core-win32-x64": "0.27.0"
37
+ "@journeykit/canon-core-darwin-arm64": "0.28.0",
38
+ "@journeykit/canon-core-linux-x64": "0.28.0",
39
+ "@journeykit/canon-core-win32-x64": "0.28.0"
36
40
  },
37
41
  "devDependencies": {
38
42
  "@types/node": "^20.0.0",