argsbarg 6.1.2 → 6.1.3
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/CHANGELOG.md +65 -1
- package/README.md +17 -19
- package/bin/argsbarg +10 -0
- package/docs/README.md +4 -3
- package/docs/ai-skills.md +4 -2
- package/docs/bundled-docs.md +50 -25
- package/docs/cli-program.md +52 -10
- package/docs/config-schema.md +10 -11
- package/docs/configure.md +2 -0
- package/docs/decisions.md +40 -0
- package/docs/developing.md +43 -5
- package/docs/http-server.md +171 -0
- package/docs/json-schema-subset.md +51 -0
- package/docs/mcp.md +4 -2
- package/docs/output-schema.md +55 -62
- package/examples/formats.ts +6 -6
- package/examples/full-example/Formula/full-example.rb +35 -0
- package/examples/full-example/README.md +20 -21
- package/examples/full-example/docs/README.md +1 -1
- package/examples/full-example/docs/cli-schema.json +1790 -98
- package/examples/full-example/docs/cli.md +1990 -0
- package/examples/full-example/docs/http.md +28 -29
- package/examples/full-example/docs/mcp.md +8 -22
- package/examples/full-example/docs/openapi.json +783 -50
- package/examples/full-example/docs/skill.md +10 -10
- package/examples/full-example/justfile +11 -1
- package/examples/full-example/src/commands/render-json/__generated__/RenderJsonInputSchema.json +15 -0
- package/examples/full-example/src/commands/render-json/__generated__/index.ts +5 -0
- package/examples/full-example/src/commands/render-json/command.test.ts +46 -0
- package/examples/full-example/src/commands/render-json/command.ts +30 -0
- package/examples/full-example/src/commands/render-json/types.ts +9 -0
- package/examples/full-example/src/commands/status/__generated__/StatusJsonOutputSchema.json +15 -0
- package/examples/full-example/src/commands/status/__generated__/index.ts +2 -2
- package/examples/full-example/src/commands/status/command.ts +5 -13
- package/examples/full-example/src/commands/status/types.ts +1 -14
- package/examples/full-example/src/commands/workspaces/__generated__/WorkspaceNameInputSchema.json +15 -0
- package/examples/full-example/src/commands/workspaces/__generated__/index.ts +5 -0
- package/examples/full-example/src/commands/workspaces/command.test.ts +58 -0
- package/examples/full-example/src/commands/workspaces/command.ts +94 -0
- package/examples/full-example/src/commands/workspaces/types.ts +6 -0
- package/examples/full-example/src/db/index.test.ts +86 -0
- package/examples/full-example/src/db/index.ts +101 -0
- package/examples/full-example/src/db/migrate.test.ts +35 -0
- package/examples/full-example/src/db/migrate.ts +69 -0
- package/examples/full-example/src/db/migrations/001_workspaces.sql +6 -0
- package/examples/full-example/src/db/tables/workspaces.ts +66 -0
- package/examples/full-example/src/program.ts +11 -36
- package/examples/full-example/src/types/argsbarg.d.ts +11 -0
- package/examples/full-example/src/types/md.d.ts +4 -0
- package/examples/full-example/tsconfig.json +5 -2
- package/examples/mcp-test.ts +1 -2
- package/examples/minimal.ts +1 -7
- package/examples/nested.ts +1 -2
- package/examples/option-required.ts +1 -1
- package/examples/servers.ts +4 -5
- package/index.d.ts +431 -136
- package/package.json +19 -2
- package/src/builtins/builtins.test.ts +7 -7
- package/src/builtins/completion-bash.ts +1 -1
- package/src/builtins/completion-fish.ts +1 -1
- package/src/builtins/completion-group.ts +4 -4
- package/src/builtins/completion-simulate-shared.ts +9 -0
- package/src/builtins/completion-zsh.ts +1 -1
- package/src/builtins/config.test.ts +3 -3
- package/src/builtins/config.ts +9 -9
- package/src/builtins/configure-copy.ts +2 -2
- package/src/builtins/configure.ts +4 -4
- package/src/builtins/dispatch.ts +19 -18
- package/src/builtins/export.ts +7 -5
- package/src/builtins/http.ts +68 -0
- package/src/builtins/mcp.ts +28 -4
- package/src/builtins/presentation.ts +6 -6
- package/src/builtins/registry.ts +6 -6
- package/src/builtins/scopes.ts +2 -2
- package/src/builtins/version.ts +1 -1
- package/src/cli-tool/full-example-capabilities.test.ts +10 -15
- package/src/cli-tool/main.ts +1 -1
- package/src/cli-tool/program.ts +3 -2
- package/src/cli-tool/prompt.ts +1 -1
- package/src/cli-tool/run-schemagen.ts +1 -3
- package/src/cli-tool/schemagen/cleanup.ts +6 -7
- package/src/cli-tool/schemagen/discover-schema-roots.ts +66 -120
- package/src/cli-tool/schemagen/index.ts +2 -2
- package/src/cli-tool/schemagen/names.ts +8 -13
- package/src/cli-tool/schemagen/run.ts +21 -28
- package/src/cli-tool/schemagen/schemagen.test.ts +136 -46
- package/src/config/bindings.test.ts +1 -1
- package/src/config/bindings.ts +1 -1
- package/src/config/bootstrap.test.ts +1 -1
- package/src/config/bootstrap.ts +36 -4
- package/src/config/context.test.ts +1 -1
- package/src/config/context.ts +1 -1
- package/src/config/entry.ts +1 -1
- package/src/config/file.test.ts +1 -1
- package/src/config/file.ts +3 -3
- package/src/config/manifest.ts +1 -1
- package/src/config/resolve.test.ts +1 -1
- package/src/config/resolve.ts +1 -1
- package/src/config/schema.ts +1 -1
- package/src/config/validate.ts +1 -1
- package/src/{install → configure/artifacts}/binary-placement.test.ts +1 -1
- package/src/{install → configure/artifacts}/binary-placement.ts +1 -1
- package/src/{install → configure/artifacts}/gh-release-update.ts +1 -1
- package/src/{install → configure/artifacts}/install-validate.test.ts +3 -3
- package/src/{install → configure/artifacts}/mcp-config.ts +1 -1
- package/src/{install → configure/artifacts}/mcp-opencode.test.ts +1 -1
- package/src/{install → configure/artifacts}/mcp-opencode.ts +1 -1
- package/src/{install → configure/artifacts}/paths.ts +5 -5
- package/src/configure/artifacts/plan.ts +24 -0
- package/src/{install → configure/artifacts}/status.test.ts +1 -1
- package/src/{install → configure/artifacts}/status.ts +2 -2
- package/src/{install → configure/artifacts}/target-base.ts +1 -1
- package/src/{install → configure/artifacts}/target-detect.ts +1 -1
- package/src/{install → configure/artifacts}/target-effective.ts +3 -9
- package/src/{install → configure/artifacts}/target-mcp-cli.ts +1 -1
- package/src/{install → configure/artifacts}/target-mcp-json.ts +1 -1
- package/src/{install → configure/artifacts}/target-plan-build.ts +2 -2
- package/src/{install → configure/artifacts}/target-registry.ts +2 -2
- package/src/{install → configure/artifacts}/target-scope.ts +3 -3
- package/src/{install → configure/artifacts}/target-skill.ts +1 -1
- package/src/{install → configure/artifacts}/target-types.ts +2 -2
- package/src/{install → configure/artifacts}/targets/app.ts +5 -5
- package/src/{install → configure/artifacts}/targets/chatgpt-mcp.ts +2 -2
- package/src/{install → configure/artifacts}/targets/claude-code-mcp.ts +2 -2
- package/src/{install → configure/artifacts}/targets/claude-desktop-mcp.ts +2 -2
- package/src/{install → configure/artifacts}/targets/claude-skill.ts +2 -2
- package/src/{install → configure/artifacts}/targets/codex-mcp.ts +2 -2
- package/src/{install → configure/artifacts}/targets/codex-skill.ts +2 -2
- package/src/{install → configure/artifacts}/targets/configure.ts +5 -5
- package/src/{install → configure/artifacts}/targets/cursor-mcp.ts +2 -2
- package/src/{install → configure/artifacts}/targets/cursor-skill.ts +2 -2
- package/src/{install → configure/artifacts}/targets/index.ts +1 -1
- package/src/{install → configure/artifacts}/targets/openclaw-mcp.ts +2 -2
- package/src/{install → configure/artifacts}/targets/openclaw-skill.ts +3 -3
- package/src/{install → configure/artifacts}/targets/opencode-mcp.ts +5 -5
- package/src/{install → configure/artifacts}/targets/opencode-skill.ts +3 -3
- package/src/{install → configure/artifacts}/targets.test.ts +1 -1
- package/src/{install → configure/artifacts}/uninstall.ts +1 -1
- package/src/configure/configure.test.ts +11 -11
- package/src/configure/index.ts +14 -14
- package/src/configure/prompt.ts +2 -2
- package/src/{context.ts → core/context.ts} +26 -20
- package/src/{json-leaf.test.ts → core/json-leaf.test.ts} +4 -4
- package/src/{leaf-inputs.test.ts → core/leaf-inputs.test.ts} +7 -7
- package/src/{leaf-inputs.ts → core/leaf-inputs.ts} +16 -12
- package/src/{parse.test.ts → core/parse.test.ts} +97 -109
- package/src/{parse.ts → core/parse.ts} +129 -31
- package/src/{schema.ts → core/schema.ts} +25 -13
- package/src/{types.ts → core/types.ts} +225 -35
- package/src/{validate.ts → core/validate.ts} +39 -29
- package/src/docs/builtin.ts +8 -19
- package/src/docs/{api-guide.test.ts → cli-guide.test.ts} +21 -21
- package/src/docs/{api-guide.ts → cli-guide.ts} +45 -16
- package/src/docs/docs.test.ts +76 -41
- package/src/docs/http-guide.ts +37 -34
- package/src/docs/mcp-guide.ts +12 -14
- package/src/docs/mcp-resources.test.ts +2 -3
- package/src/docs/mcp-resources.ts +6 -11
- package/src/docs/resolve.ts +22 -30
- package/src/docs/save.ts +3 -3
- package/src/exports/cli.ts +47 -0
- package/src/exports/headless.ts +13 -0
- package/src/exports/http.ts +6 -0
- package/src/exports/mcp.ts +6 -0
- package/src/{headless.test.ts → headless/routing.test.ts} +3 -3
- package/src/{headless.ts → headless/routing.ts} +3 -3
- package/src/headless/tool-call.ts +114 -46
- package/src/help.test.ts +152 -0
- package/src/help.ts +3 -3
- package/src/hooks/builtin.ts +20 -0
- package/src/hooks/run.ts +142 -0
- package/src/http/openapi.ts +182 -0
- package/src/http/readiness.ts +78 -0
- package/src/{api → http}/result.ts +16 -5
- package/src/http/routes.ts +329 -0
- package/src/http/server.ts +225 -0
- package/src/index.ts +36 -25
- package/src/log/ecs.test.ts +43 -0
- package/src/log/ecs.ts +59 -0
- package/src/log/emitter.ts +166 -0
- package/src/mcp/bundle.ts +2 -2
- package/src/mcp/claude.test.ts +1 -1
- package/src/mcp/claude.ts +4 -4
- package/src/{hidden-mcpb.test.ts → mcp/hidden-mcpb.test.ts} +10 -9
- package/src/mcp/result.ts +2 -2
- package/src/mcp/server.ts +54 -6
- package/src/mcp/tools.ts +9 -20
- package/src/{capabilities.ts → runtime/capabilities.ts} +11 -11
- package/src/{cli-errors.ts → runtime/cli-errors.ts} +4 -4
- package/src/{cli.ts → runtime/cli.ts} +159 -49
- package/src/runtime/exposure.ts +102 -0
- package/src/{invoke.test.ts → runtime/invoke.test.ts} +31 -7
- package/src/server/context.ts +25 -0
- package/src/server/overrides.ts +112 -0
- package/src/skill/generate.ts +8 -8
- package/src/skill/hint.ts +1 -1
- package/src/skill/install.ts +2 -2
- package/src/skill/naming.ts +1 -1
- package/src/{test-fixtures.ts → test/fixtures.ts} +3 -2
- package/src/{config.integration.test.ts → test/integration/config.test.ts} +8 -8
- package/src/{api.integration.test.ts → test/integration/http.test.ts} +170 -67
- package/src/{mcp.integration.test.ts → test/integration/mcp.test.ts} +11 -57
- package/docs/api-server.md +0 -141
- package/examples/full-example/docs/api.md +0 -511
- package/examples/full-example/src/commands/status/__generated__/outputSchema.json +0 -28
- package/examples/full-example/src/config/__generated__/configSchema.json +0 -40
- package/examples/full-example/src/config/__generated__/index.ts +0 -5
- package/examples/full-example/src/config/types.ts +0 -24
- package/src/api/openapi.ts +0 -117
- package/src/api/server.ts +0 -120
- package/src/builtins/api.ts +0 -38
- package/src/hidden.ts +0 -30
- package/src/install/plan.ts +0 -53
- /package/src/{install → configure/artifacts}/detect-installed.ts +0 -0
- /package/src/{install → configure/artifacts}/gh-release-update.test.ts +0 -0
- /package/src/{install → configure/artifacts}/mcp-codex.test.ts +0 -0
- /package/src/{install → configure/artifacts}/mcp-codex.ts +0 -0
- /package/src/{install → configure/artifacts}/mcp-openclaw.test.ts +0 -0
- /package/src/{install → configure/artifacts}/mcp-openclaw.ts +0 -0
- /package/src/{install → configure/artifacts}/normalize-uninstall.ts +0 -0
- /package/src/{install → configure/artifacts}/normalize.ts +0 -0
- /package/src/{install → configure/artifacts}/opts.ts +0 -0
- /package/src/{install → configure/artifacts}/shell.ts +0 -0
- /package/src/{formats.test.ts → core/formats.test.ts} +0 -0
- /package/src/{formats.ts → core/formats.ts} +0 -0
- /package/src/{respond.ts → core/respond.ts} +0 -0
- /package/src/{types.test.ts → core/types.test.ts} +0 -0
- /package/src/{api → http}/schema-deref.test.ts +0 -0
- /package/src/{api → http}/schema-deref.ts +0 -0
|
@@ -0,0 +1,1990 @@
|
|
|
1
|
+
<!-- Generated by full-example docs cli --save; do not edit. -->
|
|
2
|
+
|
|
3
|
+
# full-example — CLI API reference
|
|
4
|
+
|
|
5
|
+
Argsbarg full example reference app
|
|
6
|
+
|
|
7
|
+
Machine-readable export: `full-example docs cli-schema`
|
|
8
|
+
|
|
9
|
+
## `full-example`
|
|
10
|
+
|
|
11
|
+
Argsbarg full example reference app
|
|
12
|
+
|
|
13
|
+
#### Subcommands
|
|
14
|
+
|
|
15
|
+
- `echo` — Echo a message (MCP-friendly leaf).
|
|
16
|
+
- `render-json` — Echo a JSON message (schema-first JSON leaf demo).
|
|
17
|
+
- `status` — Show app version.
|
|
18
|
+
- `workspaces` — Workspace collection and CRUD.
|
|
19
|
+
|
|
20
|
+
### `full-example echo`
|
|
21
|
+
|
|
22
|
+
Echo a message (MCP-friendly leaf).
|
|
23
|
+
|
|
24
|
+
#### Options
|
|
25
|
+
|
|
26
|
+
| Option | Type | Required | Format / default | Description |
|
|
27
|
+
| --- | --- | --- | --- | --- |
|
|
28
|
+
| `--message` | string | required | — | Text to print. |
|
|
29
|
+
|
|
30
|
+
#### Subcommands
|
|
31
|
+
|
|
32
|
+
- `version` — Print the program version.
|
|
33
|
+
- `configure` — Set up agent skills and MCP config for this app (binary via Homebrew).
|
|
34
|
+
- `docs` — Print bundled CLI documentation.
|
|
35
|
+
- `mcp` — MCP server and bundle tools.
|
|
36
|
+
- `http` — HTTP API server for tools.
|
|
37
|
+
|
|
38
|
+
#### `full-example echo version`
|
|
39
|
+
|
|
40
|
+
Print the program version.
|
|
41
|
+
|
|
42
|
+
#### `full-example echo configure`
|
|
43
|
+
|
|
44
|
+
Set up agent skills and MCP config for this app (binary via Homebrew).
|
|
45
|
+
|
|
46
|
+
> Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
|
|
47
|
+
>
|
|
48
|
+
> Homebrew post_install runs:
|
|
49
|
+
> full-example configure --sync --yes
|
|
50
|
+
>
|
|
51
|
+
> Interactive setup (per target):
|
|
52
|
+
> full-example configure
|
|
53
|
+
>
|
|
54
|
+
> Upgrade:
|
|
55
|
+
> brew upgrade full-example
|
|
56
|
+
>
|
|
57
|
+
> Shell completions are installed by Homebrew during brew install.
|
|
58
|
+
> See: https://docs.brew.sh/Shell-Completion
|
|
59
|
+
>
|
|
60
|
+
> See what is installed:
|
|
61
|
+
> full-example configure --status
|
|
62
|
+
>
|
|
63
|
+
> Uninstall:
|
|
64
|
+
> brew uninstall <tap>/full-example
|
|
65
|
+
>
|
|
66
|
+
> The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
|
|
67
|
+
>
|
|
68
|
+
> Use --dry to preview changes without writing files.
|
|
69
|
+
> Use --json for machine-readable output.
|
|
70
|
+
|
|
71
|
+
**Default subcommand:** `run` (`missingOnly`)
|
|
72
|
+
|
|
73
|
+
#### Options
|
|
74
|
+
|
|
75
|
+
| Option | Type | Required | Format / default | Description |
|
|
76
|
+
| --- | --- | --- | --- | --- |
|
|
77
|
+
| `--sync` | flag | optional | — | Refresh installed skills and MCP. Used by Homebrew post_install. |
|
|
78
|
+
| `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
|
|
79
|
+
| `--status` | flag | optional | — | Print what is currently installed (read-only). |
|
|
80
|
+
| `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
|
|
81
|
+
| `--dry` | flag | optional | — | Show what would change without writing files. |
|
|
82
|
+
| `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
|
|
83
|
+
|
|
84
|
+
#### `full-example echo docs`
|
|
85
|
+
|
|
86
|
+
Print bundled CLI documentation.
|
|
87
|
+
|
|
88
|
+
> Topics print to stdout. Add --save to write files under ./docs/.
|
|
89
|
+
|
|
90
|
+
#### Options
|
|
91
|
+
|
|
92
|
+
| Option | Type | Required | Format / default | Description |
|
|
93
|
+
| --- | --- | --- | --- | --- |
|
|
94
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
95
|
+
|
|
96
|
+
#### Subcommands
|
|
97
|
+
|
|
98
|
+
- `readme` — Print README (user guide).
|
|
99
|
+
- `mcp` — Print MCP server setup and tool guidance.
|
|
100
|
+
- `http` — Print HTTP API setup and tool guidance.
|
|
101
|
+
- `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
|
|
102
|
+
- `cli-schema` — Print the full CLI command tree as JSON.
|
|
103
|
+
- `cli` — Print the full command reference as markdown.
|
|
104
|
+
- `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
|
|
105
|
+
|
|
106
|
+
##### `full-example echo docs readme`
|
|
107
|
+
|
|
108
|
+
Print README (user guide).
|
|
109
|
+
|
|
110
|
+
#### Options
|
|
111
|
+
|
|
112
|
+
| Option | Type | Required | Format / default | Description |
|
|
113
|
+
| --- | --- | --- | --- | --- |
|
|
114
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
115
|
+
|
|
116
|
+
##### `full-example echo docs mcp`
|
|
117
|
+
|
|
118
|
+
Print MCP server setup and tool guidance.
|
|
119
|
+
|
|
120
|
+
#### Options
|
|
121
|
+
|
|
122
|
+
| Option | Type | Required | Format / default | Description |
|
|
123
|
+
| --- | --- | --- | --- | --- |
|
|
124
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
125
|
+
|
|
126
|
+
##### `full-example echo docs http`
|
|
127
|
+
|
|
128
|
+
Print HTTP API setup and tool guidance.
|
|
129
|
+
|
|
130
|
+
#### Options
|
|
131
|
+
|
|
132
|
+
| Option | Type | Required | Format / default | Description |
|
|
133
|
+
| --- | --- | --- | --- | --- |
|
|
134
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
135
|
+
|
|
136
|
+
##### `full-example echo docs openapi`
|
|
137
|
+
|
|
138
|
+
Print the HTTP OpenAPI 3.1 document as JSON.
|
|
139
|
+
|
|
140
|
+
#### Options
|
|
141
|
+
|
|
142
|
+
| Option | Type | Required | Format / default | Description |
|
|
143
|
+
| --- | --- | --- | --- | --- |
|
|
144
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
145
|
+
|
|
146
|
+
##### `full-example echo docs cli-schema`
|
|
147
|
+
|
|
148
|
+
Print the full CLI command tree as JSON.
|
|
149
|
+
|
|
150
|
+
#### Options
|
|
151
|
+
|
|
152
|
+
| Option | Type | Required | Format / default | Description |
|
|
153
|
+
| --- | --- | --- | --- | --- |
|
|
154
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
155
|
+
|
|
156
|
+
##### `full-example echo docs cli`
|
|
157
|
+
|
|
158
|
+
Print the full command reference as markdown.
|
|
159
|
+
|
|
160
|
+
#### Options
|
|
161
|
+
|
|
162
|
+
| Option | Type | Required | Format / default | Description |
|
|
163
|
+
| --- | --- | --- | --- | --- |
|
|
164
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
165
|
+
|
|
166
|
+
##### `full-example echo docs skill`
|
|
167
|
+
|
|
168
|
+
Print a reference agent SKILL; run `configure` to install an optimized copy.
|
|
169
|
+
|
|
170
|
+
#### Options
|
|
171
|
+
|
|
172
|
+
| Option | Type | Required | Format / default | Description |
|
|
173
|
+
| --- | --- | --- | --- | --- |
|
|
174
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
175
|
+
|
|
176
|
+
#### `full-example echo mcp`
|
|
177
|
+
|
|
178
|
+
MCP server and bundle tools.
|
|
179
|
+
|
|
180
|
+
> Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
|
|
181
|
+
>
|
|
182
|
+
> command: full-example
|
|
183
|
+
> args: mcp
|
|
184
|
+
>
|
|
185
|
+
> Or:
|
|
186
|
+
>
|
|
187
|
+
> full-example configure
|
|
188
|
+
>
|
|
189
|
+
> Full setup guide: full-example docs mcp
|
|
190
|
+
|
|
191
|
+
**Default subcommand:** `serve` (`missingOnly`)
|
|
192
|
+
|
|
193
|
+
#### Options
|
|
194
|
+
|
|
195
|
+
| Option | Type | Required | Format / default | Description |
|
|
196
|
+
| --- | --- | --- | --- | --- |
|
|
197
|
+
| `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
|
|
198
|
+
| `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS) or text. |
|
|
199
|
+
| `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
|
|
200
|
+
| `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
|
|
201
|
+
|
|
202
|
+
#### Subcommands
|
|
203
|
+
|
|
204
|
+
- `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
|
|
205
|
+
|
|
206
|
+
##### `full-example echo mcp bundle`
|
|
207
|
+
|
|
208
|
+
Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
|
|
209
|
+
|
|
210
|
+
#### `full-example echo http`
|
|
211
|
+
|
|
212
|
+
HTTP API server for tools.
|
|
213
|
+
|
|
214
|
+
> HTTP tool server on http://127.0.0.1:3000.
|
|
215
|
+
>
|
|
216
|
+
> Endpoints: GET /health, GET /health/ready, GET /openapi.json, GET /openapi-browser, /api/*
|
|
217
|
+
>
|
|
218
|
+
> Configure app settings:
|
|
219
|
+
>
|
|
220
|
+
> full-example configure
|
|
221
|
+
>
|
|
222
|
+
> Full setup guide: full-example docs http
|
|
223
|
+
|
|
224
|
+
**Default subcommand:** `serve` (`missingOnly`)
|
|
225
|
+
|
|
226
|
+
#### Options
|
|
227
|
+
|
|
228
|
+
| Option | Type | Required | Format / default | Description |
|
|
229
|
+
| --- | --- | --- | --- | --- |
|
|
230
|
+
| `--host` | string | optional | — | Listen host. |
|
|
231
|
+
| `--port` | number | optional | — | Listen port. |
|
|
232
|
+
| `--trust-proxy` | flag | optional | — | Honor X-Forwarded-For for client IP. |
|
|
233
|
+
| `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
|
|
234
|
+
| `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS) or text. |
|
|
235
|
+
| `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
|
|
236
|
+
| `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
|
|
237
|
+
| `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
|
|
238
|
+
|
|
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) 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, GET /health/ready, GET /openapi.json, GET /openapi-browser, /api/*
|
|
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) 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
|
+
### `full-example status`
|
|
453
|
+
|
|
454
|
+
Show app version.
|
|
455
|
+
|
|
456
|
+
#### Options
|
|
457
|
+
|
|
458
|
+
| Option | Type | Required | Format / default | Description |
|
|
459
|
+
| --- | --- | --- | --- | --- |
|
|
460
|
+
| `--json` | flag | optional | — | Emit JSON. |
|
|
461
|
+
|
|
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
|
+
#### Subcommands
|
|
485
|
+
|
|
486
|
+
- `version` — Print the program version.
|
|
487
|
+
- `configure` — Set up agent skills and MCP config for this app (binary via Homebrew).
|
|
488
|
+
- `docs` — Print bundled CLI documentation.
|
|
489
|
+
- `mcp` — MCP server and bundle tools.
|
|
490
|
+
- `http` — HTTP API server for tools.
|
|
491
|
+
|
|
492
|
+
#### `full-example status version`
|
|
493
|
+
|
|
494
|
+
Print the program version.
|
|
495
|
+
|
|
496
|
+
#### `full-example status configure`
|
|
497
|
+
|
|
498
|
+
Set up agent skills and MCP config for this app (binary via Homebrew).
|
|
499
|
+
|
|
500
|
+
> Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
|
|
501
|
+
>
|
|
502
|
+
> Homebrew post_install runs:
|
|
503
|
+
> full-example configure --sync --yes
|
|
504
|
+
>
|
|
505
|
+
> Interactive setup (per target):
|
|
506
|
+
> full-example configure
|
|
507
|
+
>
|
|
508
|
+
> Upgrade:
|
|
509
|
+
> brew upgrade full-example
|
|
510
|
+
>
|
|
511
|
+
> Shell completions are installed by Homebrew during brew install.
|
|
512
|
+
> See: https://docs.brew.sh/Shell-Completion
|
|
513
|
+
>
|
|
514
|
+
> See what is installed:
|
|
515
|
+
> full-example configure --status
|
|
516
|
+
>
|
|
517
|
+
> Uninstall:
|
|
518
|
+
> brew uninstall <tap>/full-example
|
|
519
|
+
>
|
|
520
|
+
> The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
|
|
521
|
+
>
|
|
522
|
+
> Use --dry to preview changes without writing files.
|
|
523
|
+
> Use --json for machine-readable output.
|
|
524
|
+
|
|
525
|
+
**Default subcommand:** `run` (`missingOnly`)
|
|
526
|
+
|
|
527
|
+
#### Options
|
|
528
|
+
|
|
529
|
+
| Option | Type | Required | Format / default | Description |
|
|
530
|
+
| --- | --- | --- | --- | --- |
|
|
531
|
+
| `--sync` | flag | optional | — | Refresh installed skills and MCP. Used by Homebrew post_install. |
|
|
532
|
+
| `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
|
|
533
|
+
| `--status` | flag | optional | — | Print what is currently installed (read-only). |
|
|
534
|
+
| `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
|
|
535
|
+
| `--dry` | flag | optional | — | Show what would change without writing files. |
|
|
536
|
+
| `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
|
|
537
|
+
|
|
538
|
+
#### `full-example status docs`
|
|
539
|
+
|
|
540
|
+
Print bundled CLI documentation.
|
|
541
|
+
|
|
542
|
+
> Topics print to stdout. Add --save to write files under ./docs/.
|
|
543
|
+
|
|
544
|
+
#### Options
|
|
545
|
+
|
|
546
|
+
| Option | Type | Required | Format / default | Description |
|
|
547
|
+
| --- | --- | --- | --- | --- |
|
|
548
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
549
|
+
|
|
550
|
+
#### Subcommands
|
|
551
|
+
|
|
552
|
+
- `readme` — Print README (user guide).
|
|
553
|
+
- `mcp` — Print MCP server setup and tool guidance.
|
|
554
|
+
- `http` — Print HTTP API setup and tool guidance.
|
|
555
|
+
- `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
|
|
556
|
+
- `cli-schema` — Print the full CLI command tree as JSON.
|
|
557
|
+
- `cli` — Print the full command reference as markdown.
|
|
558
|
+
- `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
|
|
559
|
+
|
|
560
|
+
##### `full-example status docs readme`
|
|
561
|
+
|
|
562
|
+
Print README (user guide).
|
|
563
|
+
|
|
564
|
+
#### Options
|
|
565
|
+
|
|
566
|
+
| Option | Type | Required | Format / default | Description |
|
|
567
|
+
| --- | --- | --- | --- | --- |
|
|
568
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
569
|
+
|
|
570
|
+
##### `full-example status docs mcp`
|
|
571
|
+
|
|
572
|
+
Print MCP server setup and tool guidance.
|
|
573
|
+
|
|
574
|
+
#### Options
|
|
575
|
+
|
|
576
|
+
| Option | Type | Required | Format / default | Description |
|
|
577
|
+
| --- | --- | --- | --- | --- |
|
|
578
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
579
|
+
|
|
580
|
+
##### `full-example status docs http`
|
|
581
|
+
|
|
582
|
+
Print HTTP API setup and tool guidance.
|
|
583
|
+
|
|
584
|
+
#### Options
|
|
585
|
+
|
|
586
|
+
| Option | Type | Required | Format / default | Description |
|
|
587
|
+
| --- | --- | --- | --- | --- |
|
|
588
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
589
|
+
|
|
590
|
+
##### `full-example status docs openapi`
|
|
591
|
+
|
|
592
|
+
Print the HTTP OpenAPI 3.1 document as JSON.
|
|
593
|
+
|
|
594
|
+
#### Options
|
|
595
|
+
|
|
596
|
+
| Option | Type | Required | Format / default | Description |
|
|
597
|
+
| --- | --- | --- | --- | --- |
|
|
598
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
599
|
+
|
|
600
|
+
##### `full-example status docs cli-schema`
|
|
601
|
+
|
|
602
|
+
Print the full CLI command tree as JSON.
|
|
603
|
+
|
|
604
|
+
#### Options
|
|
605
|
+
|
|
606
|
+
| Option | Type | Required | Format / default | Description |
|
|
607
|
+
| --- | --- | --- | --- | --- |
|
|
608
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
609
|
+
|
|
610
|
+
##### `full-example status docs cli`
|
|
611
|
+
|
|
612
|
+
Print the full command reference as markdown.
|
|
613
|
+
|
|
614
|
+
#### Options
|
|
615
|
+
|
|
616
|
+
| Option | Type | Required | Format / default | Description |
|
|
617
|
+
| --- | --- | --- | --- | --- |
|
|
618
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
619
|
+
|
|
620
|
+
##### `full-example status docs skill`
|
|
621
|
+
|
|
622
|
+
Print a reference agent SKILL; run `configure` to install an optimized copy.
|
|
623
|
+
|
|
624
|
+
#### Options
|
|
625
|
+
|
|
626
|
+
| Option | Type | Required | Format / default | Description |
|
|
627
|
+
| --- | --- | --- | --- | --- |
|
|
628
|
+
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
629
|
+
|
|
630
|
+
#### `full-example status mcp`
|
|
631
|
+
|
|
632
|
+
MCP server and bundle tools.
|
|
633
|
+
|
|
634
|
+
> Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
|
|
635
|
+
>
|
|
636
|
+
> command: full-example
|
|
637
|
+
> args: mcp
|
|
638
|
+
>
|
|
639
|
+
> Or:
|
|
640
|
+
>
|
|
641
|
+
> full-example configure
|
|
642
|
+
>
|
|
643
|
+
> Full setup guide: full-example docs mcp
|
|
644
|
+
|
|
645
|
+
**Default subcommand:** `serve` (`missingOnly`)
|
|
646
|
+
|
|
647
|
+
#### Options
|
|
648
|
+
|
|
649
|
+
| Option | Type | Required | Format / default | Description |
|
|
650
|
+
| --- | --- | --- | --- | --- |
|
|
651
|
+
| `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
|
|
652
|
+
| `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS) or text. |
|
|
653
|
+
| `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
|
|
654
|
+
| `--dev` | flag | optional | — | Print full stacks to stderr on errors. |
|
|
655
|
+
|
|
656
|
+
#### Subcommands
|
|
657
|
+
|
|
658
|
+
- `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
|
|
659
|
+
|
|
660
|
+
##### `full-example status mcp bundle`
|
|
661
|
+
|
|
662
|
+
Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
|
|
663
|
+
|
|
664
|
+
#### `full-example status http`
|
|
665
|
+
|
|
666
|
+
HTTP API server for tools.
|
|
667
|
+
|
|
668
|
+
> HTTP tool server on http://127.0.0.1:3000.
|
|
669
|
+
>
|
|
670
|
+
> Endpoints: GET /health, GET /health/ready, GET /openapi.json, GET /openapi-browser, /api/*
|
|
671
|
+
>
|
|
672
|
+
> Configure app settings:
|
|
673
|
+
>
|
|
674
|
+
> full-example configure
|
|
675
|
+
>
|
|
676
|
+
> Full setup guide: full-example docs http
|
|
677
|
+
|
|
678
|
+
**Default subcommand:** `serve` (`missingOnly`)
|
|
679
|
+
|
|
680
|
+
#### Options
|
|
681
|
+
|
|
682
|
+
| Option | Type | Required | Format / default | Description |
|
|
683
|
+
| --- | --- | --- | --- | --- |
|
|
684
|
+
| `--host` | string | optional | — | Listen host. |
|
|
685
|
+
| `--port` | number | optional | — | Listen port. |
|
|
686
|
+
| `--trust-proxy` | flag | optional | — | Honor X-Forwarded-For for client IP. |
|
|
687
|
+
| `--obscure-errors` | flag | optional | — | Hide unexpected errors from clients. |
|
|
688
|
+
| `--log-format` | enum (`json`, `text`) | optional | — | Log format: json (ECS) or text. |
|
|
689
|
+
| `--log-file` | string | optional | — | Append logs to this file (relative → app config dir). |
|
|
690
|
+
| `--no-access-log` | flag | optional | — | Disable HTTP access logs. |
|
|
691
|
+
| `--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) 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, GET /health/ready, GET /openapi.json, GET /openapi-browser, /api/*
|
|
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) 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) 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, GET /health/ready, GET /openapi.json, GET /openapi-browser, /api/*
|
|
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) 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) 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, GET /health/ready, GET /openapi.json, GET /openapi-browser, /api/*
|
|
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) 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) 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, GET /health/ready, GET /openapi.json, GET /openapi-browser, /api/*
|
|
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) 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) 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, GET /health/ready, GET /openapi.json, GET /openapi-browser, /api/*
|
|
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) 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) 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, GET /health/ready, GET /openapi.json, GET /openapi-browser, /api/*
|
|
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) 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. |
|