@wirecat/cli-base 0.40.4 → 0.42.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/README.md +1 -0
- package/dist/commands/document.d.ts +2 -0
- package/dist/commands/document.d.ts.map +1 -1
- package/dist/commands/document.js +1 -0
- package/dist/commands/document.js.map +1 -1
- package/dist/commands/index.d.ts +11 -2
- package/dist/commands/index.d.ts.map +1 -1
- package/dist/commands/index.js +8 -0
- package/dist/commands/index.js.map +1 -1
- package/docs/standards/README.md +111 -0
- package/docs/standards/accounts.md +148 -0
- package/docs/standards/architecture.md +214 -0
- package/docs/standards/ci.md +159 -0
- package/docs/standards/commands.md +303 -0
- package/docs/standards/docs.md +214 -0
- package/docs/standards/layout.md +128 -0
- package/docs/standards/lifecycle.md +143 -0
- package/docs/standards/mcp.md +210 -0
- package/docs/standards/new-cli.md +111 -0
- package/docs/standards/output.md +256 -0
- package/docs/standards/permissions.md +295 -0
- package/docs/standards/releases.md +191 -0
- package/docs/standards/security.md +260 -0
- package/docs/standards/store.md +176 -0
- package/docs/standards/style.md +119 -0
- package/docs/standards/testing.md +222 -0
- package/docs/standards/toolchain.md +232 -0
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -24,6 +24,7 @@ the command tree as data — the parts every CLI needs and nobody should write t
|
|
|
24
24
|
| [Shared tooling](docs/TOOLING.md) | The TypeScript, Biome, lefthook, docs and CI setup a CLI takes from here, and `cli-dev` |
|
|
25
25
|
| [Testing](docs/dev/TESTING.md) | The checks, and what each one is for |
|
|
26
26
|
| [Conventions](docs/dev/CONVENTIONS.md) | How code here is written |
|
|
27
|
+
| [Standards handbook](docs/standards/README.md) | The rules every WireCat CLI follows, one page per area (a skeleton for now) |
|
|
27
28
|
| [CLI standard](https://github.com/WireCatLabs/cli-core/blob/main/docs/dev/STANDARD.md) | The rules every WireCat CLI follows; this package holds them as data |
|
|
28
29
|
| [Changelog](CHANGELOG.md) | What each version changed, and what may break callers |
|
|
29
30
|
|
|
@@ -21,6 +21,7 @@ export declare const commandsDocumentSchema: v.StrictObjectSchema<{
|
|
|
21
21
|
readonly env: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
22
22
|
readonly conflicts: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
|
|
23
23
|
readonly implies: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, undefined>;
|
|
24
|
+
readonly mcp: v.OptionalSchema<v.LiteralSchema<false, undefined>, undefined>;
|
|
24
25
|
}, undefined>, undefined>;
|
|
25
26
|
readonly scope: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
|
|
26
27
|
readonly inherited_options: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
|
|
@@ -35,6 +36,7 @@ export declare const commandsDocumentSchema: v.StrictObjectSchema<{
|
|
|
35
36
|
readonly env: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
36
37
|
readonly conflicts: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
|
|
37
38
|
readonly implies: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, undefined>;
|
|
39
|
+
readonly mcp: v.OptionalSchema<v.LiteralSchema<false, undefined>, undefined>;
|
|
38
40
|
}, undefined>, undefined>;
|
|
39
41
|
}, undefined>, undefined>, undefined>;
|
|
40
42
|
readonly commands: v.ArraySchema<v.GenericSchema<CommandInfo>, undefined>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../src/commands/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAK5B,OAAO,EAAE,KAAK,WAAW,EAAoC,KAAK,UAAU,EAAE,MAAM,YAAY,CAAA;
|
|
1
|
+
{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../src/commands/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAK5B,OAAO,EAAE,KAAK,WAAW,EAAoC,KAAK,UAAU,EAAE,MAAM,YAAY,CAAA;AAgEhG;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;IAGjC,8DAA8D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAQ9D,CAAA;AAEF,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,UAAU,EAAE,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,iBAAiB,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,UAAU,EAAE,CAAA;KAAE,EAAE,CAAA;IAC/D,QAAQ,EAAE,WAAW,EAAE,CAAA;IACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACnC;AAED,eAAO,MAAM,0BAA0B,oDAA6E,CAAA;AAEpH,eAAO,MAAM,qBAAqB,UACzB,OAAO,KACb;IAAE,QAAQ,EAAE,gBAAgB,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;CAGnG,CAAA;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,wGAAwG;AACxG,eAAO,MAAM,gBAAgB,SAAU,OAAO,SAAS,qBAAqB,KAAG,gBAQ7E,CAAA"}
|
|
@@ -22,6 +22,7 @@ const optionInfoSchema = v.object({
|
|
|
22
22
|
env: v.optional(v.string()),
|
|
23
23
|
conflicts: v.optional(v.array(v.string())),
|
|
24
24
|
implies: v.optional(v.record(v.string(), v.unknown())),
|
|
25
|
+
mcp: v.optional(v.literal(false)),
|
|
25
26
|
});
|
|
26
27
|
const fieldInfoSchema = v.object({
|
|
27
28
|
name: v.string(),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"document.js","sourceRoot":"","sources":["../../src/commands/document.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EAAoB,eAAe,EAAE,eAAe,EAAmB,MAAM,YAAY,CAAA;AAEhG,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CACjC,CAAC,CAAA;AAEF,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;IACxB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAChC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"document.js","sourceRoot":"","sources":["../../src/commands/document.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EAAoB,eAAe,EAAE,eAAe,EAAmB,MAAM,YAAY,CAAA;AAEhG,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CACjC,CAAC,CAAA;AAEF,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;IACxB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAChC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACtD,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;CAClC,CAAC,CAAA;AAEF,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;IAC7B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAChF,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACvC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;CACxC,CAAC,CAAA;AAEF,MAAM,iBAAiB,GAAiC,CAAC,CAAC,MAAM,CAAC;IAC/D,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IAChD,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC;IAClC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IACrD,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAChC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;IAC/D,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACpC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;IAClF,KAAK,EAAE,CAAC,CAAC,QAAQ,CACf,CAAC,CAAC,MAAM,CAAC;QACP,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC;QACnC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;QAChC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;KAC1C,CAAC,CACH;IACD,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;IACtC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;IAClC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,CAAC;CACnD,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IACnD,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;IACzC,8DAA8D;IAC9D,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACxD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;IACzC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,iBAAiB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;IACnH,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;IACpC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;CAClE,CAAC,CAAA;AAcF,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAA;AAEpH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,KAAc,EACuF,EAAE;IACvG,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAA;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,MAA0B,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAA;AACjH,CAAC,CAAA;AAQD,wGAAwG;AACxG,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAa,EAAE,KAA4B,EAAoB,EAAE,CAAC,CAAC;IAClG,GAAG,EAAE,KAAK,CAAC,GAAG;IACd,OAAO,EAAE,KAAK,CAAC,OAAO;IACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;IACxB,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE;IAC/B,cAAc,EAAE,eAAe,CAAC,IAAI,CAAC;IACrC,QAAQ,EAAE,eAAe,CAAC,IAAI,CAAC;IAC/B,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,cAAc,EAAE,eAAe,EAAE,GAAG,UAAU,EAAE;CACtE,CAAC,CAAA"}
|
package/dist/commands/index.d.ts
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
* It walks the live Commander tree rather than a list written by hand, so a command built in a
|
|
5
5
|
* loop from a catalog shows up exactly like one written in a file. What the tree cannot say — where
|
|
6
6
|
* a command came from, whether it changes anything, whether it is on its way out — is attached with
|
|
7
|
-
* `annotate`.
|
|
7
|
+
* `annotate`, and to an option with `annotateOption`.
|
|
8
8
|
*
|
|
9
9
|
* Behind its own entry point for the same reason `/http` is: Commander is only a type here, and the
|
|
10
10
|
* root of this package stays free of any command-line framework.
|
|
11
11
|
*/
|
|
12
|
-
import type { Command } from "commander";
|
|
12
|
+
import type { Command, Option } from "commander";
|
|
13
13
|
import type { QueryRegistry } from "../query/fields.js";
|
|
14
14
|
import { type QueryInfo } from "../query/registry.js";
|
|
15
15
|
import type { Effects } from "../standards/effects.js";
|
|
@@ -41,6 +41,10 @@ export interface CommandMeta {
|
|
|
41
41
|
/** A list's query fields; the list takes them as its last argument, `[query...]`. */
|
|
42
42
|
query?: QueryRegistry;
|
|
43
43
|
}
|
|
44
|
+
export interface OptionMeta {
|
|
45
|
+
/** `false` leaves the option out of MCP tools' input; agents using the CLI itself are not affected. */
|
|
46
|
+
mcp?: boolean;
|
|
47
|
+
}
|
|
44
48
|
export interface CommandOutput {
|
|
45
49
|
entity: string;
|
|
46
50
|
view?: string;
|
|
@@ -70,6 +74,8 @@ export interface OptionInfo {
|
|
|
70
74
|
conflicts?: readonly string[];
|
|
71
75
|
/** Values this option sets on others when they are not given, by long flag. */
|
|
72
76
|
implies?: Readonly<Record<string, unknown>>;
|
|
77
|
+
/** Present only when the option is kept off MCP tools. */
|
|
78
|
+
mcp?: false;
|
|
73
79
|
}
|
|
74
80
|
export interface CommandInfo {
|
|
75
81
|
/** What to pass to the CLI, already split: `["runs", "list"]`. */
|
|
@@ -97,6 +103,9 @@ export interface CommandInfo {
|
|
|
97
103
|
/** Attaches what the tree cannot say. Repeated calls merge; the command is returned for chaining. */
|
|
98
104
|
export declare const annotate: <T extends Command>(command: T, meta: CommandMeta) => T;
|
|
99
105
|
export declare const metaOf: (command: Command) => CommandMeta;
|
|
106
|
+
/** `annotate` for an option. Repeated calls merge; the option is returned for `addOption`. */
|
|
107
|
+
export declare const annotateOption: <T extends Option>(option: T, meta: OptionMeta) => T;
|
|
108
|
+
export declare const optionMetaOf: (option: Option) => OptionMeta;
|
|
100
109
|
export declare const describeProgram: (root: Command) => CommandInfo[];
|
|
101
110
|
export declare const describeOptions: (command: Command) => OptionInfo[];
|
|
102
111
|
export declare const flatten: (commands: readonly CommandInfo[]) => CommandInfo[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/commands/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAY,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/commands/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAY,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAE1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,EAAiB,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD,MAAM,MAAM,MAAM,GAAG,aAAa,GAAG,WAAW,CAAA;AAChD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,YAAY,CAAA;AAChD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG,aAAa,CAAA;AAE1D,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,+GAA+G;IAC/G,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,mHAAmH;IACnH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,YAAY,CAAA;IACpB,8GAA8G;IAC9G,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B,uHAAuH;IACvH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,8GAA8G;IAC9G,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC5B,gEAAgE;IAChE,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,qFAAqF;IACrF,KAAK,CAAC,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,GAAG,CAAC,EAAE,OAAO,CAAA;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,yFAAyF;IACzF,WAAW,EAAE,OAAO,CAAA;IACpB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4DAA4D;IAC5D,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC7B,+EAA+E;IAC/E,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAC3C,0DAA0D;IAC1D,GAAG,CAAC,EAAE,KAAK,CAAA;CACZ;AAED,MAAM,WAAW,WAAW;IAC1B,kEAAkE;IAClE,IAAI,EAAE,SAAS,MAAM,EAAE,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,YAAY,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B,iFAAiF;IACjF,GAAG,CAAC,EAAE,KAAK,CAAA;IACX,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC5B,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,SAAS,EAAE,SAAS,YAAY,EAAE,CAAA;IAClC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAA;IAC9B,QAAQ,EAAE,SAAS,WAAW,EAAE,CAAA;CACjC;AAID,qGAAqG;AACrG,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,OAAO,WAAW,CAAC,QAAQ,WAAW,KAAG,CAG3E,CAAA;AAED,eAAO,MAAM,MAAM,YAAa,OAAO,KAAG,WAAwC,CAAA;AAIlF,8FAA8F;AAC9F,eAAO,MAAM,cAAc,GAAI,CAAC,SAAS,MAAM,UAAU,CAAC,QAAQ,UAAU,KAAG,CAG9E,CAAA;AAED,eAAO,MAAM,YAAY,WAAY,MAAM,KAAG,UAA4C,CAAA;AAE1F,eAAO,MAAM,eAAe,SAAU,OAAO,KAAG,WAAW,EACY,CAAA;AAEvE,eAAO,MAAM,eAAe,YAAa,OAAO,KAAG,UAAU,EACW,CAAA;AAExE,eAAO,MAAM,OAAO,aAAc,SAAS,WAAW,EAAE,KAAG,WAAW,EACE,CAAA;AAIxE;;;GAGG;AACH,eAAO,MAAM,WAAW,SAAU,OAAO,KAAG,CAAC,CAAC,OAAO,EAAE,MAAM,KAAK,UAAU,GAAG,SAAS,CAgBvF,CAAA;AA2ED,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,gBAAgB,EAChB,0BAA0B,EAC1B,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,oBAAoB,EACpB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,YAAY,GACb,MAAM,WAAW,CAAA;AAElB;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,SAAU,OAAO,QAAQ,SAAS,MAAM,EAAE,KAAG,IAgBzE,CAAA"}
|
package/dist/commands/index.js
CHANGED
|
@@ -7,6 +7,13 @@ export const annotate = (command, meta) => {
|
|
|
7
7
|
return command;
|
|
8
8
|
};
|
|
9
9
|
export const metaOf = (command) => labels.get(command) ?? {};
|
|
10
|
+
const optionLabels = new WeakMap();
|
|
11
|
+
/** `annotate` for an option. Repeated calls merge; the option is returned for `addOption`. */
|
|
12
|
+
export const annotateOption = (option, meta) => {
|
|
13
|
+
optionLabels.set(option, { ...optionLabels.get(option), ...meta });
|
|
14
|
+
return option;
|
|
15
|
+
};
|
|
16
|
+
export const optionMetaOf = (option) => optionLabels.get(option) ?? {};
|
|
10
17
|
export const describeProgram = (root) => visible(root).map((child) => describe(child, root.name(), [], false));
|
|
11
18
|
export const describeOptions = (command) => command.options.filter((option) => !option.hidden).map(describeOption);
|
|
12
19
|
export const flatten = (commands) => commands.flatMap((command) => [command, ...flatten(command.commands)]);
|
|
@@ -90,6 +97,7 @@ const describeOption = (option) => {
|
|
|
90
97
|
...(option.envVar ? { env: option.envVar } : {}),
|
|
91
98
|
...(conflictsWith.length > 0 ? { conflicts: conflictsWith } : {}),
|
|
92
99
|
...(implied ? { implies: impliesOf(implied) } : {}),
|
|
100
|
+
...(optionMetaOf(option).mcp === false ? { mcp: false } : {}),
|
|
93
101
|
};
|
|
94
102
|
};
|
|
95
103
|
export { commandsDocument, commandsDocumentJsonSchema, commandsDocumentSchema, parseCommandsDocument, } from "./document.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/commands/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAEvC,OAAO,EAAE,aAAa,EAAkB,MAAM,sBAAsB,CAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/commands/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAEvC,OAAO,EAAE,aAAa,EAAkB,MAAM,sBAAsB,CAAA;AAiGpE,MAAM,MAAM,GAAG,IAAI,OAAO,EAAwB,CAAA;AAElD,qGAAqG;AACrG,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAoB,OAAU,EAAE,IAAiB,EAAK,EAAE;IAC9E,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;IACxD,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAe,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;AAElF,MAAM,YAAY,GAAG,IAAI,OAAO,EAAsB,CAAA;AAEtD,8FAA8F;AAC9F,MAAM,CAAC,MAAM,cAAc,GAAG,CAAmB,MAAS,EAAE,IAAgB,EAAK,EAAE;IACjF,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;IAClE,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAc,EAAc,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;AAE1F,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAa,EAAiB,EAAE,CAC9D,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC,CAAA;AAEvE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAgB,EAAE,CAChE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;AAExE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,QAAgC,EAAiB,EAAE,CACzE,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;AAExE,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAEnH;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAa,EAAiD,EAAE;IAC1F,MAAM,KAAK,GAAG,IAAI,GAAG,EAAsB,CAAA;IAC3C,4GAA4G;IAC5G,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAA;IACxG,MAAM,KAAK,GAAG,CAAC,OAAgB,EAAE,OAA0B,EAAE,KAAwB,EAAE,EAAE;QACvF,MAAM,IAAI,GAAG,CAAC,GAAG,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;QACzC,MAAM,OAAO,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;QAC9C,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;QACnC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YACxB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/B,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;SAC9G,CAAC,CAAA;QACF,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ;YAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IACnE,CAAC,CAAA;IACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ;QAAE,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IACjE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;AACxC,CAAC,CAAA;AAED,MAAM,QAAQ,GAAG,CAAC,OAAgB,EAAE,GAAW,EAAE,OAA0B,EAAE,WAAoB,EAAe,EAAE;IAChH,MAAM,IAAI,GAAG,CAAC,GAAG,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IACzC,MAAM,IAAI,GAAG,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;IAC9D,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAA;IACxC,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;IACvE,MAAM,MAAM,GAAG,WAAW,IAAI,GAAG,KAAK,KAAK,CAAA;IAE3C,MAAM,KAAK,GAAG;QACZ,GAAG;QACH,GAAG,IAAI;QACP,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;QAC5F,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;KACtC;SACE,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,GAAG,CAAC,CAAA;IAEZ,OAAO;QACL,IAAI;QACJ,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;QACpB,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5D,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE;QAClC,KAAK;QACL,MAAM;QACN,GAAG,IAAI;QACP,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjD,SAAS,EAAE,IAAI;QACf,OAAO;QACP,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;KAC9E,CAAA;AACH,CAAC,CAAA;AAED,iGAAiG;AACjG,MAAM,OAAO,GAAG,CAAC,OAAgB,EAAa,EAAE,CAC9C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAE,KAAyC,CAAC,OAAO,CAAC,CAAA;AAEzF,MAAM,gBAAgB,GAAG,CAAC,QAAkB,EAAgB,EAAE,CAAC,CAAC;IAC9D,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE;IACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;IAC3B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;IAC3B,WAAW,EAAE,QAAQ,CAAC,WAAW;IACjC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAChE,GAAG,CAAC,QAAQ,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC;CACnF,CAAC,CAAA;AAKF,0GAA0G;AAC1G,MAAM,SAAS,GAAG,CAAC,OAAgC,EAA2B,EAAE,CAC9E,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;IAC7C,KAAK,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,EAAE;IAC3D,KAAK;CACN,CAAC,CACH,CAAA;AAEH,MAAM,cAAc,GAAG,CAAC,MAAc,EAAc,EAAE;IACpD,MAAM,EAAE,aAAa,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,MAA0B,CAAA;IAClE,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,WAAW,EAAE,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ;QAC/C,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5D,GAAG,CAAC,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC;QAC9E,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChD,GAAG,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvE,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAGL,gBAAgB,EAChB,0BAA0B,EAC1B,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,oBAAoB,EAIpB,YAAY,GACb,MAAM,WAAW,CAAA;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAa,EAAE,IAAuB,EAAQ,EAAE;IAC/E,IAAI,OAAO,GAAG,IAAI,CAAA;IAClB,MAAM,IAAI,GAAa,EAAE,CAAA;IACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAM;QAC/B,MAAM,CAAC,KAAK,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACrD,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,KAAK,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;QACxG,IAAI,IAAI,KAAK,SAAS;YAAE,OAAM;QAC9B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YACjB,MAAM,IAAI,QAAQ,CAChB,kBAAkB,EAClB,IAAI,GAAG,qCAAqC,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAC/F,CAAA;QACH,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAChB,OAAO,GAAG,IAAI,CAAA;IAChB,CAAC;AACH,CAAC,CAAA"}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# WireCat CLI standards
|
|
2
|
+
|
|
3
|
+
This handbook holds the rules every WireCat CLI follows: tools, layout, commands, output, MCP, accounts,
|
|
4
|
+
permissions, architecture, tests, security, documents, releases and CI. Read this page first. Then read the page
|
|
5
|
+
for the area you are about to change.
|
|
6
|
+
|
|
7
|
+
It ships in the `@wirecat/cli-base` package. A CLI that depends on cli-base has it at
|
|
8
|
+
`node_modules/@wirecat/cli-base/docs/standards/README.md`, at the same version as the `cli-dev lint` it runs.
|
|
9
|
+
|
|
10
|
+
## How to use this for a new CLI
|
|
11
|
+
|
|
12
|
+
Start with the [New CLI](new-cli.md) checklist. Each step names the check that proves it and the area page whose
|
|
13
|
+
rules it keeps. A new CLI is ready for its first release when every check under "Done when" passes.
|
|
14
|
+
|
|
15
|
+
## Which rule wins
|
|
16
|
+
|
|
17
|
+
1. **The handbook wins over a repository's own documents.** When a `CONVENTIONS.md`, `CLAUDE.md` or `AGENTS.md`
|
|
18
|
+
disagrees with a rule here, the rule here applies, and the repository document is the one to fix.
|
|
19
|
+
2. **A repository may be stricter, never looser.** For example, a smaller file size cap is fine. Turning off a
|
|
20
|
+
rule is not.
|
|
21
|
+
3. **Product rules stay local.** A rule that only makes sense for one CLI lives in that CLI's `CLAUDE.md`, under
|
|
22
|
+
"Local rules", below a link to this page.
|
|
23
|
+
|
|
24
|
+
## Areas
|
|
25
|
+
|
|
26
|
+
| Page | Area id | Rules | What it covers |
|
|
27
|
+
|---|---|---:|---|
|
|
28
|
+
| [Toolchain](toolchain.md) | `TOOL` | 19 | TypeScript, Biome, grit plugins, size caps, import cycles, spelling, Markdown |
|
|
29
|
+
| [Layout](layout.md) | `LAY` | 9 | Repository layout, entry points, exports, file size, one job per file, splitting a unit |
|
|
30
|
+
| [Commands](commands.md) | `CMD` | 27 | Paths, vocabulary, flags, arguments, effects, lifetime, query, help |
|
|
31
|
+
| [Output](output.md) | `OUT` | 22 | Data on stdout only, envelopes, errors, exit codes, partial answers, projection |
|
|
32
|
+
| [MCP](mcp.md) | `MCP` | 12 | The MCP tools, how they come from commands, what each permission shows |
|
|
33
|
+
| [Accounts](accounts.md) | `ACCT` | 10 | The explicit profile, reads across accounts, scope flags |
|
|
34
|
+
| [Permissions](permissions.md) | `PERM` | 21 | Levels, keys, defaults, hard limits, the write guard and its journal |
|
|
35
|
+
| [Architecture](architecture.md) | `ARCH` | 16 | Layers, dependency direction, vendor types, what goes in which package |
|
|
36
|
+
| [Lifecycle](lifecycle.md) | `LIFE` | 10 | Opening late, who closes, one-shot exits, long-running commands, the `serve` relay |
|
|
37
|
+
| [Store](store.md) | `STORE` | 14 | Store areas, account scope, migrations, test isolation |
|
|
38
|
+
| [Testing](testing.md) | `TEST` | 17 | Sandbox, no network, no real waits, leak tests, coverage, contracts, test matrix, parity |
|
|
39
|
+
| [Security](security.md) | `SECR` | 19 | Secrets, logs, keyring, argv, error text, scanners, workflow hardening, reporting |
|
|
40
|
+
| [Documents](docs.md) | `DOC` | 20 | User pages and developer pages, generated pages, current facts, changelog |
|
|
41
|
+
| [Releases](releases.md) | `REL` | 16 | `bin/release`, the release lock, versions, release reports, trusted publishing |
|
|
42
|
+
| [CI](ci.md) | `CI` | 12 | Hooks, the pull request budget, full validation, monthly runs |
|
|
43
|
+
| [Style](style.md) | `STYLE` | 10 | Comments, TypeScript habits, commit messages |
|
|
44
|
+
| [New CLI](new-cli.md) | — | — | The checklist for starting a new CLI |
|
|
45
|
+
|
|
46
|
+
Each count leaves out the ids that moved or merged (see "How ids work").
|
|
47
|
+
|
|
48
|
+
## How a page is laid out
|
|
49
|
+
|
|
50
|
+
Every area page has the same parts, in this order:
|
|
51
|
+
|
|
52
|
+
1. **Scope:** what the page covers, its rule id prefix, and links to the pages that own nearby rules. It may add
|
|
53
|
+
"Words used here" for terms the page defines, and "Who follows these rules today" for known gaps in a CLI.
|
|
54
|
+
2. **The rules:** under one `## Rules` heading, or under a few `##` headings that group them by theme.
|
|
55
|
+
3. **Planned — not built yet** (only on a page that needs it): an approved design that is not true yet. It has no
|
|
56
|
+
rule ids.
|
|
57
|
+
4. **Sources:** a short list of the documents the rules came from. Where one of them disagrees with the page, the
|
|
58
|
+
page holds.
|
|
59
|
+
|
|
60
|
+
## How a rule is written
|
|
61
|
+
|
|
62
|
+
Every rule has the same shape. A rule may add a sentence or a short list under its heading, before the bullets.
|
|
63
|
+
|
|
64
|
+
```markdown
|
|
65
|
+
### WC-<AREA>-<n> · <the rule, in one short sentence>
|
|
66
|
+
|
|
67
|
+
- **Why:** <one line>.
|
|
68
|
+
- **Enforced by:** <check names in backticks, joined by " · ">, or the words "review only".
|
|
69
|
+
- **Example:** <a command or a piece of code that keeps the rule>.
|
|
70
|
+
- **Exceptions:** <when the rule does not apply>, or "none".
|
|
71
|
+
- **Applies to:** <all CLIs, or which ones>. **Since:** cli-base <version>. **Rulings:** <ids>, or "none".
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
- **Enforced by** names checks in one of these forms:
|
|
75
|
+
- a check in this repository: a `cli-dev lint` or `cli-dev audit` rule (`flag-synonym`), a workflow (`ci.yml`, or
|
|
76
|
+
`ci.yml:ci` for one job), a `pnpm` script (`pnpm standards:check`) or a file by its path (`src/keyring.test.ts`);
|
|
77
|
+
- a check in another repository, as `<repo>: <check>`, such as `cli-core: pnpm parity:check` or
|
|
78
|
+
`cli-core: biome noRestrictedImports`. `<repo>` is the repository's name on GitHub: `cli-core`, `cli-testing`,
|
|
79
|
+
`cli-docs`, `community`, `tg-cli`, `max-cli`, `cli-memo`, `drive-cli`, `zoom-cli` or `whatsapp-cli`. `<app>`
|
|
80
|
+
stands for each CLI the rule applies to, when every one of them runs that check in its own repository.
|
|
81
|
+
- **Since** is the cli-base release whose handbook first carried the rule. A feature can be older than its rule.
|
|
82
|
+
|
|
83
|
+
## How ids work
|
|
84
|
+
|
|
85
|
+
- A rule id is `WC-<AREA>-<n>`, for example `WC-OUT-3`. The area id is in the table above.
|
|
86
|
+
- The `WC-` prefix keeps rule ids apart from other ids in the WireCat repositories.
|
|
87
|
+
- Numbers go up within a page and are never reused or renumbered. A new rule takes the next number and goes last on
|
|
88
|
+
its page.
|
|
89
|
+
- A rule that moves to another page, or merges into another rule, keeps its id as a one-line entry, so a citation of
|
|
90
|
+
the old id still leads somewhere:
|
|
91
|
+
|
|
92
|
+
```markdown
|
|
93
|
+
### WC-CI-11 · Moved to [WC-SECR-20](security.md#wc-secr-20--pin-each-third-party-action-to-a-commit-and-give-each-workflow-read-only-defaults)
|
|
94
|
+
### WC-ARCH-12 · Merged into [WC-LIFE-6](lifecycle.md#wc-life-6--open-nothing-until-an-action-needs-it)
|
|
95
|
+
```
|
|
96
|
+
- A `cli-dev lint` or `cli-dev audit` rule keeps its own kebab-case name, such as `flag-synonym`. The handbook rule
|
|
97
|
+
names it under "Enforced by".
|
|
98
|
+
|
|
99
|
+
## What `pnpm docs:check` checks here
|
|
100
|
+
|
|
101
|
+
[`scripts/standards-ids.ts`](https://github.com/WireCatLabs/cli-base/blob/main/scripts/standards-ids.ts) reads every
|
|
102
|
+
page and fails when:
|
|
103
|
+
|
|
104
|
+
- a rule id appears twice, belongs to another page's area, or is out of order on its page;
|
|
105
|
+
- a rule has no "Enforced by" line;
|
|
106
|
+
- a name in an "Enforced by" line, on any of its lines, is not a known check. A check in this repository must exist.
|
|
107
|
+
A check in another repository cannot be read from here, so only its form is checked: a known repository name, a
|
|
108
|
+
colon and a space, and a check name. Anything else says "review only";
|
|
109
|
+
- a "Moved to" or "Merged into" entry points at an id that is not a rule;
|
|
110
|
+
- the rule count in the table above differs from the page;
|
|
111
|
+
- a page in this folder is not linked from this index.
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# Accounts
|
|
2
|
+
|
|
3
|
+
## Scope
|
|
4
|
+
|
|
5
|
+
How a CLI chooses an account: the profile is always explicit, a read across accounts covers all of them and says so,
|
|
6
|
+
and scope flags work the same everywhere.
|
|
7
|
+
|
|
8
|
+
A **profile** is the name of one login of a CLI on one computer, for example `personal` or `work`. One profile can
|
|
9
|
+
hold a personal session, a bot token, or both.
|
|
10
|
+
|
|
11
|
+
Rule ids on this page are `WC-ACCT-<n>`. How to read a rule, how ids work and which rule wins are in the
|
|
12
|
+
[index](README.md).
|
|
13
|
+
|
|
14
|
+
### Who follows these rules today
|
|
15
|
+
|
|
16
|
+
cli-core resolves the profile for tg, max and wa. WC-ACCT-1 needs cli-core 0.319.0 or newer, and all three pin
|
|
17
|
+
0.321.0. memo has no messenger profile: its shared commands run without one, and they pick accounts with `--provider`
|
|
18
|
+
and `--account` (WC-ACCT-7). drive and zoom still have their own profile code: drive registers its own profiles, and
|
|
19
|
+
zoom keeps one saved profile in its config file. These are known gaps, not exceptions.
|
|
20
|
+
|
|
21
|
+
## Rules
|
|
22
|
+
|
|
23
|
+
### WC-ACCT-1 · Name the profile on every command that acts for an account
|
|
24
|
+
|
|
25
|
+
The profile is the first word on the command line, or the `<PREFIX>_PROFILE` variable. Nothing picks one for the
|
|
26
|
+
owner: not a config file, not the first profile in a list, not a profile called `default`, and not the only profile
|
|
27
|
+
on the computer.
|
|
28
|
+
|
|
29
|
+
- **Why:** which account a command speaks for is the owner's choice; a guess sends from the wrong account.
|
|
30
|
+
- **Enforced by:** `cli-core: src/cli/settings.test.ts`.
|
|
31
|
+
- **Example:** `tg personal chats list`, or `TG_PROFILE=personal tg chats list`. When no profile is named and the
|
|
32
|
+
config file still has `default_profile`, cli-core stops and says which profile to type. `config set default_profile`
|
|
33
|
+
is refused.
|
|
34
|
+
- **Exceptions:** a command that touches no account runs without a profile, for example `account list`,
|
|
35
|
+
`config show` and `commands`.
|
|
36
|
+
- **Applies to:** all CLIs. **Since:** cli-base 0.41.0. **Rulings:** NEED-84.
|
|
37
|
+
|
|
38
|
+
### WC-ACCT-2 · The profile is a word, never a flag
|
|
39
|
+
|
|
40
|
+
There is no `--profile` option. The first word is the profile unless it names a command, and an option is never a
|
|
41
|
+
profile.
|
|
42
|
+
|
|
43
|
+
- **Why:** one place for the profile keeps every command line readable the same way, in every CLI.
|
|
44
|
+
- **Enforced by:** `cli-core: src/cli/profile.test.ts`.
|
|
45
|
+
- **Example:** `max work bot messages send …` uses the same first word as `max work chats list`. `tg --json chats list`
|
|
46
|
+
still works, because `--json` is an option.
|
|
47
|
+
- **Exceptions:** none.
|
|
48
|
+
- **Applies to:** all CLIs. **Since:** cli-base 0.41.0. **Rulings:** NEED-84, NEED-294.
|
|
49
|
+
|
|
50
|
+
### WC-ACCT-3 · A missing profile is an error that lists the choices
|
|
51
|
+
|
|
52
|
+
When a command needs a profile and none is named, it fails with `validation_error`. The message and
|
|
53
|
+
`details.profiles` list the profiles on this computer. With no profile at all, the message says how to create one by
|
|
54
|
+
name.
|
|
55
|
+
|
|
56
|
+
- **Why:** the owner, or an agent, can fix the command from the error alone.
|
|
57
|
+
- **Enforced by:** `cli-core: src/cli/settings.test.ts`.
|
|
58
|
+
- **Example:** ``name a profile: `tg <profile> …` — profiles here: personal, work (or set TG_PROFILE)``. With none,
|
|
59
|
+
the message says to ``create one with `tg personal setup` (any name in place of personal)``.
|
|
60
|
+
- **Exceptions:** none.
|
|
61
|
+
- **Applies to:** all CLIs. **Since:** cli-base 0.41.0. **Rulings:** none.
|
|
62
|
+
|
|
63
|
+
### WC-ACCT-4 · A profile name is a plain word and never a command word
|
|
64
|
+
|
|
65
|
+
A name has letters, digits, dot, dash and underscore only, and starts with a letter or a digit. A name that is also a
|
|
66
|
+
top-level command, such as `chats` or `bot`, is refused when the profile is created. `default` is an ordinary name.
|
|
67
|
+
|
|
68
|
+
- **Why:** the name becomes a file name and a keyring account, and a profile named after a command could never be
|
|
69
|
+
selected.
|
|
70
|
+
- **Enforced by:** `cli-core: src/cli/profile.test.ts` · `cli-core: src/cli/settings.test.ts`.
|
|
71
|
+
- **Example:** `tg work setup` works. `tg chats setup` is refused with the list of command words to avoid.
|
|
72
|
+
`tg a/../b setup` is refused as a name.
|
|
73
|
+
- **Exceptions:** none.
|
|
74
|
+
- **Applies to:** all CLIs. **Since:** cli-base 0.41.0. **Rulings:** NEED-294.
|
|
75
|
+
|
|
76
|
+
### WC-ACCT-5 · A profile lock pins a process to one profile
|
|
77
|
+
|
|
78
|
+
When `<PREFIX>_PROFILE_LOCK` is set, a first word or `<PREFIX>_PROFILE` that names any other profile is refused with
|
|
79
|
+
`permission_error`.
|
|
80
|
+
|
|
81
|
+
- **Why:** an agent must not escape its guards by naming a profile with fewer of them.
|
|
82
|
+
- **Enforced by:** `cli-core: src/cli/settings.test.ts`.
|
|
83
|
+
- **Example:** with `MAX_PROFILE_LOCK=agent`, `max personal messages send …` is refused, and `max messages list` runs
|
|
84
|
+
as `agent`.
|
|
85
|
+
- **Exceptions:** none.
|
|
86
|
+
- **Applies to:** all CLIs. **Since:** cli-base 0.41.0. **Rulings:** none.
|
|
87
|
+
|
|
88
|
+
### WC-ACCT-6 · The most specific setting wins
|
|
89
|
+
|
|
90
|
+
A setting is read from the nearest of these sections: this profile's `personal` or `bot` entry, then the profile,
|
|
91
|
+
then every personal account or every bot (`personal.defaults`, `bot.defaults`), then `defaults`.
|
|
92
|
+
|
|
93
|
+
- **Why:** naming one account says more than naming all of them, so it must not be undone by a broader section.
|
|
94
|
+
- **Enforced by:** review only.
|
|
95
|
+
- **Example:** `defaults.sends_per_hour: 30` and `profiles.work.sends_per_hour: 10` give `work` a limit of 10.
|
|
96
|
+
- **Exceptions:** permissions layer the same way, with one more rule: see [WC-PERM-7](permissions.md).
|
|
97
|
+
- **Applies to:** messenger CLIs. **Since:** cli-base 0.41.0. **Rulings:** NEED-355.
|
|
98
|
+
|
|
99
|
+
### WC-ACCT-7 · Never pick an account inside a provider for the owner
|
|
100
|
+
|
|
101
|
+
When a provider has several accounts, the command takes `--account <account>` or reads all of them. It never takes the
|
|
102
|
+
first account in a list.
|
|
103
|
+
|
|
104
|
+
- **Why:** the same reason as WC-ACCT-1, one level down.
|
|
105
|
+
- **Enforced by:** review only.
|
|
106
|
+
- **Example:** `memo search mail "invoice"` reads every mailbox; `--source email:work` reads one.
|
|
107
|
+
- **Exceptions:** none.
|
|
108
|
+
- **Applies to:** all CLIs. **Since:** cli-base 0.41.0. **Rulings:** none.
|
|
109
|
+
|
|
110
|
+
### WC-ACCT-8 · Scope flags have one meaning in every CLI
|
|
111
|
+
|
|
112
|
+
`--account` names one account. `--provider` reads every account of one provider. `--source` takes a comma-separated
|
|
113
|
+
list of `provider:account`, a provider, a kind, or `group:<name>`. `--all-bots` also reads the other bots' copies that
|
|
114
|
+
the config allows.
|
|
115
|
+
|
|
116
|
+
- **Why:** an agent that learned a flag in one CLI must not be surprised by it in another.
|
|
117
|
+
- **Enforced by:** `flag-two-meanings` · `flag-synonym` · `option-role` · `same-flag-meaning`.
|
|
118
|
+
- **Example:** `memo search messages "invoice" --source telegram,max`.
|
|
119
|
+
- **Exceptions:** `same-flag-meaning` runs weekly and does not block a pull request.
|
|
120
|
+
- **Applies to:** all CLIs. **Since:** cli-base 0.41.0. **Rulings:** none.
|
|
121
|
+
|
|
122
|
+
### WC-ACCT-9 · A read across accounts covers all of them and says which it read
|
|
123
|
+
|
|
124
|
+
A read that is not limited to one account reads every account in its scope, and its answer names them, for example in
|
|
125
|
+
`coverage.accounts`.
|
|
126
|
+
|
|
127
|
+
- **Why:** an answer from part of the data must not look like an answer from all of it.
|
|
128
|
+
- **Enforced by:** review only.
|
|
129
|
+
- **Example:** `search messages` answers `coverage.accounts`; `search mail` names the mailboxes it read.
|
|
130
|
+
- **Exceptions:** a meaning search never reads wider than the running account unless `--source` says so. `search all`
|
|
131
|
+
reads meetings only when they are named. Not every cross-account read reports its accounts yet.
|
|
132
|
+
- **Applies to:** all CLIs. **Since:** cli-base 0.41.0. **Rulings:** ss:8.
|
|
133
|
+
|
|
134
|
+
### WC-ACCT-10 · A bot reads another bot's copy only when the config and the command both say so
|
|
135
|
+
|
|
136
|
+
- **Why:** each bot's local copy belongs to that bot; reading it is a choice, not a default.
|
|
137
|
+
- **Enforced by:** review only.
|
|
138
|
+
- **Example:** `read_other_bots: ["support"]` in the bot's section, and `--all-bots` or `--bots support` on the command.
|
|
139
|
+
- **Exceptions:** none.
|
|
140
|
+
- **Applies to:** messenger CLIs. **Since:** cli-base 0.41.0. **Rulings:** bots:12.
|
|
141
|
+
|
|
142
|
+
## Sources
|
|
143
|
+
|
|
144
|
+
These documents explain the rules on this page in more detail. Where one of them disagrees with this page, this page
|
|
145
|
+
holds.
|
|
146
|
+
|
|
147
|
+
- [cli-core `STANDARD.md`, "Command names"](https://github.com/WireCatLabs/cli-core/blob/main/docs/dev/STANDARD.md#command-names), rule 1
|
|
148
|
+
- [cli-core `ARCHITECTURE.md`](https://github.com/WireCatLabs/cli-core/blob/main/docs/dev/ARCHITECTURE.md), on the account-bound store
|