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
|
@@ -1,511 +0,0 @@
|
|
|
1
|
-
<!-- Generated by full-example docs api --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
|
-
- `status` — Show resolved config and app version.
|
|
17
|
-
|
|
18
|
-
### `full-example echo`
|
|
19
|
-
|
|
20
|
-
Echo a message (MCP-friendly leaf).
|
|
21
|
-
|
|
22
|
-
#### Options
|
|
23
|
-
|
|
24
|
-
| Option | Type | Required | Format / default | Description |
|
|
25
|
-
| --- | --- | --- | --- | --- |
|
|
26
|
-
| `--message` | string | required | — | Text to print. |
|
|
27
|
-
|
|
28
|
-
#### Subcommands
|
|
29
|
-
|
|
30
|
-
- `version` — Print the program version.
|
|
31
|
-
- `configure` — Set up agent skills, MCP config, and app config for this app (binary via Homebrew).
|
|
32
|
-
- `docs` — Print bundled CLI documentation.
|
|
33
|
-
- `mcp` — MCP server and bundle tools.
|
|
34
|
-
- `api` — HTTP API server for tools.
|
|
35
|
-
|
|
36
|
-
#### `full-example echo version`
|
|
37
|
-
|
|
38
|
-
Print the program version.
|
|
39
|
-
|
|
40
|
-
#### `full-example echo configure`
|
|
41
|
-
|
|
42
|
-
Set up agent skills, MCP config, and app config for this app (binary via Homebrew).
|
|
43
|
-
|
|
44
|
-
> Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
|
|
45
|
-
>
|
|
46
|
-
> Homebrew post_install runs:
|
|
47
|
-
> full-example configure --sync --yes
|
|
48
|
-
>
|
|
49
|
-
> Interactive setup (per target):
|
|
50
|
-
> full-example configure
|
|
51
|
-
>
|
|
52
|
-
> Upgrade:
|
|
53
|
-
> brew upgrade full-example
|
|
54
|
-
>
|
|
55
|
-
> Shell completions are installed by Homebrew during brew install.
|
|
56
|
-
> See: https://docs.brew.sh/Shell-Completion
|
|
57
|
-
>
|
|
58
|
-
> See what is installed:
|
|
59
|
-
> full-example configure --status
|
|
60
|
-
>
|
|
61
|
-
> Uninstall:
|
|
62
|
-
> brew uninstall <tap>/full-example
|
|
63
|
-
>
|
|
64
|
-
> The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
|
|
65
|
-
>
|
|
66
|
-
> Remove app config only:
|
|
67
|
-
> full-example configure --remove-config --yes
|
|
68
|
-
>
|
|
69
|
-
> Use --dry to preview changes without writing files.
|
|
70
|
-
> Use --json for machine-readable output.
|
|
71
|
-
|
|
72
|
-
**Default subcommand:** `run` (`missingOnly`)
|
|
73
|
-
|
|
74
|
-
#### Options
|
|
75
|
-
|
|
76
|
-
| Option | Type | Required | Format / default | Description |
|
|
77
|
-
| --- | --- | --- | --- | --- |
|
|
78
|
-
| `--sync` | flag | optional | — | Refresh installed skills, MCP, and config. Used by Homebrew post_install. |
|
|
79
|
-
| `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
|
|
80
|
-
| `--remove-config` | flag | optional | — | Remove the app config file only. |
|
|
81
|
-
| `--status` | flag | optional | — | Print what is currently installed (read-only). |
|
|
82
|
-
| `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
|
|
83
|
-
| `--dry` | flag | optional | — | Show what would change without writing files. |
|
|
84
|
-
| `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
|
|
85
|
-
|
|
86
|
-
#### Subcommands
|
|
87
|
-
|
|
88
|
-
- `get` — Print resolved configuration value(s).
|
|
89
|
-
- `set` — Write one configuration key to the config file.
|
|
90
|
-
|
|
91
|
-
##### `full-example echo configure get`
|
|
92
|
-
|
|
93
|
-
Print resolved configuration value(s).
|
|
94
|
-
|
|
95
|
-
#### Options
|
|
96
|
-
|
|
97
|
-
| Option | Type | Required | Format / default | Description |
|
|
98
|
-
| --- | --- | --- | --- | --- |
|
|
99
|
-
| `--json` | flag | optional | — | Emit JSON (compact). |
|
|
100
|
-
| `--pretty` | flag | optional | — | Pretty-print JSON (requires --json). |
|
|
101
|
-
|
|
102
|
-
##### `full-example echo configure set`
|
|
103
|
-
|
|
104
|
-
Write one configuration key to the config file.
|
|
105
|
-
|
|
106
|
-
#### Options
|
|
107
|
-
|
|
108
|
-
| Option | Type | Required | Format / default | Description |
|
|
109
|
-
| --- | --- | --- | --- | --- |
|
|
110
|
-
| `--json` | flag | optional | — | Emit JSON (compact). |
|
|
111
|
-
| `--from-env` | flag | optional | — | Bind this key to its mapped environment variable (no literal value stored). |
|
|
112
|
-
|
|
113
|
-
#### `full-example echo docs`
|
|
114
|
-
|
|
115
|
-
Print bundled CLI documentation.
|
|
116
|
-
|
|
117
|
-
> Topics print to stdout. Add --save to write files under ./docs/.
|
|
118
|
-
|
|
119
|
-
**Default subcommand:** `readme` (`missingOnly`)
|
|
120
|
-
|
|
121
|
-
#### Options
|
|
122
|
-
|
|
123
|
-
| Option | Type | Required | Format / default | Description |
|
|
124
|
-
| --- | --- | --- | --- | --- |
|
|
125
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
126
|
-
|
|
127
|
-
#### Subcommands
|
|
128
|
-
|
|
129
|
-
- `readme` — Print README (user guide).
|
|
130
|
-
- `mcp` — Print MCP server setup and tool guidance.
|
|
131
|
-
- `http` — Print HTTP API setup and tool guidance.
|
|
132
|
-
- `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
|
|
133
|
-
- `cli-schema` — Print the full CLI command tree as JSON.
|
|
134
|
-
- `api` — Print the full command reference as markdown.
|
|
135
|
-
- `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
|
|
136
|
-
|
|
137
|
-
##### `full-example echo docs readme`
|
|
138
|
-
|
|
139
|
-
Print README (user guide).
|
|
140
|
-
|
|
141
|
-
#### Options
|
|
142
|
-
|
|
143
|
-
| Option | Type | Required | Format / default | Description |
|
|
144
|
-
| --- | --- | --- | --- | --- |
|
|
145
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
146
|
-
|
|
147
|
-
##### `full-example echo docs mcp`
|
|
148
|
-
|
|
149
|
-
Print MCP server setup and tool guidance.
|
|
150
|
-
|
|
151
|
-
#### Options
|
|
152
|
-
|
|
153
|
-
| Option | Type | Required | Format / default | Description |
|
|
154
|
-
| --- | --- | --- | --- | --- |
|
|
155
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
156
|
-
|
|
157
|
-
##### `full-example echo docs http`
|
|
158
|
-
|
|
159
|
-
Print HTTP API setup and tool guidance.
|
|
160
|
-
|
|
161
|
-
#### Options
|
|
162
|
-
|
|
163
|
-
| Option | Type | Required | Format / default | Description |
|
|
164
|
-
| --- | --- | --- | --- | --- |
|
|
165
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
166
|
-
|
|
167
|
-
##### `full-example echo docs openapi`
|
|
168
|
-
|
|
169
|
-
Print the HTTP OpenAPI 3.1 document as JSON.
|
|
170
|
-
|
|
171
|
-
#### Options
|
|
172
|
-
|
|
173
|
-
| Option | Type | Required | Format / default | Description |
|
|
174
|
-
| --- | --- | --- | --- | --- |
|
|
175
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
176
|
-
|
|
177
|
-
##### `full-example echo docs cli-schema`
|
|
178
|
-
|
|
179
|
-
Print the full CLI command tree as JSON.
|
|
180
|
-
|
|
181
|
-
#### Options
|
|
182
|
-
|
|
183
|
-
| Option | Type | Required | Format / default | Description |
|
|
184
|
-
| --- | --- | --- | --- | --- |
|
|
185
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
186
|
-
|
|
187
|
-
##### `full-example echo docs api`
|
|
188
|
-
|
|
189
|
-
Print the full command reference as markdown.
|
|
190
|
-
|
|
191
|
-
#### Options
|
|
192
|
-
|
|
193
|
-
| Option | Type | Required | Format / default | Description |
|
|
194
|
-
| --- | --- | --- | --- | --- |
|
|
195
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
196
|
-
|
|
197
|
-
##### `full-example echo docs skill`
|
|
198
|
-
|
|
199
|
-
Print a reference agent SKILL; run `configure` to install an optimized copy.
|
|
200
|
-
|
|
201
|
-
#### Options
|
|
202
|
-
|
|
203
|
-
| Option | Type | Required | Format / default | Description |
|
|
204
|
-
| --- | --- | --- | --- | --- |
|
|
205
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
206
|
-
|
|
207
|
-
#### `full-example echo mcp`
|
|
208
|
-
|
|
209
|
-
MCP server and bundle tools.
|
|
210
|
-
|
|
211
|
-
> Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
|
|
212
|
-
>
|
|
213
|
-
> command: full-example
|
|
214
|
-
> args: mcp
|
|
215
|
-
>
|
|
216
|
-
> Or:
|
|
217
|
-
>
|
|
218
|
-
> full-example configure
|
|
219
|
-
>
|
|
220
|
-
> Full setup guide: full-example docs mcp
|
|
221
|
-
|
|
222
|
-
**Default subcommand:** `serve` (`missingOnly`)
|
|
223
|
-
|
|
224
|
-
#### Subcommands
|
|
225
|
-
|
|
226
|
-
- `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
|
|
227
|
-
|
|
228
|
-
##### `full-example echo mcp bundle`
|
|
229
|
-
|
|
230
|
-
Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
|
|
231
|
-
|
|
232
|
-
#### `full-example echo api`
|
|
233
|
-
|
|
234
|
-
HTTP API server for tools.
|
|
235
|
-
|
|
236
|
-
> HTTP tool server on http://127.0.0.1:3000.
|
|
237
|
-
>
|
|
238
|
-
> Endpoints: GET /health, GET /openapi.json, GET /openapi-browser, POST /tools/:name
|
|
239
|
-
>
|
|
240
|
-
> Configure app settings:
|
|
241
|
-
>
|
|
242
|
-
> full-example configure
|
|
243
|
-
>
|
|
244
|
-
> Full setup guide: full-example docs http
|
|
245
|
-
|
|
246
|
-
**Default subcommand:** `serve` (`missingOnly`)
|
|
247
|
-
|
|
248
|
-
### `full-example status`
|
|
249
|
-
|
|
250
|
-
Show resolved config and app version.
|
|
251
|
-
|
|
252
|
-
#### Options
|
|
253
|
-
|
|
254
|
-
| Option | Type | Required | Format / default | Description |
|
|
255
|
-
| --- | --- | --- | --- | --- |
|
|
256
|
-
| `--json` | flag | optional | — | Emit JSON. |
|
|
257
|
-
|
|
258
|
-
#### Output
|
|
259
|
-
|
|
260
|
-
JSON Schema for output when/if handler emits JSON
|
|
261
|
-
|
|
262
|
-
```json
|
|
263
|
-
{
|
|
264
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
265
|
-
"type": "object",
|
|
266
|
-
"properties": {
|
|
267
|
-
"defaultRegion": {
|
|
268
|
-
"type": "string",
|
|
269
|
-
"description": "Resolved AWS region."
|
|
270
|
-
},
|
|
271
|
-
"maxRetries": {
|
|
272
|
-
"type": "number",
|
|
273
|
-
"description": "Resolved retry count."
|
|
274
|
-
},
|
|
275
|
-
"apiTokenSet": {
|
|
276
|
-
"type": "boolean",
|
|
277
|
-
"description": "Whether apiToken is set (value never included)."
|
|
278
|
-
},
|
|
279
|
-
"version": {
|
|
280
|
-
"type": "string",
|
|
281
|
-
"description": "App version from program root."
|
|
282
|
-
}
|
|
283
|
-
},
|
|
284
|
-
"required": [
|
|
285
|
-
"apiTokenSet",
|
|
286
|
-
"version"
|
|
287
|
-
],
|
|
288
|
-
"description": "JSON payload for `full-example status --json`.",
|
|
289
|
-
"definitions": {}
|
|
290
|
-
}
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
#### Subcommands
|
|
294
|
-
|
|
295
|
-
- `version` — Print the program version.
|
|
296
|
-
- `configure` — Set up agent skills, MCP config, and app config for this app (binary via Homebrew).
|
|
297
|
-
- `docs` — Print bundled CLI documentation.
|
|
298
|
-
- `mcp` — MCP server and bundle tools.
|
|
299
|
-
- `api` — HTTP API server for tools.
|
|
300
|
-
|
|
301
|
-
#### `full-example status version`
|
|
302
|
-
|
|
303
|
-
Print the program version.
|
|
304
|
-
|
|
305
|
-
#### `full-example status configure`
|
|
306
|
-
|
|
307
|
-
Set up agent skills, MCP config, and app config for this app (binary via Homebrew).
|
|
308
|
-
|
|
309
|
-
> Set up agent artifacts after the binary is installed via Homebrew (see README for tap install).
|
|
310
|
-
>
|
|
311
|
-
> Homebrew post_install runs:
|
|
312
|
-
> full-example configure --sync --yes
|
|
313
|
-
>
|
|
314
|
-
> Interactive setup (per target):
|
|
315
|
-
> full-example configure
|
|
316
|
-
>
|
|
317
|
-
> Upgrade:
|
|
318
|
-
> brew upgrade full-example
|
|
319
|
-
>
|
|
320
|
-
> Shell completions are installed by Homebrew during brew install.
|
|
321
|
-
> See: https://docs.brew.sh/Shell-Completion
|
|
322
|
-
>
|
|
323
|
-
> See what is installed:
|
|
324
|
-
> full-example configure --status
|
|
325
|
-
>
|
|
326
|
-
> Uninstall:
|
|
327
|
-
> brew uninstall <tap>/full-example
|
|
328
|
-
>
|
|
329
|
-
> The formula uninstall hook runs `configure --remove-all --yes` (skills, MCP, and app config).
|
|
330
|
-
>
|
|
331
|
-
> Remove app config only:
|
|
332
|
-
> full-example configure --remove-config --yes
|
|
333
|
-
>
|
|
334
|
-
> Use --dry to preview changes without writing files.
|
|
335
|
-
> Use --json for machine-readable output.
|
|
336
|
-
|
|
337
|
-
**Default subcommand:** `run` (`missingOnly`)
|
|
338
|
-
|
|
339
|
-
#### Options
|
|
340
|
-
|
|
341
|
-
| Option | Type | Required | Format / default | Description |
|
|
342
|
-
| --- | --- | --- | --- | --- |
|
|
343
|
-
| `--sync` | flag | optional | — | Refresh installed skills, MCP, and config. Used by Homebrew post_install. |
|
|
344
|
-
| `--remove-all` | flag | optional | — | Remove all detected agent artifacts (skills and MCP). |
|
|
345
|
-
| `--remove-config` | flag | optional | — | Remove the app config file only. |
|
|
346
|
-
| `--status` | flag | optional | — | Print what is currently installed (read-only). |
|
|
347
|
-
| `--yes` (`-y`) | flag | optional | — | Skip confirmation (required for --sync, --remove-all, --remove-config). |
|
|
348
|
-
| `--dry` | flag | optional | — | Show what would change without writing files. |
|
|
349
|
-
| `--json` | flag | optional | — | Print changed paths or status JSON on stdout. |
|
|
350
|
-
|
|
351
|
-
#### Subcommands
|
|
352
|
-
|
|
353
|
-
- `get` — Print resolved configuration value(s).
|
|
354
|
-
- `set` — Write one configuration key to the config file.
|
|
355
|
-
|
|
356
|
-
##### `full-example status configure get`
|
|
357
|
-
|
|
358
|
-
Print resolved configuration value(s).
|
|
359
|
-
|
|
360
|
-
#### Options
|
|
361
|
-
|
|
362
|
-
| Option | Type | Required | Format / default | Description |
|
|
363
|
-
| --- | --- | --- | --- | --- |
|
|
364
|
-
| `--json` | flag | optional | — | Emit JSON (compact). |
|
|
365
|
-
| `--pretty` | flag | optional | — | Pretty-print JSON (requires --json). |
|
|
366
|
-
|
|
367
|
-
##### `full-example status configure set`
|
|
368
|
-
|
|
369
|
-
Write one configuration key to the config file.
|
|
370
|
-
|
|
371
|
-
#### Options
|
|
372
|
-
|
|
373
|
-
| Option | Type | Required | Format / default | Description |
|
|
374
|
-
| --- | --- | --- | --- | --- |
|
|
375
|
-
| `--json` | flag | optional | — | Emit JSON (compact). |
|
|
376
|
-
| `--from-env` | flag | optional | — | Bind this key to its mapped environment variable (no literal value stored). |
|
|
377
|
-
|
|
378
|
-
#### `full-example status docs`
|
|
379
|
-
|
|
380
|
-
Print bundled CLI documentation.
|
|
381
|
-
|
|
382
|
-
> Topics print to stdout. Add --save to write files under ./docs/.
|
|
383
|
-
|
|
384
|
-
**Default subcommand:** `readme` (`missingOnly`)
|
|
385
|
-
|
|
386
|
-
#### Options
|
|
387
|
-
|
|
388
|
-
| Option | Type | Required | Format / default | Description |
|
|
389
|
-
| --- | --- | --- | --- | --- |
|
|
390
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
391
|
-
|
|
392
|
-
#### Subcommands
|
|
393
|
-
|
|
394
|
-
- `readme` — Print README (user guide).
|
|
395
|
-
- `mcp` — Print MCP server setup and tool guidance.
|
|
396
|
-
- `http` — Print HTTP API setup and tool guidance.
|
|
397
|
-
- `openapi` — Print the HTTP OpenAPI 3.1 document as JSON.
|
|
398
|
-
- `cli-schema` — Print the full CLI command tree as JSON.
|
|
399
|
-
- `api` — Print the full command reference as markdown.
|
|
400
|
-
- `skill` — Print a reference agent SKILL; run `configure` to install an optimized copy.
|
|
401
|
-
|
|
402
|
-
##### `full-example status docs readme`
|
|
403
|
-
|
|
404
|
-
Print README (user guide).
|
|
405
|
-
|
|
406
|
-
#### Options
|
|
407
|
-
|
|
408
|
-
| Option | Type | Required | Format / default | Description |
|
|
409
|
-
| --- | --- | --- | --- | --- |
|
|
410
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
411
|
-
|
|
412
|
-
##### `full-example status docs mcp`
|
|
413
|
-
|
|
414
|
-
Print MCP server setup and tool guidance.
|
|
415
|
-
|
|
416
|
-
#### Options
|
|
417
|
-
|
|
418
|
-
| Option | Type | Required | Format / default | Description |
|
|
419
|
-
| --- | --- | --- | --- | --- |
|
|
420
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
421
|
-
|
|
422
|
-
##### `full-example status docs http`
|
|
423
|
-
|
|
424
|
-
Print HTTP API setup and tool guidance.
|
|
425
|
-
|
|
426
|
-
#### Options
|
|
427
|
-
|
|
428
|
-
| Option | Type | Required | Format / default | Description |
|
|
429
|
-
| --- | --- | --- | --- | --- |
|
|
430
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
431
|
-
|
|
432
|
-
##### `full-example status docs openapi`
|
|
433
|
-
|
|
434
|
-
Print the HTTP OpenAPI 3.1 document as JSON.
|
|
435
|
-
|
|
436
|
-
#### Options
|
|
437
|
-
|
|
438
|
-
| Option | Type | Required | Format / default | Description |
|
|
439
|
-
| --- | --- | --- | --- | --- |
|
|
440
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
441
|
-
|
|
442
|
-
##### `full-example status docs cli-schema`
|
|
443
|
-
|
|
444
|
-
Print the full CLI command tree as JSON.
|
|
445
|
-
|
|
446
|
-
#### Options
|
|
447
|
-
|
|
448
|
-
| Option | Type | Required | Format / default | Description |
|
|
449
|
-
| --- | --- | --- | --- | --- |
|
|
450
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
451
|
-
|
|
452
|
-
##### `full-example status docs api`
|
|
453
|
-
|
|
454
|
-
Print the full command reference as markdown.
|
|
455
|
-
|
|
456
|
-
#### Options
|
|
457
|
-
|
|
458
|
-
| Option | Type | Required | Format / default | Description |
|
|
459
|
-
| --- | --- | --- | --- | --- |
|
|
460
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
461
|
-
|
|
462
|
-
##### `full-example status docs skill`
|
|
463
|
-
|
|
464
|
-
Print a reference agent SKILL; run `configure` to install an optimized copy.
|
|
465
|
-
|
|
466
|
-
#### Options
|
|
467
|
-
|
|
468
|
-
| Option | Type | Required | Format / default | Description |
|
|
469
|
-
| --- | --- | --- | --- | --- |
|
|
470
|
-
| `--save` | flag | optional | — | Write documentation to ./docs/. |
|
|
471
|
-
|
|
472
|
-
#### `full-example status mcp`
|
|
473
|
-
|
|
474
|
-
MCP server and bundle tools.
|
|
475
|
-
|
|
476
|
-
> Stdio MCP server. Add to Cursor, Claude Code, or Claude Desktop:
|
|
477
|
-
>
|
|
478
|
-
> command: full-example
|
|
479
|
-
> args: mcp
|
|
480
|
-
>
|
|
481
|
-
> Or:
|
|
482
|
-
>
|
|
483
|
-
> full-example configure
|
|
484
|
-
>
|
|
485
|
-
> Full setup guide: full-example docs mcp
|
|
486
|
-
|
|
487
|
-
**Default subcommand:** `serve` (`missingOnly`)
|
|
488
|
-
|
|
489
|
-
#### Subcommands
|
|
490
|
-
|
|
491
|
-
- `bundle` — Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
|
|
492
|
-
|
|
493
|
-
##### `full-example status mcp bundle`
|
|
494
|
-
|
|
495
|
-
Pack dist MCP artifacts (`.mcpb`, Claude Code plugin zip) from dist/<key>.
|
|
496
|
-
|
|
497
|
-
#### `full-example status api`
|
|
498
|
-
|
|
499
|
-
HTTP API server for tools.
|
|
500
|
-
|
|
501
|
-
> HTTP tool server on http://127.0.0.1:3000.
|
|
502
|
-
>
|
|
503
|
-
> Endpoints: GET /health, GET /openapi.json, GET /openapi-browser, POST /tools/:name
|
|
504
|
-
>
|
|
505
|
-
> Configure app settings:
|
|
506
|
-
>
|
|
507
|
-
> full-example configure
|
|
508
|
-
>
|
|
509
|
-
> Full setup guide: full-example docs http
|
|
510
|
-
|
|
511
|
-
**Default subcommand:** `serve` (`missingOnly`)
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"type": "object",
|
|
4
|
-
"properties": {
|
|
5
|
-
"defaultRegion": {
|
|
6
|
-
"type": "string",
|
|
7
|
-
"description": "Resolved AWS region."
|
|
8
|
-
},
|
|
9
|
-
"maxRetries": {
|
|
10
|
-
"type": "number",
|
|
11
|
-
"description": "Resolved retry count."
|
|
12
|
-
},
|
|
13
|
-
"apiTokenSet": {
|
|
14
|
-
"type": "boolean",
|
|
15
|
-
"description": "Whether apiToken is set (value never included)."
|
|
16
|
-
},
|
|
17
|
-
"version": {
|
|
18
|
-
"type": "string",
|
|
19
|
-
"description": "App version from program root."
|
|
20
|
-
}
|
|
21
|
-
},
|
|
22
|
-
"required": [
|
|
23
|
-
"apiTokenSet",
|
|
24
|
-
"version"
|
|
25
|
-
],
|
|
26
|
-
"description": "JSON stdout for `full-example status --json`.",
|
|
27
|
-
"definitions": {}
|
|
28
|
-
}
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"type": "object",
|
|
4
|
-
"properties": {
|
|
5
|
-
"apiToken": {
|
|
6
|
-
"type": "string",
|
|
7
|
-
"description": "API token from the provider dashboard."
|
|
8
|
-
},
|
|
9
|
-
"defaultRegion": {
|
|
10
|
-
"type": "string",
|
|
11
|
-
"description": "AWS region (default us-east-1).",
|
|
12
|
-
"default": "us-east-1"
|
|
13
|
-
},
|
|
14
|
-
"maxRetries": {
|
|
15
|
-
"type": "number",
|
|
16
|
-
"description": "HTTP retry count (default 3).",
|
|
17
|
-
"default": 3
|
|
18
|
-
},
|
|
19
|
-
"prefs": {
|
|
20
|
-
"type": "object",
|
|
21
|
-
"properties": {
|
|
22
|
-
"ttl": {
|
|
23
|
-
"type": "number"
|
|
24
|
-
}
|
|
25
|
-
},
|
|
26
|
-
"required": [
|
|
27
|
-
"ttl"
|
|
28
|
-
],
|
|
29
|
-
"additionalProperties": false,
|
|
30
|
-
"description": "Local preferences (file-only; not mapped to process.env)."
|
|
31
|
-
}
|
|
32
|
-
},
|
|
33
|
-
"required": [
|
|
34
|
-
"apiToken",
|
|
35
|
-
"maxRetries"
|
|
36
|
-
],
|
|
37
|
-
"additionalProperties": false,
|
|
38
|
-
"description": "Application settings for `full-example` (`program.appConfig`).",
|
|
39
|
-
"definitions": {}
|
|
40
|
-
}
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Application settings for `full-example` (`program.appConfig`).
|
|
3
|
-
*/
|
|
4
|
-
export interface AppConfig {
|
|
5
|
-
/** API token from the provider dashboard. */
|
|
6
|
-
apiToken: string;
|
|
7
|
-
/**
|
|
8
|
-
* AWS region (default us-east-1).
|
|
9
|
-
* @default us-east-1
|
|
10
|
-
*/
|
|
11
|
-
defaultRegion?: string;
|
|
12
|
-
/**
|
|
13
|
-
* HTTP retry count (default 3).
|
|
14
|
-
* @default 3
|
|
15
|
-
*/
|
|
16
|
-
maxRetries: number;
|
|
17
|
-
/** Local preferences (file-only; not mapped to process.env). */
|
|
18
|
-
prefs?: {
|
|
19
|
-
ttl: number;
|
|
20
|
-
};
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
/** Schemagen root for program.appConfig.jsonSchema. */
|
|
24
|
-
export type configType = AppConfig;
|