argsbarg 6.1.10 → 6.2.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 (130) hide show
  1. package/CHANGELOG.md +10 -1
  2. package/README.md +43 -41
  3. package/docs/README.md +3 -2
  4. package/docs/ai-skills.md +36 -23
  5. package/docs/cli-program.md +12 -11
  6. package/docs/config-schema.md +3 -3
  7. package/docs/configure.md +12 -16
  8. package/docs/developing.md +6 -6
  9. package/docs/mcp.md +21 -57
  10. package/docs/output-schema.md +2 -2
  11. package/examples/formats.ts +5 -6
  12. package/examples/full-example/README.md +7 -69
  13. package/examples/full-example/docs/cli-schema.json +1 -1659
  14. package/examples/full-example/docs/cli.md +2 -1538
  15. package/examples/full-example/docs/http.md +0 -7
  16. package/examples/full-example/docs/mcp.md +23 -59
  17. package/examples/full-example/docs/openapi.json +2 -782
  18. package/examples/full-example/docs/skill.md +18 -14
  19. package/examples/full-example/justfile +5 -17
  20. package/examples/full-example/scripts/create-identity.ts +2 -1
  21. package/examples/full-example/src/commands/status/command.test.ts +2 -2
  22. package/examples/full-example/src/commands/status/command.ts +7 -6
  23. package/examples/full-example/src/program.ts +4 -10
  24. package/examples/full-example-json/Formula/.gitkeep +0 -0
  25. package/examples/full-example-json/Formula/full-example-json.rb +35 -0
  26. package/examples/full-example-json/README.md +27 -0
  27. package/examples/full-example-json/biome.json +22 -0
  28. package/examples/full-example-json/bun.lock +48 -0
  29. package/examples/full-example-json/docs/README.md +27 -0
  30. package/examples/full-example-json/docs/cli-schema.json +2145 -0
  31. package/examples/full-example-json/docs/cli.md +1990 -0
  32. package/examples/full-example-json/docs/http.md +92 -0
  33. package/examples/full-example-json/docs/mcp.md +116 -0
  34. package/examples/full-example-json/docs/openapi.json +1246 -0
  35. package/examples/full-example-json/docs/skill.md +57 -0
  36. package/examples/full-example-json/justfile +171 -0
  37. package/examples/full-example-json/package.json +22 -0
  38. package/examples/full-example-json/scripts/create-identity.ts +12 -0
  39. package/examples/full-example-json/scripts/dev-formula.ts +97 -0
  40. package/examples/full-example-json/scripts/formula-shared.test.ts +68 -0
  41. package/examples/full-example-json/scripts/formula-shared.ts +170 -0
  42. package/examples/full-example-json/scripts/print-identity.ts +28 -0
  43. package/examples/full-example-json/scripts/release.ts +212 -0
  44. package/examples/full-example-json/src/commands/echo/command.ts +26 -0
  45. package/examples/full-example-json/src/commands/status/command.test.ts +10 -0
  46. package/examples/full-example-json/src/commands/status/command.ts +28 -0
  47. package/examples/full-example-json/src/index.ts +10 -0
  48. package/examples/full-example-json/src/program.ts +33 -0
  49. package/examples/full-example-json/src/types/md.d.ts +4 -0
  50. package/examples/full-example-json/tsconfig.json +17 -0
  51. package/examples/minimal.ts +17 -17
  52. package/examples/nested.ts +10 -10
  53. package/examples/option-required.ts +13 -13
  54. package/examples/servers.ts +10 -10
  55. package/index.d.ts +17 -43
  56. package/package.json +1 -1
  57. package/src/cli-tool/create.test.ts +44 -68
  58. package/src/cli-tool/create.ts +81 -17
  59. package/src/cli-tool/full-example-capabilities.test.ts +33 -18
  60. package/src/cli-tool/post-create.ts +31 -17
  61. package/src/cli-tool/program.ts +16 -7
  62. package/src/cli-tool/prompt.ts +27 -0
  63. package/src/cli-tool/run-create.ts +19 -7
  64. package/src/cli-tool/schemagen/schemagen.test.ts +3 -3
  65. package/src/configure/artifacts/install-validate.test.ts +20 -33
  66. package/src/configure/artifacts/paths.ts +9 -53
  67. package/src/configure/artifacts/status.test.ts +13 -16
  68. package/src/configure/artifacts/status.ts +5 -22
  69. package/src/configure/artifacts/target-base.ts +6 -15
  70. package/src/configure/artifacts/target-effective.ts +16 -54
  71. package/src/configure/artifacts/target-mcp-json.ts +2 -5
  72. package/src/configure/artifacts/target-registry.ts +0 -7
  73. package/src/configure/artifacts/target-scope.ts +7 -17
  74. package/src/configure/artifacts/target-skill.ts +6 -15
  75. package/src/configure/artifacts/target-types.ts +6 -54
  76. package/src/configure/artifacts/targets/agents-mcp.ts +11 -0
  77. package/src/configure/artifacts/targets/configure.ts +1 -5
  78. package/src/configure/artifacts/targets/index.ts +4 -44
  79. package/src/configure/artifacts/targets/skill.ts +12 -0
  80. package/src/configure/artifacts/targets.test.ts +21 -59
  81. package/src/configure/configure.test.ts +35 -46
  82. package/src/configure/index.ts +19 -19
  83. package/src/configure/prompt.ts +2 -12
  84. package/src/core/parse.test.ts +21 -32
  85. package/src/core/types.ts +18 -44
  86. package/src/core/validate.ts +28 -45
  87. package/src/docs/docs.test.ts +4 -4
  88. package/src/docs/mcp-guide.ts +41 -71
  89. package/src/docs/resolve.ts +1 -1
  90. package/src/exports/cli.ts +1 -1
  91. package/src/index.ts +1 -1
  92. package/src/skill/generate.ts +26 -45
  93. package/src/skill/install.ts +18 -38
  94. package/src/skill/naming.ts +3 -27
  95. package/src/test/integration/config.test.ts +3 -3
  96. package/src/test/integration/mcp.test.ts +4 -4
  97. package/{examples/mcp-test.ts → src/test/mcp-integration-fixture.ts} +20 -22
  98. package/src/configure/artifacts/target-mcp-cli.ts +0 -127
  99. package/src/configure/artifacts/targets/chatgpt-mcp.ts +0 -12
  100. package/src/configure/artifacts/targets/claude-code-mcp.ts +0 -15
  101. package/src/configure/artifacts/targets/claude-desktop-mcp.ts +0 -12
  102. package/src/configure/artifacts/targets/claude-skill.ts +0 -16
  103. package/src/configure/artifacts/targets/codex-mcp.ts +0 -25
  104. package/src/configure/artifacts/targets/codex-skill.ts +0 -14
  105. package/src/configure/artifacts/targets/cursor-mcp.ts +0 -15
  106. package/src/configure/artifacts/targets/cursor-skill.ts +0 -16
  107. package/src/configure/artifacts/targets/openclaw-mcp.ts +0 -25
  108. package/src/configure/artifacts/targets/openclaw-skill.ts +0 -17
  109. package/src/configure/artifacts/targets/opencode-mcp.ts +0 -96
  110. package/src/configure/artifacts/targets/opencode-skill.ts +0 -15
  111. /package/examples/{full-example → full-example-json}/src/commands/render-json/__generated__/RenderJsonInputSchema.json +0 -0
  112. /package/examples/{full-example → full-example-json}/src/commands/render-json/__generated__/index.ts +0 -0
  113. /package/examples/{full-example → full-example-json}/src/commands/render-json/command.test.ts +0 -0
  114. /package/examples/{full-example → full-example-json}/src/commands/render-json/command.ts +0 -0
  115. /package/examples/{full-example → full-example-json}/src/commands/render-json/types.ts +0 -0
  116. /package/examples/{full-example → full-example-json}/src/commands/status/__generated__/StatusJsonOutputSchema.json +0 -0
  117. /package/examples/{full-example → full-example-json}/src/commands/status/__generated__/index.ts +0 -0
  118. /package/examples/{full-example → full-example-json}/src/commands/status/types.ts +0 -0
  119. /package/examples/{full-example → full-example-json}/src/commands/workspaces/__generated__/WorkspaceNameInputSchema.json +0 -0
  120. /package/examples/{full-example → full-example-json}/src/commands/workspaces/__generated__/index.ts +0 -0
  121. /package/examples/{full-example → full-example-json}/src/commands/workspaces/command.test.ts +0 -0
  122. /package/examples/{full-example → full-example-json}/src/commands/workspaces/command.ts +0 -0
  123. /package/examples/{full-example → full-example-json}/src/commands/workspaces/types.ts +0 -0
  124. /package/examples/{full-example → full-example-json}/src/db/index.test.ts +0 -0
  125. /package/examples/{full-example → full-example-json}/src/db/index.ts +0 -0
  126. /package/examples/{full-example → full-example-json}/src/db/migrate.test.ts +0 -0
  127. /package/examples/{full-example → full-example-json}/src/db/migrate.ts +0 -0
  128. /package/examples/{full-example → full-example-json}/src/db/migrations/001_workspaces.sql +0 -0
  129. /package/examples/{full-example → full-example-json}/src/db/tables/workspaces.ts +0 -0
  130. /package/examples/{full-example → full-example-json}/src/types/argsbarg.d.ts +0 -0
