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