@vibecodr/cli 1.0.6 → 1.0.7
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 +33 -0
- package/dist/bin/vibecodr-mcp.js +32 -23
- package/dist/bin/vibecodr-mcp.js.map +1 -1
- package/dist/commands/tools.d.ts.map +1 -1
- package/dist/commands/tools.js +45 -1
- package/dist/commands/tools.js.map +1 -1
- package/dist/legacy/cli/install.js +4 -4
- package/dist/legacy/cli/run.js +353 -353
- package/dist/legacy/cli/run.js.map +1 -1
- package/dist/legacy/config/store.js +7 -7
- package/dist/legacy/core/api-client.js +3 -3
- package/dist/legacy/core/api-client.js.map +1 -1
- package/dist/legacy/core/validators.js +4 -4
- package/dist/legacy/core/version.d.ts +2 -2
- package/dist/legacy/core/version.js +1 -1
- package/docs/API-CONTRACT.md +605 -606
- package/docs/RELEASE-CHECKLIST.md +262 -260
- package/docs/SECURITY.md +157 -157
- package/docs/VALIDATION-MATRIX.md +45 -45
- package/docs/commands.md +254 -256
- package/package.json +1 -1
package/docs/commands.md
CHANGED
|
@@ -1,256 +1,254 @@
|
|
|
1
|
-
# Commands
|
|
2
|
-
|
|
3
|
-
The Vibecodr CLI talks to two hosted endpoints. Every command targets exactly one of them:
|
|
4
|
-
|
|
5
|
-
| Badge | Endpoint | Auth path |
|
|
6
|
-
|---|---|---|
|
|
7
|
-
| `H` | `tools.vibecodr.space` | device-code (`vibecodr start`
|
|
8
|
-
| `M` | `openai.vibecodr.space/mcp` | CIMD/PKCE OAuth (`vibecodr login`) -> encrypted session in OS keychain (`@vibecodr/mcp` service) + AES-GCM session file |
|
|
9
|
-
| `*` | both | command picks the credential by what it talks to; no shared bin state |
|
|
10
|
-
|
|
11
|
-
The three bin entries — `vibecodr`, `vibecodr-mcp`, `vc-tools` — all resolve to the same dispatcher. The `vc-tools` bin
|
|
12
|
-
|
|
13
|
-
## Global flags
|
|
14
|
-
|
|
15
|
-
All commands accept:
|
|
16
|
-
|
|
17
|
-
- `--profile <name>` (M)
|
|
18
|
-
- `--json` (\*)
|
|
19
|
-
- `--verbose` (\*)
|
|
20
|
-
- `--non-interactive` (\*)
|
|
21
|
-
|
|
22
|
-
The
|
|
23
|
-
|
|
24
|
-
- `--api-url <url>`
|
|
25
|
-
- `--config-dir <path>`
|
|
26
|
-
- `--credential <value>` / `--credential-file <path>` / `--credential-stdin`
|
|
27
|
-
- `--token <value>` / `--token-file <path>` / `--token-stdin`
|
|
28
|
-
- `--timeout-ms <n>` (1000..300000)
|
|
29
|
-
- `--quiet` / `-q`
|
|
30
|
-
- `--no-input`
|
|
31
|
-
- `--no-color`
|
|
32
|
-
- `--debug`
|
|
33
|
-
- `--allow-insecure-local-api`
|
|
34
|
-
|
|
35
|
-
Alternate MCP servers are profile-scoped, not runtime overrides. Use `vibecodr config profile create <name> --server-url <url>` and then login to that profile; stored tokens are bound to the server that issued them.
|
|
36
|
-
|
|
37
|
-
## Authentication
|
|
38
|
-
|
|
39
|
-
### `vibecodr login` (M)
|
|
40
|
-
|
|
41
|
-
`vibecodr login [--scope <oauth-scope>] [--registration auto|preregistered|cimd|dcr|manual] [--browser open|print] [--timeout-sec <n>]`
|
|
42
|
-
|
|
43
|
-
Authenticates this CLI against the MCP gateway via CIMD/PKCE. Prints the authorization URL by default; `--browser open` launches the browser automatically. Stores the encrypted session under the `@vibecodr/mcp` keyring service.
|
|
44
|
-
|
|
45
|
-
### `vibecodr logout` (M)
|
|
46
|
-
|
|
47
|
-
`vibecodr logout [--all] [--no-revoke]`
|
|
48
|
-
|
|
49
|
-
Clears the MCP gateway session. Does not touch editor-owned auth or the hosted Agent Computer credential.
|
|
50
|
-
|
|
51
|
-
### `vibecodr status` (M)
|
|
52
|
-
|
|
53
|
-
`vibecodr status [--probe] [--show-installs]`
|
|
54
|
-
|
|
55
|
-
Without `--probe`, reads only local state. `--show-installs` distinguishes configured, missing, and external managed installs.
|
|
56
|
-
|
|
57
|
-
### `vibecodr whoami` (M)
|
|
58
|
-
|
|
59
|
-
`vibecodr whoami [--no-login]`
|
|
60
|
-
|
|
61
|
-
Calls the protected `get_account_capabilities` MCP tool. Prints account identity, plan, CLI profile, server URL, and session state. Same refresh + interactive login retry path as `call`.
|
|
62
|
-
|
|
63
|
-
### `
|
|
64
|
-
|
|
65
|
-
`
|
|
66
|
-
|
|
67
|
-
`setup` is an alias for `start`. Walks device-code login against `api.vibecodr.space`, shows the matching approval code, waits for the user to approve in-browser, stores a durable Clerk API key under the `@vibecodr/vc-tools` keyring service (visible in the user's Clerk-managed API keys list as `"vc-tools Agent Computer"`), then returns the hosted MCP connection details an agent needs.
|
|
68
|
-
|
|
69
|
-
### `
|
|
70
|
-
|
|
71
|
-
`auth diagnose` reports local credential health and which surface owns the active session. `auth export-agent-env` emits `VC_TOOLS_*` environment variables so an isolated agent shell can pick up the cached credential.
|
|
72
|
-
|
|
73
|
-
## Agent client installation (*)
|
|
74
|
-
|
|
75
|
-
### `vibecodr install <client>` / `vibecodr uninstall <client>`
|
|
76
|
-
|
|
77
|
-
`vibecodr install <codex|cursor|vscode|windsurf|claude-desktop|claude-code> [--scope user|project] [--path <dir>] [--name <server-name>] [--open-client] [--overwrite] [--dry-run]`
|
|
78
|
-
|
|
79
|
-
Adds (or removes) the hosted Vibecodr MCP server to the client's MCP catalog. `codex`, `vscode`, and `claude-code` prefer their own CLI shim (`codex mcp add`, `code --add-mcp`, `claude mcp add`) and fall back to writing the client's config file. `cursor`, `windsurf`, `claude-desktop` always write the client's config file directly. Records the install in `installs.json` so `uninstall` can find it.
|
|
80
|
-
|
|
81
|
-
### `
|
|
82
|
-
|
|
83
|
-
`
|
|
84
|
-
|
|
85
|
-
Prints (`--print`) or installs (`--install`) the MCP connection details for the hosted Agent Computer. The `
|
|
86
|
-
|
|
87
|
-
## Hosted browser (H)
|
|
88
|
-
|
|
89
|
-
### `
|
|
90
|
-
|
|
91
|
-
- `browser read <https-url> [--out ./proof] [--no-wait] [--details]`
|
|
92
|
-
- `browser screenshot <https-url> [--format png|jpg] [--out ./proof] [--no-wait] [--details]`
|
|
93
|
-
- `browser render <https-url> [--out ./proof] [--no-wait] [--details]`
|
|
94
|
-
- `browser pdf <https-url> [--out ./proof] [--no-wait] [--details]`
|
|
95
|
-
- `browser crawl <https-url> [--max-pages n] [--max-depth n] [--out ./proof]`
|
|
96
|
-
- `browser snapshot <https-url> [--instructions <text>] [--out ./proof]`
|
|
97
|
-
- `browser ask <https-url> --instructions <text>`
|
|
98
|
-
|
|
99
|
-
Public HTTPS URLs only. Localhost, private network ranges, URL credentials, and internal hostnames are blocked before any hosted work is submitted. `--no-wait` returns immediately with a `jobId` you can follow via `
|
|
100
|
-
|
|
101
|
-
## Hosted computer (H)
|
|
102
|
-
|
|
103
|
-
### `
|
|
104
|
-
|
|
105
|
-
- `computer run <command> [--out ./proof] [--no-wait]`
|
|
106
|
-
- `computer test <command> [--out ./proof] [--no-wait]`
|
|
107
|
-
- `computer status`
|
|
108
|
-
|
|
109
|
-
`run` and `test` submit bounded commands to the hosted sandbox container (Sandbox or ProSandbox class depending on plan). Public HTTP(S) network is enabled for sandbox tests; private/metadata networks remain blocked.
|
|
110
|
-
|
|
111
|
-
## Hosted work + proof (H)
|
|
112
|
-
|
|
113
|
-
### `
|
|
114
|
-
|
|
115
|
-
- `work list`
|
|
116
|
-
- `work follow <jobId> [--no-wait] [--timeout-sec <n>]`
|
|
117
|
-
- `work show <jobId>`
|
|
118
|
-
- `work cancel <jobId>`
|
|
119
|
-
- `work submit <command-spec>`
|
|
120
|
-
|
|
121
|
-
### `
|
|
122
|
-
|
|
123
|
-
- `proof list [--limit <n>] [--cursor <c>]`
|
|
124
|
-
- `proof get <artifactId>`
|
|
125
|
-
- `proof save <artifactId> --out <path>`
|
|
126
|
-
- `proof download <artifactId> --out <path>`
|
|
127
|
-
- `proof delete <artifactId>`
|
|
128
|
-
|
|
129
|
-
Artifact output is workspace-bounded: downloaded bytes can only be written to files you intentionally target inside the current workspace. Use `--out ./artifacts`, `--out ./artifacts/report.pdf`, or `cd` to the intended workspace and use `--out .`.
|
|
130
|
-
|
|
131
|
-
### `
|
|
132
|
-
|
|
133
|
-
`jobs list|status|cancel` and `artifacts list|get|delete` are lower-level surfaces over the same underlying entities; prefer `work` and `proof` for the common flows.
|
|
134
|
-
|
|
135
|
-
## Plan + usage (H)
|
|
136
|
-
|
|
137
|
-
### `
|
|
138
|
-
|
|
139
|
-
`
|
|
140
|
-
|
|
141
|
-
### `
|
|
142
|
-
|
|
143
|
-
- `grants list`
|
|
144
|
-
- `grants refresh`
|
|
145
|
-
|
|
146
|
-
Inspects scoped grants the worker issues to bind a tool call to a plan + capability set.
|
|
147
|
-
|
|
148
|
-
### `
|
|
149
|
-
|
|
150
|
-
`retention` shows or sets the account's proof-retention policy. `scheduled-qa` shows or schedules recurring QA runs (rate-limited per plan).
|
|
151
|
-
|
|
152
|
-
### `
|
|
153
|
-
|
|
154
|
-
Prints the plan packaging matrix (Free / Creator / Pro). With `--details`, includes per-capability limits and the tool-credit breakdown.
|
|
155
|
-
|
|
156
|
-
### `
|
|
157
|
-
|
|
158
|
-
Prints the URL of the hosted supervision dashboard. Does not open a browser; that is left to the caller.
|
|
159
|
-
|
|
160
|
-
## MCP gateway tooling (M)
|
|
161
|
-
|
|
162
|
-
### `vibecodr tools` / `vibecodr tools test`
|
|
163
|
-
|
|
164
|
-
`vibecodr tools [<tool-name>] [--search <text>] [--schema] [--no-login]`
|
|
165
|
-
|
|
166
|
-
Lists the live MCP tool catalog from `openai.vibecodr.space/mcp`. With `<tool-name>`, prints the schema for that tool. `--schema` includes the full JSON schema. `tools test <tool-name>` runs the gateway's `validators` against a sample input.
|
|
167
|
-
|
|
168
|
-
### `vibecodr call <tool-name>`
|
|
169
|
-
|
|
170
|
-
`vibecodr call <tool-name> [--input-json <json>] [--input-file <path>] [--stdin] [--interactive] [--timeout-sec <n>] [--no-login] [--confirm]`
|
|
171
|
-
|
|
172
|
-
Invokes the named MCP tool. `--interactive` supports top-level scalar object fields; richer schemas should use `--input-json` or `--input-file`. `--confirm` is required for known mutating tools. The CLI redacts source, descriptor, token, secret, and inline file-content fields from displayed arguments and results while preserving safe operator handles (`artifactId`, `jobId`, `requestId`, `traceId`, `errorCode`, `credentialType`, `tokenCount`, `tokenKind`). The gateway remains the authority boundary for OAuth, owner scoping, confirmation policy, and output shaping. `--timeout-sec <n>` changes only the local MCP transport timeout and is not forwarded as a server tool argument.
|
|
173
|
-
|
|
174
|
-
For `quick_publish_creation` with `payload.importMode: "direct_files"`, pass file paths as normal slash-separated project paths (`src/main.tsx`, `src/server/binding-proof.js`). Do not pre-encode slashes as `%2F`; the hosted gateway encodes each URL segment when it writes files to Vibecodr.
|
|
175
|
-
|
|
176
|
-
### `vibecodr upload`
|
|
177
|
-
|
|
178
|
-
`vibecodr upload --zip <path>` or `vibecodr upload --image <path> [--kind cover_image|avatar_image]`
|
|
179
|
-
|
|
180
|
-
Direct-to-R2 staged uploads (no base64 payloads). Hosted gateway returns a presigned R2 PUT URL, the CLI streams the file, then the gateway records the upload metadata. Image uploads accept the kind discriminator.
|
|
181
|
-
|
|
182
|
-
## Pulse (M)
|
|
183
|
-
|
|
184
|
-
### `vibecodr pulse-setup`
|
|
185
|
-
|
|
186
|
-
`vibecodr pulse-setup [--descriptor-setup-json <json> | --descriptor-setup-file <path>]`
|
|
187
|
-
|
|
188
|
-
Walks live Pulse setup (provider connections, secret bindings, Stripe-first webhook helper). Without args, prompts interactively.
|
|
189
|
-
|
|
190
|
-
### `vibecodr pulse-publish`
|
|
191
|
-
|
|
192
|
-
`vibecodr pulse-publish --name <name> (--code <source> | --code-file <path>) --confirm`
|
|
193
|
-
|
|
194
|
-
Publishes a standalone Pulse with private source/metadata visibility by default. Runtime URL is public HTTP unless the Pulse code rejects callers. `--confirm` is required.
|
|
195
|
-
|
|
196
|
-
### `vibecodr pulse <subcommand>`
|
|
197
|
-
|
|
198
|
-
- `pulse list`
|
|
199
|
-
- `pulse get <pulseId>`
|
|
200
|
-
- `pulse status <pulseId>`
|
|
201
|
-
- `pulse run <pulseId>`
|
|
202
|
-
- `pulse archive <pulseId> --confirm`
|
|
203
|
-
- `pulse restore <pulseId> --confirm`
|
|
204
|
-
- `pulse create --confirm`
|
|
205
|
-
- `pulse deploy <pulseId>`
|
|
206
|
-
|
|
207
|
-
Convenience wrappers over the gateway's Pulse lifecycle. `create` and `deploy` are aliases for the create-and-publish sequence; prefer the explicit form when scripting.
|
|
208
|
-
|
|
209
|
-
## Convenience (*)
|
|
210
|
-
|
|
211
|
-
### `
|
|
212
|
-
|
|
213
|
-
`
|
|
214
|
-
|
|
215
|
-
Runs a small browser + computer + proof + usage check end-to-end to verify the account, the credential, and the hosted plumbing.
|
|
216
|
-
|
|
217
|
-
### `vibecodr doctor`
|
|
218
|
-
|
|
219
|
-
`vibecodr doctor [--json]` walks local health: secret store availability, browser launcher, network reachability, MCP gateway handshake, hosted worker handshake.
|
|
220
|
-
|
|
221
|
-
`
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
`
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
`vibecodr-mcp
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
|
247
|
-
|
|
248
|
-
|
|
|
249
|
-
|
|
|
250
|
-
|
|
|
251
|
-
|
|
|
252
|
-
|
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
`--json` shape is `{ ok: true, data, warnings }` on success and `{ ok: false, error: { code, message, status, details } }` on failure. Volatile fields (`requestId`, `traceId`, timestamps) appear in `data` / `error.details` but are filtered out of the §14 output-baseline regression contract.
|
|
1
|
+
# Commands
|
|
2
|
+
|
|
3
|
+
The Vibecodr CLI talks to two hosted endpoints. Every command targets exactly one of them:
|
|
4
|
+
|
|
5
|
+
| Badge | Endpoint | Auth path |
|
|
6
|
+
|---|---|---|
|
|
7
|
+
| `H` | `tools.vibecodr.space` | device-code (`vibecodr start`) -> durable Clerk API key in OS keychain (`@vibecodr/vc-tools` service) |
|
|
8
|
+
| `M` | `openai.vibecodr.space/mcp` | CIMD/PKCE OAuth (`vibecodr login`) -> encrypted session in OS keychain (`@vibecodr/mcp` service) + AES-GCM session file |
|
|
9
|
+
| `*` | both | command picks the credential by what it talks to; no shared bin state |
|
|
10
|
+
|
|
11
|
+
The three bin entries — `vibecodr`, `vibecodr-mcp`, `vc-tools` — all resolve to the same dispatcher. The `vc-tools` bin remains for back-compat and routes every command through the legacy code path so output is byte-equivalent to `@vibecodr/vc-tools@0.1.4`. The `vibecodr` bin runs the MCP-gateway commands inline and cross-routes the hosted Agent Computer commands into the legacy code path. The `vibecodr-mcp` bin is the alias preserved from `@vibecodr/cli@0.2.x`.
|
|
12
|
+
|
|
13
|
+
## Global flags
|
|
14
|
+
|
|
15
|
+
All commands accept:
|
|
16
|
+
|
|
17
|
+
- `--profile <name>` (M)
|
|
18
|
+
- `--json` (\*)
|
|
19
|
+
- `--verbose` (\*)
|
|
20
|
+
- `--non-interactive` (\*)
|
|
21
|
+
|
|
22
|
+
The hosted Agent Computer commands also accept:
|
|
23
|
+
|
|
24
|
+
- `--api-url <url>`
|
|
25
|
+
- `--config-dir <path>`
|
|
26
|
+
- `--credential <value>` / `--credential-file <path>` / `--credential-stdin`
|
|
27
|
+
- `--token <value>` / `--token-file <path>` / `--token-stdin`
|
|
28
|
+
- `--timeout-ms <n>` (1000..300000)
|
|
29
|
+
- `--quiet` / `-q`
|
|
30
|
+
- `--no-input`
|
|
31
|
+
- `--no-color`
|
|
32
|
+
- `--debug`
|
|
33
|
+
- `--allow-insecure-local-api`
|
|
34
|
+
|
|
35
|
+
Alternate MCP servers are profile-scoped, not runtime overrides. Use `vibecodr config profile create <name> --server-url <url>` and then login to that profile; stored tokens are bound to the server that issued them.
|
|
36
|
+
|
|
37
|
+
## Authentication
|
|
38
|
+
|
|
39
|
+
### `vibecodr login` (M)
|
|
40
|
+
|
|
41
|
+
`vibecodr login [--scope <oauth-scope>] [--registration auto|preregistered|cimd|dcr|manual] [--browser open|print] [--timeout-sec <n>]`
|
|
42
|
+
|
|
43
|
+
Authenticates this CLI against the MCP gateway via CIMD/PKCE. Prints the authorization URL by default; `--browser open` launches the browser automatically. Stores the encrypted session under the `@vibecodr/mcp` keyring service.
|
|
44
|
+
|
|
45
|
+
### `vibecodr logout` (M)
|
|
46
|
+
|
|
47
|
+
`vibecodr logout [--all] [--no-revoke]`
|
|
48
|
+
|
|
49
|
+
Clears the MCP gateway session. Does not touch editor-owned auth or the hosted Agent Computer credential.
|
|
50
|
+
|
|
51
|
+
### `vibecodr status` (M)
|
|
52
|
+
|
|
53
|
+
`vibecodr status [--probe] [--show-installs]`
|
|
54
|
+
|
|
55
|
+
Without `--probe`, reads only local state. `--show-installs` distinguishes configured, missing, and external managed installs.
|
|
56
|
+
|
|
57
|
+
### `vibecodr whoami` (M)
|
|
58
|
+
|
|
59
|
+
`vibecodr whoami [--no-login]`
|
|
60
|
+
|
|
61
|
+
Calls the protected `get_account_capabilities` MCP tool. Prints account identity, plan, CLI profile, server URL, and session state. Same refresh + interactive login retry path as `call`.
|
|
62
|
+
|
|
63
|
+
### `vibecodr start` / `vibecodr setup` (H)
|
|
64
|
+
|
|
65
|
+
`vibecodr start [--api-url <url>] [--browser open|print] [--credential ...] [--token ...] [--no-input]`
|
|
66
|
+
|
|
67
|
+
`setup` is an alias for `start`. Walks device-code login against `api.vibecodr.space`, shows the matching approval code, waits for the user to approve in-browser, stores a durable Clerk API key under the `@vibecodr/vc-tools` keyring service (visible in the user's Clerk-managed API keys list as `"vc-tools Agent Computer"`), then returns the hosted MCP connection details an agent needs.
|
|
68
|
+
|
|
69
|
+
### `vibecodr auth diagnose` / `vibecodr auth export-agent-env` (H)
|
|
70
|
+
|
|
71
|
+
`auth diagnose` reports local credential health and which surface owns the active session. `auth export-agent-env` emits `VC_TOOLS_*` environment variables so an isolated agent shell can pick up the cached credential.
|
|
72
|
+
|
|
73
|
+
## Agent client installation (*)
|
|
74
|
+
|
|
75
|
+
### `vibecodr install <client>` / `vibecodr uninstall <client>`
|
|
76
|
+
|
|
77
|
+
`vibecodr install <codex|cursor|vscode|windsurf|claude-desktop|claude-code> [--scope user|project] [--path <dir>] [--name <server-name>] [--open-client] [--overwrite] [--dry-run]`
|
|
78
|
+
|
|
79
|
+
Adds (or removes) the hosted Vibecodr MCP server to the client's MCP catalog. `codex`, `vscode`, and `claude-code` prefer their own CLI shim (`codex mcp add`, `code --add-mcp`, `claude mcp add`) and fall back to writing the client's config file. `cursor`, `windsurf`, `claude-desktop` always write the client's config file directly. Records the install in `installs.json` so `uninstall` can find it.
|
|
80
|
+
|
|
81
|
+
### `vibecodr connect` / `vibecodr agent connect` (H)
|
|
82
|
+
|
|
83
|
+
`vibecodr connect --client <codex|cursor|vscode|windsurf|claude-desktop|claude-code> [--print] [--name <server-name>] [--install] [--overwrite]`
|
|
84
|
+
|
|
85
|
+
Prints (`--print`) or installs (`--install`) the MCP connection details for the hosted Agent Computer. The `vibecodr agent connect` form is the agent-shaped alias; both reach the same code path.
|
|
86
|
+
|
|
87
|
+
## Hosted browser (H)
|
|
88
|
+
|
|
89
|
+
### `vibecodr browser <subcommand>`
|
|
90
|
+
|
|
91
|
+
- `browser read <https-url> [--out ./proof] [--no-wait] [--details]`
|
|
92
|
+
- `browser screenshot <https-url> [--format png|jpg] [--out ./proof] [--no-wait] [--details]`
|
|
93
|
+
- `browser render <https-url> [--out ./proof] [--no-wait] [--details]`
|
|
94
|
+
- `browser pdf <https-url> [--out ./proof] [--no-wait] [--details]`
|
|
95
|
+
- `browser crawl <https-url> [--max-pages n] [--max-depth n] [--out ./proof]`
|
|
96
|
+
- `browser snapshot <https-url> [--instructions <text>] [--out ./proof]`
|
|
97
|
+
- `browser ask <https-url> --instructions <text>`
|
|
98
|
+
|
|
99
|
+
Public HTTPS URLs only. Localhost, private network ranges, URL credentials, and internal hostnames are blocked before any hosted work is submitted. `--no-wait` returns immediately with a `jobId` you can follow via `vibecodr work follow`. `--details` includes capability metadata in the response.
|
|
100
|
+
|
|
101
|
+
## Hosted computer (H)
|
|
102
|
+
|
|
103
|
+
### `vibecodr computer <subcommand>`
|
|
104
|
+
|
|
105
|
+
- `computer run <command> [--out ./proof] [--no-wait]`
|
|
106
|
+
- `computer test <command> [--out ./proof] [--no-wait]`
|
|
107
|
+
- `computer status`
|
|
108
|
+
|
|
109
|
+
`run` and `test` submit bounded commands to the hosted sandbox container (Sandbox or ProSandbox class depending on plan). Public HTTP(S) network is enabled for sandbox tests; private/metadata networks remain blocked.
|
|
110
|
+
|
|
111
|
+
## Hosted work + proof (H)
|
|
112
|
+
|
|
113
|
+
### `vibecodr work <subcommand>`
|
|
114
|
+
|
|
115
|
+
- `work list`
|
|
116
|
+
- `work follow <jobId> [--no-wait] [--timeout-sec <n>]`
|
|
117
|
+
- `work show <jobId>`
|
|
118
|
+
- `work cancel <jobId>`
|
|
119
|
+
- `work submit <command-spec>`
|
|
120
|
+
|
|
121
|
+
### `vibecodr proof <subcommand>`
|
|
122
|
+
|
|
123
|
+
- `proof list [--limit <n>] [--cursor <c>]`
|
|
124
|
+
- `proof get <artifactId>`
|
|
125
|
+
- `proof save <artifactId> --out <path>`
|
|
126
|
+
- `proof download <artifactId> --out <path>`
|
|
127
|
+
- `proof delete <artifactId>`
|
|
128
|
+
|
|
129
|
+
Artifact output is workspace-bounded: downloaded bytes can only be written to files you intentionally target inside the current workspace. Use `--out ./artifacts`, `--out ./artifacts/report.pdf`, or `cd` to the intended workspace and use `--out .`.
|
|
130
|
+
|
|
131
|
+
### `vibecodr jobs <subcommand>` / `vibecodr artifacts <subcommand>`
|
|
132
|
+
|
|
133
|
+
`jobs list|status|cancel` and `artifacts list|get|delete` are lower-level surfaces over the same underlying entities; prefer `work` and `proof` for the common flows.
|
|
134
|
+
|
|
135
|
+
## Plan + usage (H)
|
|
136
|
+
|
|
137
|
+
### `vibecodr usage` / `vibecodr limits`
|
|
138
|
+
|
|
139
|
+
`vibecodr usage [--json]` (and the `limits` alias) reports the account's plan name, monthly and daily credit counters, current concurrent runs, and remaining headroom. The hosted worker is the authority; the CLI does not cache quotas.
|
|
140
|
+
|
|
141
|
+
### `vibecodr grants <subcommand>`
|
|
142
|
+
|
|
143
|
+
- `grants list`
|
|
144
|
+
- `grants refresh`
|
|
145
|
+
|
|
146
|
+
Inspects scoped grants the worker issues to bind a tool call to a plan + capability set.
|
|
147
|
+
|
|
148
|
+
### `vibecodr retention` / `vibecodr scheduled-qa`
|
|
149
|
+
|
|
150
|
+
`retention` shows or sets the account's proof-retention policy. `scheduled-qa` shows or schedules recurring QA runs (rate-limited per plan).
|
|
151
|
+
|
|
152
|
+
### `vibecodr plans [--details]`
|
|
153
|
+
|
|
154
|
+
Prints the plan packaging matrix (Free / Creator / Pro). With `--details`, includes per-capability limits and the tool-credit breakdown.
|
|
155
|
+
|
|
156
|
+
### `vibecodr dashboard`
|
|
157
|
+
|
|
158
|
+
Prints the URL of the hosted supervision dashboard. Does not open a browser; that is left to the caller.
|
|
159
|
+
|
|
160
|
+
## MCP gateway tooling (M)
|
|
161
|
+
|
|
162
|
+
### `vibecodr tools` / `vibecodr tools test`
|
|
163
|
+
|
|
164
|
+
`vibecodr tools [<tool-name>] [--search <text>] [--schema] [--no-login]`
|
|
165
|
+
|
|
166
|
+
Lists the live MCP tool catalog from `openai.vibecodr.space/mcp`. With `<tool-name>`, prints the schema for that tool. `--schema` includes the full JSON schema. `tools test <tool-name>` runs the gateway's `validators` against a sample input.
|
|
167
|
+
|
|
168
|
+
### `vibecodr call <tool-name>`
|
|
169
|
+
|
|
170
|
+
`vibecodr call <tool-name> [--input-json <json>] [--input-file <path>] [--stdin] [--interactive] [--timeout-sec <n>] [--no-login] [--confirm]`
|
|
171
|
+
|
|
172
|
+
Invokes the named MCP tool. `--interactive` supports top-level scalar object fields; richer schemas should use `--input-json` or `--input-file`. `--confirm` is required for known mutating tools. The CLI redacts source, descriptor, token, secret, and inline file-content fields from displayed arguments and results while preserving safe operator handles (`artifactId`, `jobId`, `requestId`, `traceId`, `errorCode`, `credentialType`, `tokenCount`, `tokenKind`). The gateway remains the authority boundary for OAuth, owner scoping, confirmation policy, and output shaping. `--timeout-sec <n>` changes only the local MCP transport timeout and is not forwarded as a server tool argument.
|
|
173
|
+
|
|
174
|
+
For `quick_publish_creation` with `payload.importMode: "direct_files"`, pass file paths as normal slash-separated project paths (`src/main.tsx`, `src/server/binding-proof.js`). Do not pre-encode slashes as `%2F`; the hosted gateway encodes each URL segment when it writes files to Vibecodr.
|
|
175
|
+
|
|
176
|
+
### `vibecodr upload`
|
|
177
|
+
|
|
178
|
+
`vibecodr upload --zip <path>` or `vibecodr upload --image <path> [--kind cover_image|avatar_image]`
|
|
179
|
+
|
|
180
|
+
Direct-to-R2 staged uploads (no base64 payloads). Hosted gateway returns a presigned R2 PUT URL, the CLI streams the file, then the gateway records the upload metadata. Image uploads accept the kind discriminator.
|
|
181
|
+
|
|
182
|
+
## Pulse (M)
|
|
183
|
+
|
|
184
|
+
### `vibecodr pulse-setup`
|
|
185
|
+
|
|
186
|
+
`vibecodr pulse-setup [--descriptor-setup-json <json> | --descriptor-setup-file <path>]`
|
|
187
|
+
|
|
188
|
+
Walks live Pulse setup (provider connections, secret bindings, Stripe-first webhook helper). Without args, prompts interactively.
|
|
189
|
+
|
|
190
|
+
### `vibecodr pulse-publish`
|
|
191
|
+
|
|
192
|
+
`vibecodr pulse-publish --name <name> (--code <source> | --code-file <path>) --confirm`
|
|
193
|
+
|
|
194
|
+
Publishes a standalone Pulse with private source/metadata visibility by default. Runtime URL is public HTTP unless the Pulse code rejects callers. `--confirm` is required.
|
|
195
|
+
|
|
196
|
+
### `vibecodr pulse <subcommand>`
|
|
197
|
+
|
|
198
|
+
- `pulse list`
|
|
199
|
+
- `pulse get <pulseId>`
|
|
200
|
+
- `pulse status <pulseId>`
|
|
201
|
+
- `pulse run <pulseId>`
|
|
202
|
+
- `pulse archive <pulseId> --confirm`
|
|
203
|
+
- `pulse restore <pulseId> --confirm`
|
|
204
|
+
- `pulse create --confirm`
|
|
205
|
+
- `pulse deploy <pulseId>`
|
|
206
|
+
|
|
207
|
+
Convenience wrappers over the gateway's Pulse lifecycle. `create` and `deploy` are aliases for the create-and-publish sequence; prefer the explicit form when scripting.
|
|
208
|
+
|
|
209
|
+
## Convenience (*)
|
|
210
|
+
|
|
211
|
+
### `vibecodr try` (H)
|
|
212
|
+
|
|
213
|
+
`vibecodr try [--out ./proof]`
|
|
214
|
+
|
|
215
|
+
Runs a small browser + computer + proof + usage check end-to-end to verify the account, the credential, and the hosted plumbing.
|
|
216
|
+
|
|
217
|
+
### `vibecodr doctor` (*)
|
|
218
|
+
|
|
219
|
+
`vibecodr doctor [--json]` walks local health: secret store availability, browser launcher, network reachability, MCP gateway handshake, hosted worker handshake. Includes device-code surface checks for the hosted Agent Computer.
|
|
220
|
+
|
|
221
|
+
### `vibecodr config` (*)
|
|
222
|
+
|
|
223
|
+
`config` reads and writes the CLI's profile catalog. Sub-surfaces include profile create, profile select, profile list, get, set.
|
|
224
|
+
|
|
225
|
+
### `vibecodr inspect` (H)
|
|
226
|
+
|
|
227
|
+
`vibecodr inspect --json`
|
|
228
|
+
|
|
229
|
+
Emits the goal-coverage map (which hosted capabilities are local-verified vs hosted-required vs production-smoked). Used by the release-readiness check.
|
|
230
|
+
|
|
231
|
+
## Legacy bin aliases
|
|
232
|
+
|
|
233
|
+
`vibecodr-mcp <command> ...` and `vc-tools <command> ...` are bin entries kept for back-compat; both route into the same dispatcher.
|
|
234
|
+
|
|
235
|
+
- `vibecodr-mcp` produces output byte-equivalent to `@vibecodr/cli@0.2.11` for every MCP-gateway command.
|
|
236
|
+
- `vc-tools` produces output byte-equivalent to `@vibecodr/vc-tools@0.1.4` for every hosted Agent Computer command.
|
|
237
|
+
|
|
238
|
+
If you have scripts that call either binary, no changes are required. New scripts and docs should use `vibecodr`.
|
|
239
|
+
|
|
240
|
+
## Output and exit codes
|
|
241
|
+
|
|
242
|
+
All commands return non-zero on failure. Stable codes:
|
|
243
|
+
|
|
244
|
+
| Code | Meaning |
|
|
245
|
+
|---|---|
|
|
246
|
+
| 0 | success |
|
|
247
|
+
| 2 | usage / input validation |
|
|
248
|
+
| 3 | auth / session |
|
|
249
|
+
| 4 | quota / plan limit |
|
|
250
|
+
| 5 | local config / storage |
|
|
251
|
+
| 6 | install / uninstall conflict |
|
|
252
|
+
| 7 | runtime / hosted failure |
|
|
253
|
+
|
|
254
|
+
`--json` shape is `{ ok: true, data, warnings }` on success and `{ ok: false, error: { code, message, status, details } }` on failure. Volatile fields (`requestId`, `traceId`, timestamps) appear in `data` / `error.details` but are filtered out of the §14 output-baseline regression contract.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vibecodr/cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.7",
|
|
4
4
|
"description": "The official Vibecodr CLI: hosted browser, hosted computer, capsule uploads, Pulse operations, and agent-client MCP setup under one command.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|