@@ -2,20 +2,18 @@
2
2
 
3
3
  # full-example — CLI API reference
4
4
 
5
- Argsbarg full example reference app
5
+ Argsbarg CLI copy template (MCP, HTTP, configure, skills; no schemagen)
6
6
 
7
7
  Machine-readable export: `full-example docs cli-schema`
8
8
 
9
9
  ## `full-example`
10
10
 
11
- Argsbarg full example reference app
11
+ Argsbarg CLI copy template (MCP, HTTP, configure, skills; no schemagen)
12
12
 
13
13
  #### Subcommands
14
14
 
15
15
  - `echo` — Echo a message (MCP-friendly leaf).
16
- - `render-json` — Echo a JSON message (schema-first JSON leaf demo).
17
16
  - `status` — Show app version.
18
- - `workspaces` — Workspace collection and CRUD.
19
17
 
20
18
  ### `full-example echo`
21
19
 
@@ -236,219 +234,6 @@ HTTP API server for tools.
236
234
  | `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
237
235
  | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
238
236
 
239
- ### `full-example render-json`
240
-
241
- Echo a JSON message (schema-first JSON leaf demo).
242
-
243
- #### Subcommands
244
-
245
- - `version` — Print the program version.
246
- - `configure` — Set up agent skills and MCP config for this app (binary via Homebrew).
247
- - `docs` — Print bundled CLI documentation.
248
- - `mcp` — MCP server and bundle tools.
249
- - `http` — HTTP API server for tools.
250
-
251
- #### `full-example render-json version`
252
-
253
- Print the program version.
254
-
255
- #### `full-example render-json configure`
256
-
257
- Set up agent skills and MCP config for this app (binary via Homebrew).
258
-
259
- > Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
260
- >
261
- > Homebrew post_install runs:
262
- > full-example configure --sync --yes
263
- >
264
- > Interactive setup (per target):
265
- > full-example configure
266
- >
267
- > Upgrade:
268
- > brew upgrade full-example
269
- >
270
- > Shell completions are installed by Homebrew during brew install.
271
- > See: https://docs.brew.sh/Shell-Completion
272
- >
273
- > See what is installed:
274
- > full-example configure --status
275
- >
276
- > Uninstall:
277
- > brew uninstall <tap>/full-example
278
- >
279
- > The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
280
- >
281
- > Use --dry to preview changes without writing files.
282
- > Use --json for machine-readable output.
283
-
284
- **Default subcommand:** `run` (`missingOnly`)
285
-
286
- #### Options
287
-
288
- | Option | Type | Required | Format / default | Description |
289
- | --- | --- | --- | --- | --- |
290
- | `--sync` | flag | optional | — | Refresh installed skills and MCP. Used by Homebrew post_install. |
291
- | `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
292
- | `--status` | flag | optional | — | Print what is currently installed (read-only). |
293
- | `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
294
- | `--dry` | flag | optional | — | Show what would change without writing files. |
295
- | `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
296
-
297
- #### `full-example render-json docs`
298
-
299
- Print bundled CLI documentation.
300
-
301
- > Topics print to stdout. Add --save to write files under ./docs/.
302
-
303
- #### Options
304
-
305
- | Option | Type | Required | Format / default | Description |
306
- | --- | --- | --- | --- | --- |
307
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
308
-
309
- #### Subcommands
310
-
311
- - `readme` — Print README (user guide).
312
- - `mcp` — Print MCP server setup and tool guidance.
313
- - `http` — Print HTTP API setup and tool guidance.
314
- - `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
315
- - `cli-schema` — Print the full CLI command tree as JSON.
316
- - `cli` — Print the full command reference as markdown.
317
- - `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
318
-
319
- ##### `full-example render-json docs readme`
320
-
321
- Print README (user guide).
322
-
323
- #### Options
324
-
325
- | Option | Type | Required | Format / default | Description |
326
- | --- | --- | --- | --- | --- |
327
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
328
-
329
- ##### `full-example render-json docs mcp`
330
-
331
- Print MCP server setup and tool guidance.
332
-
333
- #### Options
334
-
335
- | Option | Type | Required | Format / default | Description |
336
- | --- | --- | --- | --- | --- |
337
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
338
-
339
- ##### `full-example render-json docs http`
340
-
341
- Print HTTP API setup and tool guidance.
342
-
343
- #### Options
344
-
345
- | Option | Type | Required | Format / default | Description |
346
- | --- | --- | --- | --- | --- |
347
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
348
-
349
- ##### `full-example render-json docs openapi`
350
-
351
- Print the HTTP OpenAPI 3.1 document as JSON.
352
-
353
- #### Options
354
-
355
- | Option | Type | Required | Format / default | Description |
356
- | --- | --- | --- | --- | --- |
357
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
358
-
359
- ##### `full-example render-json docs cli-schema`
360
-
361
- Print the full CLI command tree as JSON.
362
-
363
- #### Options
364
-
365
- | Option | Type | Required | Format / default | Description |
366
- | --- | --- | --- | --- | --- |
367
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
368
-
369
- ##### `full-example render-json docs cli`
370
-
371
- Print the full command reference as markdown.
372
-
373
- #### Options
374
-
375
- | Option | Type | Required | Format / default | Description |
376
- | --- | --- | --- | --- | --- |
377
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
378
-
379
- ##### `full-example render-json docs skill`
380
-
381
- Print a reference agent SKILL; run `configure` to install an optimized copy.
382
-
383
- #### Options
384
-
385
- | Option | Type | Required | Format / default | Description |
386
- | --- | --- | --- | --- | --- |
387
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
388
-
389
- #### `full-example render-json mcp`
390
-
391
- MCP server and bundle tools.
392
-
393
- > Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
394
- >
395
- > command: full-example
396
- > args: mcp
397
- >
398
- > Or:
399
- >
400
- > full-example configure
401
- >
402
- > Full setup guide: full-example docs mcp
403
-
404
- **Default subcommand:** `serve` (`missingOnly`)
405
-
406
- #### Options
407
-
408
- | Option | Type | Required | Format / default | Description |
409
- | --- | --- | --- | --- | --- |
410
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
411
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
412
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
413
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
414
-
415
- #### Subcommands
416
-
417
- - `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
418
-
419
- ##### `full-example render-json mcp bundle`
420
-
421
- Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
422
-
423
- #### `full-example render-json http`
424
-
425
- HTTP API server for tools.
426
-
427
- > HTTP tool server on http://127.0.0.1:3000.
428
- >
429
- > Endpoints: GET /health/liveness, GET /health/readiness, GET /openapi.json, GET /swagger, /*
430
- >
431
- > Configure app settings:
432
- >
433
- > full-example configure
434
- >
435
- > Full setup guide: full-example docs http
436
-
437
- **Default subcommand:** `serve` (`missingOnly`)
438
-
439
- #### Options
440
-
441
- | Option | Type | Required | Format / default | Description |
442
- | --- | --- | --- | --- | --- |
443
- | `--host` | string | optional | — | Listen host. |
444
- | `--port` | number | optional | — | Listen port. |
445
- | `--trust-proxy` | flag | optional | — | Honor X-Forwarded-For for client IP. |
446
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
447
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
448
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
449
- | `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
450
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
451
-
452
237
  ### `full-example status`
