@agent-ix/quoin 0.2.1 → 0.3.6
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/.claude-plugin/marketplace.json +16 -0
- package/{plugin.json → .claude-plugin/plugin.json} +3 -1
- package/README.md +19 -8
- package/dist/{cli-ClS52_Fm.js → cli-CNlT2O2s.js} +56 -50
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +4 -4
- package/skills/spec-object-review/references/object-type-guide.md +5 -0
- package/skills/specify/SKILL.md +86 -33
- package/skills/specify/references/integration-tests.md +72 -0
- package/skills/specify/references/us-to-fr.md +40 -0
- package/skills/spec-matrix/workflow-assets/dist/index.d.ts +0 -146
- package/skills/spec-matrix/workflow-assets/dist/index.d.ts.map +0 -1
- package/skills/spec-matrix/workflow-assets/dist/index.js +0 -7655
- package/skills/spec-matrix/workflow-assets/dist/invariants.d.ts +0 -6
- package/skills/spec-matrix/workflow-assets/dist/invariants.d.ts.map +0 -1
- package/skills/spec-review/workflow-assets/dist/index.d.ts +0 -146
- package/skills/spec-review/workflow-assets/dist/index.d.ts.map +0 -1
- package/skills/spec-review/workflow-assets/dist/index.js +0 -7655
- package/skills/spec-review/workflow-assets/dist/invariants.d.ts +0 -6
- package/skills/spec-review/workflow-assets/dist/invariants.d.ts.map +0 -1
- package/skills/spec-to-plan/workflow-assets/dist/index.d.ts +0 -146
- package/skills/spec-to-plan/workflow-assets/dist/index.d.ts.map +0 -1
- package/skills/spec-to-plan/workflow-assets/dist/index.js +0 -7655
- package/skills/spec-to-plan/workflow-assets/dist/invariants.d.ts +0 -6
- package/skills/spec-to-plan/workflow-assets/dist/invariants.d.ts.map +0 -1
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "quoin",
|
|
3
|
+
"owner": {
|
|
4
|
+
"name": "Agent IX"
|
|
5
|
+
},
|
|
6
|
+
"metadata": {
|
|
7
|
+
"description": "Spec authoring, review, matrix, and planning skills + workflows for Agent IX."
|
|
8
|
+
},
|
|
9
|
+
"plugins": [
|
|
10
|
+
{
|
|
11
|
+
"name": "quoin",
|
|
12
|
+
"source": "./",
|
|
13
|
+
"description": "Spec authoring, review, matrix, and planning skills for Agent IX."
|
|
14
|
+
}
|
|
15
|
+
]
|
|
16
|
+
}
|
package/README.md
CHANGED
|
@@ -10,15 +10,13 @@
|
|
|
10
10
|
|
|
11
11
|
`quoin` is a bundle of **Quire modules**, **agent skills**, and **workflows** for
|
|
12
12
|
authoring [ISO/IEC/IEEE 29148](https://www.iso.org/standard/72089.html)-aligned software specifications and other technical
|
|
13
|
-
documents. It
|
|
14
|
-
|
|
13
|
+
documents. It includes prepackaged modules for the spec vocabulary and ideation/authoring/review/planning
|
|
14
|
+
workflows agents need to write and validate specs directly as Markdown.
|
|
15
15
|
|
|
16
16
|
`quoin` is built on the [Quire](https://github.com/agent-ix/quire-rs) document standard and validation engine by Agent-IX.
|
|
17
17
|
|
|
18
18
|
## What's included
|
|
19
19
|
|
|
20
|
-
### Quire modules
|
|
21
|
-
|
|
22
20
|
The default module set defines the spec archetypes and domain-object vocabulary.
|
|
23
21
|
|
|
24
22
|
**Artifact archetypes** — the document types you author:
|
|
@@ -29,7 +27,7 @@ The default module set defines the spec archetypes and domain-object vocabulary.
|
|
|
29
27
|
| [spec-artifacts-app](https://github.com/agent-ix/spec-artifacts-app) | `ApplicationSpec`, `MasterRequirements` |
|
|
30
28
|
| [spec-artifacts-process](https://github.com/agent-ix/spec-artifacts-process) | `ADR`, `Plan`, `Task`, `Review`, `Finding`, `TestMatrix`, `Standard` |
|
|
31
29
|
|
|
32
|
-
**Domain objects** —
|
|
30
|
+
**Domain objects** — prefab templates for common objects
|
|
33
31
|
|
|
34
32
|
| Module | Objects |
|
|
35
33
|
| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -66,13 +64,26 @@ Multi-agent workflows that fan out, run lenses in parallel, and synthesize resul
|
|
|
66
64
|
|
|
67
65
|
## Install
|
|
68
66
|
|
|
69
|
-
|
|
70
|
-
|
|
67
|
+
Installing quoin into Claude is **two steps**: the CLI (from public npm) and the plugin
|
|
68
|
+
that adds the [skills](#skills) and [workflows](#workflows) to Claude Code. No Anthropic API
|
|
69
|
+
key is required — your Claude subscription is used.
|
|
70
|
+
|
|
71
|
+
**1. Install the CLIs** (`quoin` plus `ix-flow`, which runs the workflow lifecycle commands):
|
|
71
72
|
|
|
72
73
|
```bash
|
|
73
|
-
npm install -g @agent-ix/quoin@latest @agent-ix/ix-flow@latest
|
|
74
|
+
npm install -g @agent-ix/quoin@latest @agent-ix/ix-flow@latest
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
**2. Add the plugin to Claude Code** (run these inside Claude Code):
|
|
78
|
+
|
|
79
|
+
```text
|
|
80
|
+
/plugin marketplace add agent-ix/quoin
|
|
81
|
+
/plugin install quoin@quoin
|
|
74
82
|
```
|
|
75
83
|
|
|
84
|
+
That registers quoin's spec-authoring skills and workflows so you can drive them by asking
|
|
85
|
+
the agent.
|
|
86
|
+
|
|
76
87
|
## Usage
|
|
77
88
|
|
|
78
89
|
### skills & workflows
|
|
@@ -4,7 +4,7 @@ import { fileURLToPath as l } from "node:url";
|
|
|
4
4
|
import { configureRuntimeContext as u } from "@agent-ix/ix-cli-core";
|
|
5
5
|
import { homedir as d } from "node:os";
|
|
6
6
|
import { parse as f } from "yaml";
|
|
7
|
-
import { installEntry as p, readRegistry as m, reconcile as
|
|
7
|
+
import { installEntry as p, readRegistry as m, reconcile as ee, validateMarketplaceManifest as h, writeRegistry as g } from "@agent-ix/ts-plugin-kit";
|
|
8
8
|
import { spawn as _ } from "node:child_process";
|
|
9
9
|
//#region src/catalog.ts
|
|
10
10
|
function v() {
|
|
@@ -63,7 +63,7 @@ function x(e = b()) {
|
|
|
63
63
|
return {
|
|
64
64
|
modules: n,
|
|
65
65
|
entries: r,
|
|
66
|
-
duplicates:
|
|
66
|
+
duplicates: te(r)
|
|
67
67
|
};
|
|
68
68
|
}
|
|
69
69
|
function S(e, t) {
|
|
@@ -92,7 +92,7 @@ function E(e) {
|
|
|
92
92
|
function D(e) {
|
|
93
93
|
return typeof e == "string" ? e : void 0;
|
|
94
94
|
}
|
|
95
|
-
function
|
|
95
|
+
function te(e) {
|
|
96
96
|
let t = /* @__PURE__ */ new Map();
|
|
97
97
|
for (let n of e) {
|
|
98
98
|
let e = `${n.kind}:${n.name}`, r = t.get(e) ?? /* @__PURE__ */ new Set();
|
|
@@ -109,19 +109,19 @@ function O(e) {
|
|
|
109
109
|
}
|
|
110
110
|
//#endregion
|
|
111
111
|
//#region src/plugins.ts
|
|
112
|
-
function
|
|
112
|
+
function O(e = v()) {
|
|
113
113
|
return s(e, "filament", "registry.json");
|
|
114
114
|
}
|
|
115
|
-
function
|
|
115
|
+
function k(e) {
|
|
116
116
|
return {
|
|
117
117
|
cacheRoot: s(e, "cache", "ts-plugin-kit"),
|
|
118
118
|
targetRoot: y(e),
|
|
119
|
-
registryPath:
|
|
120
|
-
readName:
|
|
119
|
+
registryPath: O(e),
|
|
120
|
+
readName: P,
|
|
121
121
|
materialize: "copy"
|
|
122
122
|
};
|
|
123
123
|
}
|
|
124
|
-
function
|
|
124
|
+
function A(e) {
|
|
125
125
|
if (e.startsWith("path:")) return {
|
|
126
126
|
type: "path",
|
|
127
127
|
path: e.slice(5)
|
|
@@ -155,23 +155,23 @@ function j(e) {
|
|
|
155
155
|
path: e
|
|
156
156
|
};
|
|
157
157
|
}
|
|
158
|
-
function
|
|
159
|
-
return p({ source:
|
|
158
|
+
function j(e, t = v()) {
|
|
159
|
+
return p({ source: A(e) }, k(t));
|
|
160
160
|
}
|
|
161
|
-
function
|
|
162
|
-
return m(
|
|
161
|
+
function M(e = v()) {
|
|
162
|
+
return m(O(e)).plugins;
|
|
163
163
|
}
|
|
164
|
-
function
|
|
165
|
-
let n = m(
|
|
164
|
+
function N(e, t = v()) {
|
|
165
|
+
let n = m(O(t));
|
|
166
166
|
r(s(y(t), e), {
|
|
167
167
|
force: !0,
|
|
168
168
|
recursive: !0
|
|
169
|
-
}),
|
|
169
|
+
}), g(O(t), {
|
|
170
170
|
schemaVersion: 1,
|
|
171
171
|
plugins: n.plugins.filter((t) => t.name !== e)
|
|
172
172
|
});
|
|
173
173
|
}
|
|
174
|
-
function
|
|
174
|
+
function P(n) {
|
|
175
175
|
let r = e(s(n, "manifest.yaml")) ? s(n, "manifest.yaml") : s(n, a(n), "manifest.yaml");
|
|
176
176
|
if (!e(r)) throw Error(`no manifest.yaml found under ${n}`);
|
|
177
177
|
let i = f(t(r, "utf8"));
|
|
@@ -184,11 +184,11 @@ function F() {
|
|
|
184
184
|
return o(o(l(import.meta.url)));
|
|
185
185
|
}
|
|
186
186
|
function I() {
|
|
187
|
-
return
|
|
187
|
+
return h(f(t(s(F(), "default-modules.yaml"), "utf8")));
|
|
188
188
|
}
|
|
189
189
|
function L(e = v(), t = I()) {
|
|
190
|
-
|
|
191
|
-
...
|
|
190
|
+
ee(t, {
|
|
191
|
+
...k(e),
|
|
192
192
|
mode: "lazy"
|
|
193
193
|
});
|
|
194
194
|
}
|
|
@@ -212,7 +212,7 @@ function z() {
|
|
|
212
212
|
return Object.keys(R);
|
|
213
213
|
}
|
|
214
214
|
async function ne(e, t = {}) {
|
|
215
|
-
let n =
|
|
215
|
+
let n = B(e), r = v(), i = [
|
|
216
216
|
"run",
|
|
217
217
|
e,
|
|
218
218
|
"--path",
|
|
@@ -224,14 +224,14 @@ async function ne(e, t = {}) {
|
|
|
224
224
|
];
|
|
225
225
|
t.id && i.push("--id", t.id), t.json && i.push("--json");
|
|
226
226
|
for (let e of t.target ?? []) i.push("--target", e);
|
|
227
|
-
await
|
|
227
|
+
await H(i);
|
|
228
228
|
}
|
|
229
|
-
function
|
|
229
|
+
function B(t) {
|
|
230
230
|
let n = R[t];
|
|
231
231
|
if (!n) throw Error(`unknown spec flow ${t}`);
|
|
232
232
|
let r = [
|
|
233
233
|
process.env.IX_SPEC_WORKFLOWS_ROOT,
|
|
234
|
-
|
|
234
|
+
V(),
|
|
235
235
|
s(o(c(process.cwd())), "ix-spec-workflows"),
|
|
236
236
|
s(d(), ".ix", "plugins", "ix-spec-workflows")
|
|
237
237
|
].filter((e) => !!e);
|
|
@@ -241,10 +241,10 @@ function re(t) {
|
|
|
241
241
|
}
|
|
242
242
|
throw Error(`could not find ix-spec workflow skill ${n.runtimeSkill}; set IX_SPEC_WORKFLOWS_ROOT`);
|
|
243
243
|
}
|
|
244
|
-
function
|
|
244
|
+
function V() {
|
|
245
245
|
return s(o(o(l(import.meta.url))), "skills");
|
|
246
246
|
}
|
|
247
|
-
async function
|
|
247
|
+
async function H(e) {
|
|
248
248
|
await new Promise((t, n) => {
|
|
249
249
|
let r = _("ix-flow", e, { stdio: "inherit" });
|
|
250
250
|
r.on("error", n), r.on("close", (e) => {
|
|
@@ -258,10 +258,10 @@ async function V(e) {
|
|
|
258
258
|
}
|
|
259
259
|
//#endregion
|
|
260
260
|
//#region src/write.ts
|
|
261
|
-
function
|
|
261
|
+
function U(e) {
|
|
262
262
|
return (Array.isArray(e) ? e : e ? [e] : []).flatMap((e) => e.split(",")).map((e) => e.trim()).filter(Boolean);
|
|
263
263
|
}
|
|
264
|
-
function
|
|
264
|
+
function W(t, n, r) {
|
|
265
265
|
if (r.length === 0) throw Error("write requires --types <type[,type...]>");
|
|
266
266
|
let a = c(n);
|
|
267
267
|
if (!e(a) || !i(a).isDirectory()) throw Error(`write repo_dir is not a directory: ${n}`);
|
|
@@ -270,16 +270,16 @@ function U(t, n, r) {
|
|
|
270
270
|
types: r.map((e) => {
|
|
271
271
|
let n = S(t, e);
|
|
272
272
|
if (!n) throw Error(`catalog type not found: ${e}\nAvailable types: ${t.entries.map((e) => e.name).sort((e, t) => e.localeCompare(t)).join(", ")}`);
|
|
273
|
-
return
|
|
273
|
+
return K(n);
|
|
274
274
|
}),
|
|
275
275
|
validation: {
|
|
276
|
-
command: `quire validate --scope ${
|
|
276
|
+
command: `quire validate --scope ${q(a)} "spec/**/*.md"`,
|
|
277
277
|
scope: a,
|
|
278
278
|
globs: ["spec/**/*.md"]
|
|
279
279
|
}
|
|
280
280
|
};
|
|
281
281
|
}
|
|
282
|
-
function
|
|
282
|
+
function G(e) {
|
|
283
283
|
let t = [
|
|
284
284
|
"quoin write",
|
|
285
285
|
"",
|
|
@@ -290,7 +290,7 @@ function W(e) {
|
|
|
290
290
|
for (let n of e.types) t.push(`- ${n.name} (${n.kind})`), t.push(` module: ${n.moduleName}`), t.push(` module_root: ${n.moduleRoot}`), n.skeletonPath && t.push(` skeleton: ${n.skeletonPath}`), n.schemaPath && t.push(` schema: ${n.schemaPath}`), !n.skeletonPath && !n.schemaPath && t.push(" contract: manifest only");
|
|
291
291
|
return t.push(""), t.push("Author files directly in the repo, then validate changed spec files."), t.push(`Validate scope: ${e.validation.scope}`), t.push(`Validate command: ${e.validation.command}`), t.join("\n");
|
|
292
292
|
}
|
|
293
|
-
function
|
|
293
|
+
function K(e) {
|
|
294
294
|
return {
|
|
295
295
|
name: e.name,
|
|
296
296
|
kind: e.kind,
|
|
@@ -300,24 +300,24 @@ function G(e) {
|
|
|
300
300
|
...e.skeletonPath ? { skeletonPath: e.skeletonPath } : {}
|
|
301
301
|
};
|
|
302
302
|
}
|
|
303
|
-
function
|
|
303
|
+
function q(e) {
|
|
304
304
|
return /^[A-Za-z0-9_./:-]+$/.test(e) ? e : `'${e.replaceAll("'", "'\\''")}'`;
|
|
305
305
|
}
|
|
306
306
|
//#endregion
|
|
307
307
|
//#region src/cli.ts
|
|
308
|
-
var
|
|
309
|
-
async function
|
|
308
|
+
var J = "quoin\n\nSpec workflow and catalog CLI for Agent IX.\n\nquoin starts spec-domain work. ix-flow resumes, advances, acknowledges gates,\nand inspects workflow runs created by quoin.\n\nDefault modules (installed on first use into ~/.ix/filament/modules):\n Artifact modules: spec-artifacts-iso, spec-artifacts-app, spec-artifacts-process\n Object modules: spec-objects-business, spec-objects-architecture,\n spec-objects-enterprise, spec-objects-operational,\n spec-objects-security\n Workflows: review, matrix, to-plan\n\nUsage:\n quoin write <repo_dir> --types <type[,type...]>\n quoin catalog list|validate\n quoin catalog show <type>\n quoin plugin install <path:...|github:...>\n quoin plugin list\n quoin plugin remove <name>\n quoin review|matrix|to-plan [--target <ref>...]\n\nGlobal flags:\n --json\n --config-root <dir> Defaults to ~/.ix\n\nExamples:\n quoin catalog list\n quoin catalog show FR\n quoin plugin install github:agent-ix/spec-objects-custom\n quoin write . --types FR,domain\n ix-flow status <run-id>\n", Y = "quoin write\n\nBuild an authoring pack for spec files an agent is about to create or edit.\n\nPass the target repository and the artifact/object types involved in the work.\nquoin resolves those types from the active catalog and returns the local\nskeletons, schemas, module roots, and Quire validation command for the repo.\n\nUsage:\n quoin write <repo_dir> --types <type[,type...]>\n\nExamples:\n quoin write . --types FR\n quoin write . --types FR,domain,entity\n quoin write ../my-service --types fr,DOMAIN --json\n\nNotes:\n - Type lookup is case-insensitive; FR and fr are the same type.\n - Types can be artifacts or objects from the default module set or plugins.\n - Use the returned skeletons and schemas as the authoring contract.\n - Run the returned Quire command after editing spec files.\n", X = "quoin catalog\n\nInspect the active artifact/object catalog.\n\nThe catalog is assembled from, in order:\n 1. QUOIN_MODULE_PATHS\n 2. modules installed under ~/.ix/filament/modules\n\nThe default module set is installed there automatically on first catalog access,\nand updated by \"quoin plugin install\". The same directory is read by quire-rs.\n\nDefault artifact modules:\n spec-artifacts-iso FR, NFR, StR, US, IT, TC, AC, CON, Spec\n spec-artifacts-app app-level artifacts\n spec-artifacts-process plans, reviews, matrices, ADRs, tasks, findings\n\nDefault object modules:\n spec-objects-business\n spec-objects-architecture\n spec-objects-enterprise\n spec-objects-operational\n spec-objects-security\n\nUsage:\n quoin catalog list\n quoin catalog show <type>\n quoin catalog validate\n\nExamples:\n quoin catalog show FR\n quoin catalog show entity\n quoin catalog validate --json\n", re = "quoin plugin\n\nInstall and manage user/community spec modules.\n\nPlugins add or override artifact/object modules under ~/.ix/filament/modules.\nUse \"catalog list\" to see the full active catalog, including default modules and\nplugins.\n\nSupported install sources:\n path:<dir> Use a local directory containing manifest.yaml\n github:<owner>/<repo> Clone a GitHub repository (manifest at root)\n github:<owner>/<repo>@<ref> Pin to a tag, branch, or sha\n github:<owner>/<repo>//<subdir> Manifest in a monorepo subdirectory (@<ref> ok)\n\nUsage:\n quoin plugin install <path:...|github:...>\n quoin plugin list\n quoin plugin remove <name>\n quoin plugin ensure-defaults\n\nExamples:\n quoin plugin install path:../spec-objects-custom\n quoin plugin install github:agent-ix/spec-objects-custom\n quoin plugin install github:agent-ix/spec-objects-security//spec_objects_security@v0.1.1\n quoin plugin list\n quoin plugin ensure-defaults\n", ie = "quoin workflows\n\nStart bundled spec review/planning workflows. quoin creates the workflow run in ~/.ix/flows.\nUse ix-flow to inspect, resume, advance phases, and acknowledge human gates.\n\nAvailable workflow launchers:\n review Run a composite spec review\n matrix Build or update a requirements test matrix\n to-plan Convert accepted requirements into an implementation plan\n\nUsage:\n quoin review|matrix|to-plan [--target <ref>...]\n\nExamples:\n quoin review --target spec/\n quoin matrix --target spec/\n ix-flow status <run-id>\n ix-flow resume <run-id>\n";
|
|
309
|
+
async function ae(e) {
|
|
310
310
|
let t = ue(e);
|
|
311
311
|
if (t.flags.version || t.flags.v || t.command === "version") {
|
|
312
|
-
console.log(
|
|
312
|
+
console.log(Z());
|
|
313
313
|
return;
|
|
314
314
|
}
|
|
315
315
|
if (!t.command) {
|
|
316
|
-
console.log(
|
|
316
|
+
console.log(J);
|
|
317
317
|
return;
|
|
318
318
|
}
|
|
319
319
|
if (t.flags.help || t.flags.h) {
|
|
320
|
-
console.log(
|
|
320
|
+
console.log(oe(t));
|
|
321
321
|
return;
|
|
322
322
|
}
|
|
323
323
|
let n = Q(t, "config-root") ?? v();
|
|
@@ -328,28 +328,28 @@ async function oe(e) {
|
|
|
328
328
|
projectConfigEnabled: t.flags["no-project-config"] !== !0
|
|
329
329
|
}), t.command === "catalog") return ce(t);
|
|
330
330
|
if (t.command === "plugin") return le(t);
|
|
331
|
-
if (t.command === "write") return
|
|
331
|
+
if (t.command === "write") return se(t);
|
|
332
332
|
if (z().includes(t.command)) return ne(t.command, {
|
|
333
333
|
json: t.flags.json === !0,
|
|
334
334
|
id: Q(t, "id"),
|
|
335
335
|
target: $(t, "target")
|
|
336
336
|
});
|
|
337
|
-
throw Error(`unknown command ${t.command}\n\n${
|
|
337
|
+
throw Error(`unknown command ${t.command}\n\n${J}`);
|
|
338
338
|
}
|
|
339
|
-
function
|
|
339
|
+
function Z() {
|
|
340
340
|
let e = o(o(l(import.meta.url))), n = JSON.parse(t(s(e, "package.json"), "utf8"));
|
|
341
341
|
if (typeof n.version != "string") throw Error("package.json version is missing");
|
|
342
342
|
return n.version;
|
|
343
343
|
}
|
|
344
|
-
function
|
|
345
|
-
return e.command === "write" ?
|
|
344
|
+
function oe(e) {
|
|
345
|
+
return e.command === "write" ? Y : e.command === "catalog" ? X : e.command === "plugin" ? re : z().includes(e.command) ? ie : J;
|
|
346
346
|
}
|
|
347
|
-
function
|
|
347
|
+
function se(e) {
|
|
348
348
|
let [t] = e.positionals;
|
|
349
|
-
if (!t) throw Error(`write requires <repo_dir>\n\n${
|
|
349
|
+
if (!t) throw Error(`write requires <repo_dir>\n\n${Y}`);
|
|
350
350
|
L();
|
|
351
|
-
let n =
|
|
352
|
-
console.log(e.flags.json ? JSON.stringify(n, null, 2) :
|
|
351
|
+
let n = W(x(), t, U($(e, "types")));
|
|
352
|
+
console.log(e.flags.json ? JSON.stringify(n, null, 2) : G(n));
|
|
353
353
|
}
|
|
354
354
|
function ce(e) {
|
|
355
355
|
L();
|
|
@@ -391,20 +391,26 @@ function le(e) {
|
|
|
391
391
|
switch (e.subcommand) {
|
|
392
392
|
case "list":
|
|
393
393
|
case void 0:
|
|
394
|
-
console.log(JSON.stringify({ plugins:
|
|
394
|
+
console.log(JSON.stringify({ plugins: M() }, null, 2));
|
|
395
395
|
return;
|
|
396
396
|
case "install": {
|
|
397
397
|
let [t] = e.positionals;
|
|
398
398
|
if (!t) throw Error("plugin install requires <source>");
|
|
399
|
-
console.log(JSON.stringify(
|
|
399
|
+
console.log(JSON.stringify(j(t), null, 2));
|
|
400
400
|
return;
|
|
401
401
|
}
|
|
402
402
|
case "remove": {
|
|
403
403
|
let [t] = e.positionals;
|
|
404
404
|
if (!t) throw Error("plugin remove requires <name>");
|
|
405
|
-
|
|
405
|
+
N(t), console.log(`removed ${t}`);
|
|
406
406
|
return;
|
|
407
407
|
}
|
|
408
|
+
case "ensure-defaults":
|
|
409
|
+
L(), console.log(JSON.stringify({
|
|
410
|
+
ensured: !0,
|
|
411
|
+
plugins: M().map((e) => e.name)
|
|
412
|
+
}, null, 2));
|
|
413
|
+
return;
|
|
408
414
|
default: throw Error(`unknown plugin command ${e.subcommand}`);
|
|
409
415
|
}
|
|
410
416
|
}
|
|
@@ -433,4 +439,4 @@ function $(e, t) {
|
|
|
433
439
|
return Array.isArray(n) ? n : [];
|
|
434
440
|
}
|
|
435
441
|
//#endregion
|
|
436
|
-
export {
|
|
442
|
+
export { U as a, j as c, N as d, b as f, x as h, G as i, M as l, S as m, Z as n, I as o, y as p, W as r, L as s, ae as t, A as u };
|
package/dist/cli.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAmKA,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAmCxD;AAED,wBAAgB,cAAc,IAAI,MAAM,CASvC"}
|
package/dist/cli.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { n as e, t } from "./cli-
|
|
1
|
+
import { n as e, t } from "./cli-CNlT2O2s.js";
|
|
2
2
|
export { t as main, e as packageVersion };
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as e, c as t, d as n, f as r, h as i, i as a, l as o, m as s, o as c, p as l, r as u, s as d, t as f, u as p } from "./cli-
|
|
1
|
+
import { a as e, c as t, d as n, f as r, h as i, i as a, l as o, m as s, o as c, p as l, r as u, s as d, t as f, u as p } from "./cli-CNlT2O2s.js";
|
|
2
2
|
export { u as createAuthoringPack, r as defaultModuleRoots, c as defaultModulesManifest, d as ensureDefaultModules, l as filamentModulesDir, s as findCatalogEntry, a as formatAuthoringPack, t as installPlugin, o as listPlugins, i as loadCatalog, f as main, p as parseSourceArg, e as parseTypeList, n as removePlugin };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agent-ix/quoin",
|
|
3
3
|
"description": "Spec workflow and catalog CLI for Agent IX.",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.3.6",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"files": [
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"default-modules.yaml",
|
|
10
10
|
"skills/",
|
|
11
11
|
"bin/",
|
|
12
|
-
"plugin
|
|
12
|
+
".claude-plugin/",
|
|
13
13
|
"LICENSE",
|
|
14
14
|
"README.md"
|
|
15
15
|
],
|
|
@@ -54,8 +54,8 @@
|
|
|
54
54
|
"test-results:warnings": "./node_modules/.bin/jest-results warnings"
|
|
55
55
|
},
|
|
56
56
|
"dependencies": {
|
|
57
|
-
"@agent-ix/ix-cli-core": "0.10.
|
|
58
|
-
"@agent-ix/ts-plugin-kit": "
|
|
57
|
+
"@agent-ix/ix-cli-core": ">=0.10.4",
|
|
58
|
+
"@agent-ix/ts-plugin-kit": ">=0.1.3",
|
|
59
59
|
"yaml": "^2.9.0"
|
|
60
60
|
},
|
|
61
61
|
"devDependencies": {
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
When an FR defines a domain object, set the `object:` frontmatter field and use the matching template.
|
|
4
4
|
|
|
5
|
+
> The `assets/...-template.md` names below identify each object type's template
|
|
6
|
+
> **within its catalog module** — they are not files shipped in this skill.
|
|
7
|
+
> Obtain the actual skeleton + schema with `quoin write --types <type>` (or
|
|
8
|
+
> inspect a type with `quoin catalog show <type>`).
|
|
9
|
+
|
|
5
10
|
## Business Objects (spec-objects-business)
|
|
6
11
|
|
|
7
12
|
- `entity` / `aggregate_root` / `nested_entity`: Data entity, model, or aggregate → `assets/business/entity-template.md`
|
package/skills/specify/SKILL.md
CHANGED
|
@@ -1,49 +1,102 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: specify
|
|
3
|
-
description: Create or update spec
|
|
3
|
+
description: Create or update spec artifacts from a design or change request. Orchestrates authoring each requested requirement type (StR/US/FR/NFR/IT) as a discrete file using quoin catalog templates and Quire validation.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Specify
|
|
7
7
|
|
|
8
8
|
Use this skill when turning an agreed design, feature, or change request into
|
|
9
|
-
spec artifacts
|
|
9
|
+
spec artifacts. `specify` decides **which artifacts the request needs**, authors
|
|
10
|
+
each one **as its own file** using the catalog templates, and validates.
|
|
10
11
|
|
|
11
|
-
##
|
|
12
|
+
## Scope to the request
|
|
12
13
|
|
|
13
|
-
|
|
14
|
-
2. Identify every artifact and object type that will be created or edited.
|
|
15
|
-
3. Run `quoin write <repo_dir> --types <type[,type...]>` once for the full set of types.
|
|
16
|
-
4. Use the returned skeletons, schemas, module roots, and examples as the authoring contract.
|
|
17
|
-
5. Author or edit the files directly in the target repo.
|
|
18
|
-
6. Run `quire validate <glob> [glob2 ...]` over the changed spec scope.
|
|
19
|
-
7. Fix validation errors before moving to review, matrix, or planning work.
|
|
14
|
+
Author **only the artifact types the request calls for** — nothing more.
|
|
20
15
|
|
|
21
|
-
|
|
16
|
+
- "Add a user story for X" → one US.
|
|
17
|
+
- "Add the FR that implements US-003" → one FR (traced to US-003).
|
|
18
|
+
- "Add a user story and the requirement that implements it" → one US **and** one FR.
|
|
19
|
+
- "Edit FR-002 to …" → edit that one FR file in place.
|
|
20
|
+
- "Start a spec for service X" / "backport a spec from this code" → the full
|
|
21
|
+
chain (`spec.md` + US + FR + NFR, and IT where there are external integrations).
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
When unsure which types a request implies, decide from the request and state what
|
|
24
|
+
you are creating. A backport or new feature almost always needs **FR artifacts**,
|
|
25
|
+
not just a summary.
|
|
25
26
|
|
|
26
|
-
|
|
27
|
+
## Requirements are files, not table rows
|
|
27
28
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
```
|
|
29
|
+
Each requirement is a **discrete artifact file** with `type:` frontmatter. The
|
|
30
|
+
Requirements table inside `spec.md` (master-requirements) is an **index/summary**
|
|
31
|
+
— it never replaces the artifacts. Author every requested requirement as its own
|
|
32
|
+
file under the matching directory:
|
|
33
33
|
|
|
34
|
-
Type
|
|
35
|
-
|
|
36
|
-
|
|
34
|
+
| Type | `type:` | Location |
|
|
35
|
+
| ---- | ------- | ------------------------------ |
|
|
36
|
+
| StR | `StR` | `spec/stakeholder/StR-XXX-*.md`|
|
|
37
|
+
| US | `US` | `spec/usecase/US-XXX-*.md` |
|
|
38
|
+
| FR | `FR` | `spec/functional/FR-XXX-*.md` |
|
|
39
|
+
| NFR | `NFR` | `spec/non-functional/NFR-XXX-*.md` |
|
|
40
|
+
| IT | `IT` | `spec/integration/IT-XXX-*.md` |
|
|
37
41
|
|
|
38
|
-
|
|
42
|
+
> If a request asks for functional requirements and you produced only table rows
|
|
43
|
+
> in `spec.md`, the request is **not done** — create the `FR-XXX.md` files.
|
|
44
|
+
|
|
45
|
+
## Process
|
|
39
46
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
47
|
+
Run only the steps the request needs; stop after IT.
|
|
48
|
+
|
|
49
|
+
1. Identify the repository that owns the spec files, and which artifact types the
|
|
50
|
+
request implies (any subset of StR, US, FR, NFR, IT).
|
|
51
|
+
2. Run `quoin write <repo_dir> --types <type[,type...]>` **once** for the full
|
|
52
|
+
set. Use the returned skeletons, schemas, module roots, and examples as the
|
|
53
|
+
authoring contract — the per-type rules live in the template, not your memory.
|
|
54
|
+
3. Author each artifact as its own file (table above), in this logical order,
|
|
55
|
+
skipping any type not requested:
|
|
56
|
+
- `spec.md` — **REQUIRED when starting a new spec**: the
|
|
57
|
+
`type: master-requirements` root/index at `spec/spec.md`, authored from
|
|
58
|
+
`assets/spec-template.md` (or `assets/app-spec-template.md` for an
|
|
59
|
+
application). Then → StR → US →
|
|
60
|
+
**derive FR from US** (see [references/us-to-fr.md](references/us-to-fr.md))
|
|
61
|
+
→ FR → NFR → IT (see [references/integration-tests.md](references/integration-tests.md)).
|
|
62
|
+
4. Keep traceability in frontmatter `relationships:` (e.g. a US `traces_to` its
|
|
63
|
+
FRs; an FR/NFR/IT links back to the US/FR it serves).
|
|
64
|
+
5. Run `quire validate <glob> [glob2 ...]` over the changed spec scope and fix
|
|
65
|
+
every error before continuing.
|
|
66
|
+
6. **Stop at IT.** Then ask the user whether to build the test matrix
|
|
67
|
+
(`spec-matrix`) and run review (`spec-review`) — unless they already requested
|
|
68
|
+
them. Only run those on confirmation.
|
|
69
|
+
|
|
70
|
+
## Functional requirements
|
|
71
|
+
|
|
72
|
+
FRs are normative (`SHALL` / `SHALL NOT`), atomic, and independently verifiable,
|
|
73
|
+
each with an Acceptance Criteria table (the `fr.md` skeleton enforces the shape).
|
|
74
|
+
|
|
75
|
+
- Derive FRs from the driving user story — see
|
|
76
|
+
[references/us-to-fr.md](references/us-to-fr.md).
|
|
77
|
+
- A behavioral FR has no `object:` field. A **domain-typed** FR carries
|
|
78
|
+
`object: <type>` (e.g. `entity`, `event`, `api_endpoint`, `process`,
|
|
79
|
+
`configuration`) and uses that type's structural template. Look up the
|
|
80
|
+
type→template map and relationship verbs in
|
|
81
|
+
`spec-object-review`'s `references/object-type-guide.md`, and inspect a type
|
|
82
|
+
with `quoin catalog show <type>`.
|
|
83
|
+
|
|
84
|
+
## Application specs
|
|
85
|
+
|
|
86
|
+
When `component_type: application`, initialize `spec.md` from
|
|
87
|
+
`assets/app-spec-template.md`. Application specs own **only cross-service
|
|
88
|
+
concerns** — architecture rationale (ADRs), cross-service sequence diagrams,
|
|
89
|
+
system-level NFRs, the external consumer contract, scope boundaries, security
|
|
90
|
+
model. Per-service detail (endpoint contracts, DB schemas, per-service NFRs)
|
|
91
|
+
stays in the individual service specs. Otherwise use `assets/spec-template.md`.
|
|
92
|
+
|
|
93
|
+
## Authoring rules
|
|
94
|
+
|
|
95
|
+
- Let frontmatter identify each file. The discriminator is `type` (e.g.
|
|
96
|
+
`type: FR`, `type: master-requirements`) — it names the archetype.
|
|
43
97
|
- Use catalog skeletons and schemas rather than memory.
|
|
44
98
|
- Keep workflow definitions out of artifact/object type vocabularies.
|
|
45
|
-
- Validate every created or edited artifact with Quire.
|
|
46
|
-
- Use `spec-review` after validation for quality, consistency, and completeness review.
|
|
99
|
+
- Validate every created or edited artifact with Quire before finishing.
|
|
47
100
|
|
|
48
101
|
## Reserved OKF Files
|
|
49
102
|
|
|
@@ -59,11 +112,11 @@ author them like any other type:
|
|
|
59
112
|
```text
|
|
60
113
|
spec/
|
|
61
114
|
├── spec.md
|
|
62
|
-
├── stakeholder/
|
|
63
|
-
├── usecase/
|
|
64
|
-
├── functional/
|
|
65
|
-
├── non-functional/
|
|
66
|
-
├── integration/
|
|
115
|
+
├── stakeholder/ # StR-XXX
|
|
116
|
+
├── usecase/ # US-XXX
|
|
117
|
+
├── functional/ # FR-XXX
|
|
118
|
+
├── non-functional/ # NFR-XXX
|
|
119
|
+
├── integration/ # IT-XXX
|
|
67
120
|
├── matrix/
|
|
68
121
|
└── analysis/
|
|
69
122
|
```
|