453
238
 
454
239
  Show app version.
@@ -459,28 +244,6 @@ Show app version.
459
244
  | --- | --- | --- | --- | --- |
460
245
  | `--json` | flag | optional | — | Emit JSON. |
461
246
 
462
- #### Output
463
-
464
- JSON Schema for output when/if handler emits JSON
465
-
466
- ```json
467
- {
468
- "$schema": "http://json-schema.org/draft-07/schema#",
469
- "type": "object",
470
- "properties": {
471
- "version": {
472
- "type": "string",
473
- "description": "App version from program root."
474
- }
475
- },
476
- "required": [
477
- "version"
478
- ],
479
- "additionalProperties": false,
480
- "definitions": {}
481
- }
482
- ```
483
-
484
247
  #### Subcommands
485
248
 
486
249
  - `version` — Print the program version.
@@ -689,1302 +452,3 @@ HTTP API server for tools.
689
452
  | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
690
453
  | `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
691
454
  | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
692
-
693
- ### `full-example workspaces`
694
-
695
- Workspace collection and CRUD.
696
-
697
- #### Subcommands
698
-
699
- - `get` — List workspaces.
700
- - `post` — Create a workspace.
701
- - `:id` — One workspace by id.
702
-
703
- #### `full-example workspaces get`
704
-
705
- List workspaces.
706
-
707
- #### Subcommands
708
-
709
- - `version` — Print the program version.
710
- - `configure` — Set up agent skills and MCP config for this app (binary via Homebrew).
711
- - `docs` — Print bundled CLI documentation.
712
- - `mcp` — MCP server and bundle tools.
713
- - `http` — HTTP API server for tools.
714
-
715
- ##### `full-example workspaces get version`
716
-
717
- Print the program version.
718
-
719
- ##### `full-example workspaces get configure`
720
-
721
- Set up agent skills and MCP config for this app (binary via Homebrew).
722
-
723
- > Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
724
- >
725
- > Homebrew post_install runs:
726
- > full-example configure --sync --yes
727
- >
728
- > Interactive setup (per target):
729
- > full-example configure
730
- >
731
- > Upgrade:
732
- > brew upgrade full-example
733
- >
734
- > Shell completions are installed by Homebrew during brew install.
735
- > See: https://docs.brew.sh/Shell-Completion
736
- >
737
- > See what is installed:
738
- > full-example configure --status
739
- >
740
- > Uninstall:
741
- > brew uninstall <tap>/full-example
742
- >
743
- > The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
744
- >
745
- > Use --dry to preview changes without writing files.
746
- > Use --json for machine-readable output.
747
-
748
- **Default subcommand:** `run` (`missingOnly`)
749
-
750
- #### Options
751
-
752
- | Option | Type | Required | Format / default | Description |
753
- | --- | --- | --- | --- | --- |
754
- | `--sync` | flag | optional | — | Refresh installed skills and MCP. Used by Homebrew post_install. |
755
- | `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
756
- | `--status` | flag | optional | — | Print what is currently installed (read-only). |
757
- | `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
758
- | `--dry` | flag | optional | — | Show what would change without writing files. |
759
- | `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
760
-
761
- ##### `full-example workspaces get docs`
762
-
763
- Print bundled CLI documentation.
764
-
765
- > Topics print to stdout. Add --save to write files under ./docs/.
766
-
767
- #### Options
768
-
769
- | Option | Type | Required | Format / default | Description |
770
- | --- | --- | --- | --- | --- |
771
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
772
-
773
- #### Subcommands
774
-
775
- - `readme` — Print README (user guide).
776
- - `mcp` — Print MCP server setup and tool guidance.
777
- - `http` — Print HTTP API setup and tool guidance.
778
- - `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
779
- - `cli-schema` — Print the full CLI command tree as JSON.
780
- - `cli` — Print the full command reference as markdown.
781
- - `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
782
-
783
- ###### `full-example workspaces get docs readme`
784
-
785
- Print README (user guide).
786
-
787
- #### Options
788
-
789
- | Option | Type | Required | Format / default | Description |
790
- | --- | --- | --- | --- | --- |
791
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
792
-
793
- ###### `full-example workspaces get docs mcp`
794
-
795
- Print MCP server setup and tool guidance.
796
-
797
- #### Options
798
-
799
- | Option | Type | Required | Format / default | Description |
800
- | --- | --- | --- | --- | --- |
801
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
802
-
803
- ###### `full-example workspaces get docs http`
804
-
805
- Print HTTP API setup and tool guidance.
806
-
807
- #### Options
808
-
809
- | Option | Type | Required | Format / default | Description |
810
- | --- | --- | --- | --- | --- |
811
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
812
-
813
- ###### `full-example workspaces get docs openapi`
814
-
815
- Print the HTTP OpenAPI 3.1 document as JSON.
816
-
817
- #### Options
818
-
819
- | Option | Type | Required | Format / default | Description |
820
- | --- | --- | --- | --- | --- |
821
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
822
-
823
- ###### `full-example workspaces get docs cli-schema`
824
-
825
- Print the full CLI command tree as JSON.
826
-
827
- #### Options
828
-
829
- | Option | Type | Required | Format / default | Description |
830
- | --- | --- | --- | --- | --- |
831
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
832
-
833
- ###### `full-example workspaces get docs cli`
834
-
835
- Print the full command reference as markdown.
836
-
837
- #### Options
838
-
839
- | Option | Type | Required | Format / default | Description |
840
- | --- | --- | --- | --- | --- |
841
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
842
-
843
- ###### `full-example workspaces get docs skill`
844
-
845
- Print a reference agent SKILL; run `configure` to install an optimized copy.
846
-
847
- #### Options
848
-
849
- | Option | Type | Required | Format / default | Description |
850
- | --- | --- | --- | --- | --- |
851
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
852
-
853
- ##### `full-example workspaces get mcp`
854
-
855
- MCP server and bundle tools.
856
-
857
- > Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
858
- >
859
- > command: full-example
860
- > args: mcp
861
- >
862
- > Or:
863
- >
864
- > full-example configure
865
- >
866
- > Full setup guide: full-example docs mcp
867
-
868
- **Default subcommand:** `serve` (`missingOnly`)
869
-
870
- #### Options
871
-
872
- | Option | Type | Required | Format / default | Description |
873
- | --- | --- | --- | --- | --- |
874
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
875
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
876
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
877
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
878
-
879
- #### Subcommands
880
-
881
- - `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
882
-
883
- ###### `full-example workspaces get mcp bundle`
884
-
885
- Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
886
-
887
- ##### `full-example workspaces get http`
888
-
889
- HTTP API server for tools.
890
-
891
- > HTTP tool server on http://127.0.0.1:3000.
892
- >
893
- > Endpoints: GET /health/liveness, GET /health/readiness, GET /openapi.json, GET /swagger, /*
894
- >
895
- > Configure app settings:
896
- >
897
- > full-example configure
898
- >
899
- > Full setup guide: full-example docs http
900
-
901
- **Default subcommand:** `serve` (`missingOnly`)
902
-
903
- #### Options
904
-
905
- | Option | Type | Required | Format / default | Description |
906
- | --- | --- | --- | --- | --- |
907
- | `--host` | string | optional | — | Listen host. |
908
- | `--port` | number | optional | — | Listen port. |
909
- | `--trust-proxy` | flag | optional | — | Honor X-Forwarded-For for client IP. |
910
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
911
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
912
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
913
- | `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
914
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
915
-
916
- #### `full-example workspaces post`
917
-
918
- Create a workspace.
919
-
920
- #### Subcommands
921
-
922
- - `version` — Print the program version.
923
- - `configure` — Set up agent skills and MCP config for this app (binary via Homebrew).
924
- - `docs` — Print bundled CLI documentation.
925
- - `mcp` — MCP server and bundle tools.
926
- - `http` — HTTP API server for tools.
927
-
928
- ##### `full-example workspaces post version`
929
-
930
- Print the program version.
931
-
932
- ##### `full-example workspaces post configure`
933
-
934
- Set up agent skills and MCP config for this app (binary via Homebrew).
935
-
936
- > Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
937
- >
938
- > Homebrew post_install runs:
939
- > full-example configure --sync --yes
940
- >
941
- > Interactive setup (per target):
942
- > full-example configure
943
- >
944
- > Upgrade:
945
- > brew upgrade full-example
946
- >
947
- > Shell completions are installed by Homebrew during brew install.
948
- > See: https://docs.brew.sh/Shell-Completion
949
- >
950
- > See what is installed:
951
- > full-example configure --status
952
- >
953
- > Uninstall:
954
- > brew uninstall <tap>/full-example
955
- >
956
- > The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
957
- >
958
- > Use --dry to preview changes without writing files.
959
- > Use --json for machine-readable output.
960
-
961
- **Default subcommand:** `run` (`missingOnly`)
962
-
963
- #### Options
964
-
965
- | Option | Type | Required | Format / default | Description |
966
- | --- | --- | --- | --- | --- |
967
- | `--sync` | flag | optional | — | Refresh installed skills and MCP. Used by Homebrew post_install. |
968
- | `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
969
- | `--status` | flag | optional | — | Print what is currently installed (read-only). |
970
- | `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
971
- | `--dry` | flag | optional | — | Show what would change without writing files. |
972
- | `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
973
-
974
- ##### `full-example workspaces post docs`
975
-
976
- Print bundled CLI documentation.
977
-
978
- > Topics print to stdout. Add --save to write files under ./docs/.
979
-
980
- #### Options
981
-
982
- | Option | Type | Required | Format / default | Description |
983
- | --- | --- | --- | --- | --- |
984
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
985
-
986
- #### Subcommands
987
-
988
- - `readme` — Print README (user guide).
989
- - `mcp` — Print MCP server setup and tool guidance.
990
- - `http` — Print HTTP API setup and tool guidance.
991
- - `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
992
- - `cli-schema` — Print the full CLI command tree as JSON.
993
- - `cli` — Print the full command reference as markdown.
994
- - `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
995
-
996
- ###### `full-example workspaces post docs readme`
997
-
998
- Print README (user guide).
999
-
1000
- #### Options
1001
-
1002
- | Option | Type | Required | Format / default | Description |
1003
- | --- | --- | --- | --- | --- |
1004
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1005
-
1006
- ###### `full-example workspaces post docs mcp`
1007
-
1008
- Print MCP server setup and tool guidance.
1009
-
1010
- #### Options
1011
-
1012
- | Option | Type | Required | Format / default | Description |
1013
- | --- | --- | --- | --- | --- |
1014
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1015
-
1016
- ###### `full-example workspaces post docs http`
1017
-
1018
- Print HTTP API setup and tool guidance.
1019
-
1020
- #### Options
1021
-
1022
- | Option | Type | Required | Format / default | Description |
1023
- | --- | --- | --- | --- | --- |
1024
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1025
-
1026
- ###### `full-example workspaces post docs openapi`
1027
-
1028
- Print the HTTP OpenAPI 3.1 document as JSON.
1029
-
1030
- #### Options
1031
-
1032
- | Option | Type | Required | Format / default | Description |
1033
- | --- | --- | --- | --- | --- |
1034
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1035
-
1036
- ###### `full-example workspaces post docs cli-schema`
1037
-
1038
- Print the full CLI command tree as JSON.
1039
-
1040
- #### Options
1041
-
1042
- | Option | Type | Required | Format / default | Description |
1043
- | --- | --- | --- | --- | --- |
1044
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1045
-
1046
- ###### `full-example workspaces post docs cli`
1047
-
1048
- Print the full command reference as markdown.
1049
-
1050
- #### Options
1051
-
1052
- | Option | Type | Required | Format / default | Description |
1053
- | --- | --- | --- | --- | --- |
1054
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1055
-
1056
- ###### `full-example workspaces post docs skill`
1057
-
1058
- Print a reference agent SKILL; run `configure` to install an optimized copy.
1059
-
1060
- #### Options
1061
-
1062
- | Option | Type | Required | Format / default | Description |
1063
- | --- | --- | --- | --- | --- |
1064
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1065
-
1066
- ##### `full-example workspaces post mcp`
1067
-
1068
- MCP server and bundle tools.
1069
-
1070
- > Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
1071
- >
1072
- > command: full-example
1073
- > args: mcp
1074
- >
1075
- > Or:
1076
- >
1077
- > full-example configure
1078
- >
1079
- > Full setup guide: full-example docs mcp
1080
-
1081
- **Default subcommand:** `serve` (`missingOnly`)
1082
-
1083
- #### Options
1084
-
1085
- | Option | Type | Required | Format / default | Description |
1086
- | --- | --- | --- | --- | --- |
1087
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1088
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1089
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1090
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
1091
-
1092
- #### Subcommands
1093
-
1094
- - `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1095
-
1096
- ###### `full-example workspaces post mcp bundle`
1097
-
1098
- Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1099
-
1100
- ##### `full-example workspaces post http`
1101
-
1102
- HTTP API server for tools.
1103
-
1104
- > HTTP tool server on http://127.0.0.1:3000.
1105
- >
1106
- > Endpoints: GET /health/liveness, GET /health/readiness, GET /openapi.json, GET /swagger, /*
1107
- >
1108
- > Configure app settings:
1109
- >
1110
- > full-example configure
1111
- >
1112
- > Full setup guide: full-example docs http
1113
-
1114
- **Default subcommand:** `serve` (`missingOnly`)
1115
-
1116
- #### Options
1117
-
1118
- | Option | Type | Required | Format / default | Description |
1119
- | --- | --- | --- | --- | --- |
1120
- | `--host` | string | optional | — | Listen host. |
1121
- | `--port` | number | optional | — | Listen port. |
1122
- | `--trust-proxy` | flag | optional | — | Honor X-Forwarded-For for client IP. |
1123
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1124
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1125
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1126
- | `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
1127
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
1128
-
1129
- #### `full-example workspaces :id`
1130
-
1131
- One workspace by id.
1132
-
1133
- #### Subcommands
1134
-
1135
- - `get` — Get one workspace.
1136
- - `put` — Replace a workspace.
1137
- - `patch` — Patch a workspace name.
1138
- - `delete` — Delete a workspace.
1139
-
1140
- ##### `full-example workspaces :id get`
1141
-
1142
- Get one workspace.
1143
-
1144
- #### Subcommands
1145
-
1146
- - `version` — Print the program version.
1147
- - `configure` — Set up agent skills and MCP config for this app (binary via Homebrew).
1148
- - `docs` — Print bundled CLI documentation.
1149
- - `mcp` — MCP server and bundle tools.
1150
- - `http` — HTTP API server for tools.
1151
-
1152
- ###### `full-example workspaces :id get version`
1153
-
1154
- Print the program version.
1155
-
1156
- ###### `full-example workspaces :id get configure`
1157
-
1158
- Set up agent skills and MCP config for this app (binary via Homebrew).
1159
-
1160
- > Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
1161
- >
1162
- > Homebrew post_install runs:
1163
- > full-example configure --sync --yes
1164
- >
1165
- > Interactive setup (per target):
1166
- > full-example configure
1167
- >
1168
- > Upgrade:
1169
- > brew upgrade full-example
1170
- >
1171
- > Shell completions are installed by Homebrew during brew install.
1172
- > See: https://docs.brew.sh/Shell-Completion
1173
- >
1174
- > See what is installed:
1175
- > full-example configure --status
1176
- >
1177
- > Uninstall:
1178
- > brew uninstall <tap>/full-example
1179
- >
1180
- > The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
1181
- >
1182
- > Use --dry to preview changes without writing files.
1183
- > Use --json for machine-readable output.
1184
-
1185
- **Default subcommand:** `run` (`missingOnly`)
1186
-
1187
- #### Options
1188
-
1189
- | Option | Type | Required | Format / default | Description |
1190
- | --- | --- | --- | --- | --- |
1191
- | `--sync` | flag | optional | — | Refresh installed skills and MCP. Used by Homebrew post_install. |
1192
- | `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
1193
- | `--status` | flag | optional | — | Print what is currently installed (read-only). |
1194
- | `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
1195
- | `--dry` | flag | optional | — | Show what would change without writing files. |
1196
- | `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
1197
-
1198
- ###### `full-example workspaces :id get docs`
1199
-
1200
- Print bundled CLI documentation.
1201
-
1202
- > Topics print to stdout. Add --save to write files under ./docs/.
1203
-
1204
- #### Options
1205
-
1206
- | Option | Type | Required | Format / default | Description |
1207
- | --- | --- | --- | --- | --- |
1208
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1209
-
1210
- #### Subcommands
1211
-
1212
- - `readme` — Print README (user guide).
1213
- - `mcp` — Print MCP server setup and tool guidance.
1214
- - `http` — Print HTTP API setup and tool guidance.
1215
- - `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
1216
- - `cli-schema` — Print the full CLI command tree as JSON.
1217
- - `cli` — Print the full command reference as markdown.
1218
- - `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
1219
-
1220
- ###### `full-example workspaces :id get docs readme`
1221
-
1222
- Print README (user guide).
1223
-
1224
- #### Options
1225
-
1226
- | Option | Type | Required | Format / default | Description |
1227
- | --- | --- | --- | --- | --- |
1228
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1229
-
1230
- ###### `full-example workspaces :id get docs mcp`
1231
-
1232
- Print MCP server setup and tool guidance.
1233
-
1234
- #### Options
1235
-
1236
- | Option | Type | Required | Format / default | Description |
1237
- | --- | --- | --- | --- | --- |
1238
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1239
-
1240
- ###### `full-example workspaces :id get docs http`
1241
-
1242
- Print HTTP API setup and tool guidance.
1243
-
1244
- #### Options
1245
-
1246
- | Option | Type | Required | Format / default | Description |
1247
- | --- | --- | --- | --- | --- |
1248
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1249
-
1250
- ###### `full-example workspaces :id get docs openapi`
1251
-
1252
- Print the HTTP OpenAPI 3.1 document as JSON.
1253
-
1254
- #### Options
1255
-
1256
- | Option | Type | Required | Format / default | Description |
1257
- | --- | --- | --- | --- | --- |
1258
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1259
-
1260
- ###### `full-example workspaces :id get docs cli-schema`
1261
-
1262
- Print the full CLI command tree as JSON.
1263
-
1264
- #### Options
1265
-
1266
- | Option | Type | Required | Format / default | Description |
1267
- | --- | --- | --- | --- | --- |
1268
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1269
-
1270
- ###### `full-example workspaces :id get docs cli`
1271
-
1272
- Print the full command reference as markdown.
1273
-
1274
- #### Options
1275
-
1276
- | Option | Type | Required | Format / default | Description |
1277
- | --- | --- | --- | --- | --- |
1278
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1279
-
1280
- ###### `full-example workspaces :id get docs skill`
1281
-
1282
- Print a reference agent SKILL; run `configure` to install an optimized copy.
1283
-
1284
- #### Options
1285
-
1286
- | Option | Type | Required | Format / default | Description |
1287
- | --- | --- | --- | --- | --- |
1288
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1289
-
1290
- ###### `full-example workspaces :id get mcp`
1291
-
1292
- MCP server and bundle tools.
1293
-
1294
- > Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
1295
- >
1296
- > command: full-example
1297
- > args: mcp
1298
- >
1299
- > Or:
1300
- >
1301
- > full-example configure
1302
- >
1303
- > Full setup guide: full-example docs mcp
1304
-
1305
- **Default subcommand:** `serve` (`missingOnly`)
1306
-
1307
- #### Options
1308
-
1309
- | Option | Type | Required | Format / default | Description |
1310
- | --- | --- | --- | --- | --- |
1311
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1312
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1313
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1314
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
1315
-
1316
- #### Subcommands
1317
-
1318
- - `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1319
-
1320
- ###### `full-example workspaces :id get mcp bundle`
1321
-
1322
- Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1323
-
1324
- ###### `full-example workspaces :id get http`
1325
-
1326
- HTTP API server for tools.
1327
-
1328
- > HTTP tool server on http://127.0.0.1:3000.
1329
- >
1330
- > Endpoints: GET /health/liveness, GET /health/readiness, GET /openapi.json, GET /swagger, /*
1331
- >
1332
- > Configure app settings:
1333
- >
1334
- > full-example configure
1335
- >
1336
- > Full setup guide: full-example docs http
1337
-
1338
- **Default subcommand:** `serve` (`missingOnly`)
1339
-
1340
- #### Options
1341
-
1342
- | Option | Type | Required | Format / default | Description |
1343
- | --- | --- | --- | --- | --- |
1344
- | `--host` | string | optional | — | Listen host. |
1345
- | `--port` | number | optional | — | Listen port. |
1346
- | `--trust-proxy` | flag | optional | — | Honor X-Forwarded-For for client IP. |
1347
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1348
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1349
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1350
- | `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
1351
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
1352
-
1353
- ##### `full-example workspaces :id put`
1354
-
1355
- Replace a workspace.
1356
-
1357
- #### Subcommands
1358
-
1359
- - `version` — Print the program version.
1360
- - `configure` — Set up agent skills and MCP config for this app (binary via Homebrew).
1361
- - `docs` — Print bundled CLI documentation.
1362
- - `mcp` — MCP server and bundle tools.
1363
- - `http` — HTTP API server for tools.
1364
-
1365
- ###### `full-example workspaces :id put version`
1366
-
1367
- Print the program version.
1368
-
1369
- ###### `full-example workspaces :id put configure`
1370
-
1371
- Set up agent skills and MCP config for this app (binary via Homebrew).
1372
-
1373
- > Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
1374
- >
1375
- > Homebrew post_install runs:
1376
- > full-example configure --sync --yes
1377
- >
1378
- > Interactive setup (per target):
1379
- > full-example configure
1380
- >
1381
- > Upgrade:
1382
- > brew upgrade full-example
1383
- >
1384
- > Shell completions are installed by Homebrew during brew install.
1385
- > See: https://docs.brew.sh/Shell-Completion
1386
- >
1387
- > See what is installed:
1388
- > full-example configure --status
1389
- >
1390
- > Uninstall:
1391
- > brew uninstall <tap>/full-example
1392
- >
1393
- > The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
1394
- >
1395
- > Use --dry to preview changes without writing files.
1396
- > Use --json for machine-readable output.
1397
-
1398
- **Default subcommand:** `run` (`missingOnly`)
1399
-
1400
- #### Options
1401
-
1402
- | Option | Type | Required | Format / default | Description |
1403
- | --- | --- | --- | --- | --- |
1404
- | `--sync` | flag | optional | — | Refresh installed skills and MCP. Used by Homebrew post_install. |
1405
- | `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
1406
- | `--status` | flag | optional | — | Print what is currently installed (read-only). |
1407
- | `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
1408
- | `--dry` | flag | optional | — | Show what would change without writing files. |
1409
- | `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
1410
-
1411
- ###### `full-example workspaces :id put docs`
1412
-
1413
- Print bundled CLI documentation.
1414
-
1415
- > Topics print to stdout. Add --save to write files under ./docs/.
1416
-
1417
- #### Options
1418
-
1419
- | Option | Type | Required | Format / default | Description |
1420
- | --- | --- | --- | --- | --- |
1421
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1422
-
1423
- #### Subcommands
1424
-
1425
- - `readme` — Print README (user guide).
1426
- - `mcp` — Print MCP server setup and tool guidance.
1427
- - `http` — Print HTTP API setup and tool guidance.
1428
- - `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
1429
- - `cli-schema` — Print the full CLI command tree as JSON.
1430
- - `cli` — Print the full command reference as markdown.
1431
- - `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
1432
-
1433
- ###### `full-example workspaces :id put docs readme`
1434
-
1435
- Print README (user guide).
1436
-
1437
- #### Options
1438
-
1439
- | Option | Type | Required | Format / default | Description |
1440
- | --- | --- | --- | --- | --- |
1441
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1442
-
1443
- ###### `full-example workspaces :id put docs mcp`
1444
-
1445
- Print MCP server setup and tool guidance.
1446
-
1447
- #### Options
1448
-
1449
- | Option | Type | Required | Format / default | Description |
1450
- | --- | --- | --- | --- | --- |
1451
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1452
-
1453
- ###### `full-example workspaces :id put docs http`
1454
-
1455
- Print HTTP API setup and tool guidance.
1456
-
1457
- #### Options
1458
-
1459
- | Option | Type | Required | Format / default | Description |
1460
- | --- | --- | --- | --- | --- |
1461
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1462
-
1463
- ###### `full-example workspaces :id put docs openapi`
1464
-
1465
- Print the HTTP OpenAPI 3.1 document as JSON.
1466
-
1467
- #### Options
1468
-
1469
- | Option | Type | Required | Format / default | Description |
1470
- | --- | --- | --- | --- | --- |
1471
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1472
-
1473
- ###### `full-example workspaces :id put docs cli-schema`
1474
-
1475
- Print the full CLI command tree as JSON.
1476
-
1477
- #### Options
1478
-
1479
- | Option | Type | Required | Format / default | Description |
1480
- | --- | --- | --- | --- | --- |
1481
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1482
-
1483
- ###### `full-example workspaces :id put docs cli`
1484
-
1485
- Print the full command reference as markdown.
1486
-
1487
- #### Options
1488
-
1489
- | Option | Type | Required | Format / default | Description |
1490
- | --- | --- | --- | --- | --- |
1491
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1492
-
1493
- ###### `full-example workspaces :id put docs skill`
1494
-
1495
- Print a reference agent SKILL; run `configure` to install an optimized copy.
1496
-
1497
- #### Options
1498
-
1499
- | Option | Type | Required | Format / default | Description |
1500
- | --- | --- | --- | --- | --- |
1501
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1502
-
1503
- ###### `full-example workspaces :id put mcp`
1504
-
1505
- MCP server and bundle tools.
1506
-
1507
- > Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
1508
- >
1509
- > command: full-example
1510
- > args: mcp
1511
- >
1512
- > Or:
1513
- >
1514
- > full-example configure
1515
- >
1516
- > Full setup guide: full-example docs mcp
1517
-
1518
- **Default subcommand:** `serve` (`missingOnly`)
1519
-
1520
- #### Options
1521
-
1522
- | Option | Type | Required | Format / default | Description |
1523
- | --- | --- | --- | --- | --- |
1524
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1525
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1526
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1527
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
1528
-
1529
- #### Subcommands
1530
-
1531
- - `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1532
-
1533
- ###### `full-example workspaces :id put mcp bundle`
1534
-
1535
- Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1536
-
1537
- ###### `full-example workspaces :id put http`
1538
-
1539
- HTTP API server for tools.
1540
-
1541
- > HTTP tool server on http://127.0.0.1:3000.
1542
- >
1543
- > Endpoints: GET /health/liveness, GET /health/readiness, GET /openapi.json, GET /swagger, /*
1544
- >
1545
- > Configure app settings:
1546
- >
1547
- > full-example configure
1548
- >
1549
- > Full setup guide: full-example docs http
1550
-
1551
- **Default subcommand:** `serve` (`missingOnly`)
1552
-
1553
- #### Options
1554
-
1555
- | Option | Type | Required | Format / default | Description |
1556
- | --- | --- | --- | --- | --- |
1557
- | `--host` | string | optional | — | Listen host. |
1558
- | `--port` | number | optional | — | Listen port. |
1559
- | `--trust-proxy` | flag | optional | — | Honor X-Forwarded-For for client IP. |
1560
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1561
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1562
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1563
- | `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
1564
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
1565
-
1566
- ##### `full-example workspaces :id patch`
1567
-
1568
- Patch a workspace name.
1569
-
1570
- #### Subcommands
1571
-
1572
- - `version` — Print the program version.
1573
- - `configure` — Set up agent skills and MCP config for this app (binary via Homebrew).
1574
- - `docs` — Print bundled CLI documentation.
1575
- - `mcp` — MCP server and bundle tools.
1576
- - `http` — HTTP API server for tools.
1577
-
1578
- ###### `full-example workspaces :id patch version`
1579
-
1580
- Print the program version.
1581
-
1582
- ###### `full-example workspaces :id patch configure`
1583
-
1584
- Set up agent skills and MCP config for this app (binary via Homebrew).
1585
-
1586
- > Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
1587
- >
1588
- > Homebrew post_install runs:
1589
- > full-example configure --sync --yes
1590
- >
1591
- > Interactive setup (per target):
1592
- > full-example configure
1593
- >
1594
- > Upgrade:
1595
- > brew upgrade full-example
1596
- >
1597
- > Shell completions are installed by Homebrew during brew install.
1598
- > See: https://docs.brew.sh/Shell-Completion
1599
- >
1600
- > See what is installed:
1601
- > full-example configure --status
1602
- >
1603
- > Uninstall:
1604
- > brew uninstall <tap>/full-example
1605
- >
1606
- > The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
1607
- >
1608
- > Use --dry to preview changes without writing files.
1609
- > Use --json for machine-readable output.
1610
-
1611
- **Default subcommand:** `run` (`missingOnly`)
1612
-
1613
- #### Options
1614
-
1615
- | Option | Type | Required | Format / default | Description |
1616
- | --- | --- | --- | --- | --- |
1617
- | `--sync` | flag | optional | — | Refresh installed skills and MCP. Used by Homebrew post_install. |
1618
- | `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
1619
- | `--status` | flag | optional | — | Print what is currently installed (read-only). |
1620
- | `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
1621
- | `--dry` | flag | optional | — | Show what would change without writing files. |
1622
- | `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
1623
-
1624
- ###### `full-example workspaces :id patch docs`
1625
-
1626
- Print bundled CLI documentation.
1627
-
1628
- > Topics print to stdout. Add --save to write files under ./docs/.
1629
-
1630
- #### Options
1631
-
1632
- | Option | Type | Required | Format / default | Description |
1633
- | --- | --- | --- | --- | --- |
1634
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1635
-
1636
- #### Subcommands
1637
-
1638
- - `readme` — Print README (user guide).
1639
- - `mcp` — Print MCP server setup and tool guidance.
1640
- - `http` — Print HTTP API setup and tool guidance.
1641
- - `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
1642
- - `cli-schema` — Print the full CLI command tree as JSON.
1643
- - `cli` — Print the full command reference as markdown.
1644
- - `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
1645
-
1646
- ###### `full-example workspaces :id patch docs readme`
1647
-
1648
- Print README (user guide).
1649
-
1650
- #### Options
1651
-
1652
- | Option | Type | Required | Format / default | Description |
1653
- | --- | --- | --- | --- | --- |
1654
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1655
-
1656
- ###### `full-example workspaces :id patch docs mcp`
1657
-
1658
- Print MCP server setup and tool guidance.
1659
-
1660
- #### Options
1661
-
1662
- | Option | Type | Required | Format / default | Description |
1663
- | --- | --- | --- | --- | --- |
1664
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1665
-
1666
- ###### `full-example workspaces :id patch docs http`
1667
-
1668
- Print HTTP API setup and tool guidance.
1669
-
1670
- #### Options
1671
-
1672
- | Option | Type | Required | Format / default | Description |
1673
- | --- | --- | --- | --- | --- |
1674
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1675
-
1676
- ###### `full-example workspaces :id patch docs openapi`
1677
-
1678
- Print the HTTP OpenAPI 3.1 document as JSON.
1679
-
1680
- #### Options
1681
-
1682
- | Option | Type | Required | Format / default | Description |
1683
- | --- | --- | --- | --- | --- |
1684
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1685
-
1686
- ###### `full-example workspaces :id patch docs cli-schema`
1687
-
1688
- Print the full CLI command tree as JSON.
1689
-
1690
- #### Options
1691
-
1692
- | Option | Type | Required | Format / default | Description |
1693
- | --- | --- | --- | --- | --- |
1694
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1695
-
1696
- ###### `full-example workspaces :id patch docs cli`
1697
-
1698
- Print the full command reference as markdown.
1699
-
1700
- #### Options
1701
-
1702
- | Option | Type | Required | Format / default | Description |
1703
- | --- | --- | --- | --- | --- |
1704
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1705
-
1706
- ###### `full-example workspaces :id patch docs skill`
1707
-
1708
- Print a reference agent SKILL; run `configure` to install an optimized copy.
1709
-
1710
- #### Options
1711
-
1712
- | Option | Type | Required | Format / default | Description |
1713
- | --- | --- | --- | --- | --- |
1714
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1715
-
1716
- ###### `full-example workspaces :id patch mcp`
1717
-
1718
- MCP server and bundle tools.
1719
-
1720
- > Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
1721
- >
1722
- > command: full-example
1723
- > args: mcp
1724
- >
1725
- > Or:
1726
- >
1727
- > full-example configure
1728
- >
1729
- > Full setup guide: full-example docs mcp
1730
-
1731
- **Default subcommand:** `serve` (`missingOnly`)
1732
-
1733
- #### Options
1734
-
1735
- | Option | Type | Required | Format / default | Description |
1736
- | --- | --- | --- | --- | --- |
1737
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1738
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1739
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1740
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
1741
-
1742
- #### Subcommands
1743
-
1744
- - `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1745
-
1746
- ###### `full-example workspaces :id patch mcp bundle`
1747
-
1748
- Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1749
-
1750
- ###### `full-example workspaces :id patch http`
1751
-
1752
- HTTP API server for tools.
1753
-
1754
- > HTTP tool server on http://127.0.0.1:3000.
1755
- >
1756
- > Endpoints: GET /health/liveness, GET /health/readiness, GET /openapi.json, GET /swagger, /*
1757
- >
1758
- > Configure app settings:
1759
- >
1760
- > full-example configure
1761
- >
1762
- > Full setup guide: full-example docs http
1763
-
1764
- **Default subcommand:** `serve` (`missingOnly`)
1765
-
1766
- #### Options
1767
-
1768
- | Option | Type | Required | Format / default | Description |
1769
- | --- | --- | --- | --- | --- |
1770
- | `--host` | string | optional | — | Listen host. |
1771
- | `--port` | number | optional | — | Listen port. |
1772
- | `--trust-proxy` | flag | optional | — | Honor X-Forwarded-For for client IP. |
1773
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1774
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1775
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1776
- | `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
1777
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
1778
-
1779
- ##### `full-example workspaces :id delete`
1780
-
1781
- Delete a workspace.
1782
-
1783
- #### Subcommands
1784
-
1785
- - `version` — Print the program version.
1786
- - `configure` — Set up agent skills and MCP config for this app (binary via Homebrew).
1787
- - `docs` — Print bundled CLI documentation.
1788
- - `mcp` — MCP server and bundle tools.
1789
- - `http` — HTTP API server for tools.
1790
-
1791
- ###### `full-example workspaces :id delete version`
1792
-
1793
- Print the program version.
1794
-
1795
- ###### `full-example workspaces :id delete configure`
1796
-
1797
- Set up agent skills and MCP config for this app (binary via Homebrew).
1798
-
1799
- > Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
1800
- >
1801
- > Homebrew post_install runs:
1802
- > full-example configure --sync --yes
1803
- >
1804
- > Interactive setup (per target):
1805
- > full-example configure
1806
- >
1807
- > Upgrade:
1808
- > brew upgrade full-example
1809
- >
1810
- > Shell completions are installed by Homebrew during brew install.
1811
- > See: https://docs.brew.sh/Shell-Completion
1812
- >
1813
- > See what is installed:
1814
- > full-example configure --status
1815
- >
1816
- > Uninstall:
1817
- > brew uninstall <tap>/full-example
1818
- >
1819
- > The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
1820
- >
1821
- > Use --dry to preview changes without writing files.
1822
- > Use --json for machine-readable output.
1823
-
1824
- **Default subcommand:** `run` (`missingOnly`)
1825
-
1826
- #### Options
1827
-
1828
- | Option | Type | Required | Format / default | Description |
1829
- | --- | --- | --- | --- | --- |
1830
- | `--sync` | flag | optional | — | Refresh installed skills and MCP. Used by Homebrew post_install. |
1831
- | `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
1832
- | `--status` | flag | optional | — | Print what is currently installed (read-only). |
1833
- | `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
1834
- | `--dry` | flag | optional | — | Show what would change without writing files. |
1835
- | `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
1836
-
1837
- ###### `full-example workspaces :id delete docs`
1838
-
1839
- Print bundled CLI documentation.
1840
-
1841
- > Topics print to stdout. Add --save to write files under ./docs/.
1842
-
1843
- #### Options
1844
-
1845
- | Option | Type | Required | Format / default | Description |
1846
- | --- | --- | --- | --- | --- |
1847
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1848
-
1849
- #### Subcommands
1850
-
1851
- - `readme` — Print README (user guide).
1852
- - `mcp` — Print MCP server setup and tool guidance.
1853
- - `http` — Print HTTP API setup and tool guidance.
1854
- - `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
1855
- - `cli-schema` — Print the full CLI command tree as JSON.
1856
- - `cli` — Print the full command reference as markdown.
1857
- - `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
1858
-
1859
- ###### `full-example workspaces :id delete docs readme`
1860
-
1861
- Print README (user guide).
1862
-
1863
- #### Options
1864
-
1865
- | Option | Type | Required | Format / default | Description |
1866
- | --- | --- | --- | --- | --- |
1867
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1868
-
1869
- ###### `full-example workspaces :id delete docs mcp`
1870
-
1871
- Print MCP server setup and tool guidance.
1872
-
1873
- #### Options
1874
-
1875
- | Option | Type | Required | Format / default | Description |
1876
- | --- | --- | --- | --- | --- |
1877
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1878
-
1879
- ###### `full-example workspaces :id delete docs http`
1880
-
1881
- Print HTTP API setup and tool guidance.
1882
-
1883
- #### Options
1884
-
1885
- | Option | Type | Required | Format / default | Description |
1886
- | --- | --- | --- | --- | --- |
1887
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1888
-
1889
- ###### `full-example workspaces :id delete docs openapi`
1890
-
1891
- Print the HTTP OpenAPI 3.1 document as JSON.
1892
-
1893
- #### Options
1894
-
1895
- | Option | Type | Required | Format / default | Description |
1896
- | --- | --- | --- | --- | --- |
1897
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1898
-
1899
- ###### `full-example workspaces :id delete docs cli-schema`
1900
-
1901
- Print the full CLI command tree as JSON.
1902
-
1903
- #### Options
1904
-
1905
- | Option | Type | Required | Format / default | Description |
1906
- | --- | --- | --- | --- | --- |
1907
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1908
-
1909
- ###### `full-example workspaces :id delete docs cli`
1910
-
1911
- Print the full command reference as markdown.
1912
-
1913
- #### Options
1914
-
1915
- | Option | Type | Required | Format / default | Description |
1916
- | --- | --- | --- | --- | --- |
1917
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1918
-
1919
- ###### `full-example workspaces :id delete docs skill`
1920
-
1921
- Print a reference agent SKILL; run `configure` to install an optimized copy.
1922
-
1923
- #### Options
1924
-
1925
- | Option | Type | Required | Format / default | Description |
1926
- | --- | --- | --- | --- | --- |
1927
- | `--save` | flag | optional | — | Write documentation to ./docs/. |
1928
-
1929
- ###### `full-example workspaces :id delete mcp`
1930
-
1931
- MCP server and bundle tools.
1932
-
1933
- > Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
1934
- >
1935
- > command: full-example
1936
- > args: mcp
1937
- >
1938
- > Or:
1939
- >
1940
- > full-example configure
1941
- >
1942
- > Full setup guide: full-example docs mcp
1943
-
1944
- **Default subcommand:** `serve` (`missingOnly`)
1945
-
1946
- #### Options
1947
-
1948
- | Option | Type | Required | Format / default | Description |
1949
- | --- | --- | --- | --- | --- |
1950
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1951
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1952
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1953
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
1954
-
1955
- #### Subcommands
1956
-
1957
- - `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1958
-
1959
- ###### `full-example workspaces :id delete mcp bundle`
1960
-
1961
- Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
1962
-
1963
- ###### `full-example workspaces :id delete http`
1964
-
1965
- HTTP API server for tools.
1966
-
1967
- > HTTP tool server on http://127.0.0.1:3000.
1968
- >
1969
- > Endpoints: GET /health/liveness, GET /health/readiness, GET /openapi.json, GET /swagger, /*
1970
- >
1971
- > Configure app settings:
1972
- >
1973
- > full-example configure
1974
- >
1975
- > Full setup guide: full-example docs http
1976
-
1977
- **Default subcommand:** `serve` (`missingOnly`)
1978
-
1979
- #### Options
1980
-
1981
- | Option | Type | Required | Format / default | Description |
1982
- | --- | --- | --- | --- | --- |
1983
- | `--host` | string | optional | — | Listen host. |
1984
- | `--port` | number | optional | — | Listen port. |
1985
- | `--trust-proxy` | flag | optional | — | Honor X-Forwarded-For for client IP. |
1986
- | `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
1987
- | `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS Logging) or text. |
1988
- | `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
1989
- | `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
1990
- | `--dev` | flag | optional | — | Print full stacks to stderr on errors. |