@bctrl/cli 0.1.0 → 0.1.2
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/README.md +80 -27
- package/dist/api/auth.d.ts +1 -0
- package/dist/api/auth.js +1 -0
- package/dist/commands/ai/index.js +25 -17
- package/dist/commands/auth/login.d.ts +3 -0
- package/dist/commands/auth/login.js +19 -5
- package/dist/commands/auth/logout.d.ts +1 -0
- package/dist/commands/auth/logout.js +1 -1
- package/dist/commands/auth/status.d.ts +2 -0
- package/dist/commands/auth/status.js +49 -5
- package/dist/commands/browser/index.js +3 -3
- package/dist/commands/file/index.js +3 -3
- package/dist/commands/invocation/index.js +3 -3
- package/dist/commands/run/index.js +6 -6
- package/dist/commands/runtime/index.js +31 -20
- package/dist/commands/shared/help.d.ts +24 -0
- package/dist/commands/shared/help.js +72 -0
- package/dist/commands/shared/io.js +1 -1
- package/dist/commands/shared/rest.d.ts +1 -1
- package/dist/commands/shared/rest.js +3 -3
- package/dist/commands/space/index.js +6 -6
- package/dist/commands/subaccount/index.js +12 -12
- package/dist/commands/vault/index.js +3 -3
- package/dist/config/auth-store.d.ts +2 -0
- package/dist/config/auth-store.js +1 -0
- package/dist/config/config.js +1 -1
- package/dist/factory.js +1 -1
- package/dist/generated/help.d.ts +205 -0
- package/dist/generated/help.js +283 -0
- package/package.json +1 -1
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
// Generated by scripts/generate/cli-help.mjs. Do not edit by hand.
|
|
2
|
+
export const CLI_HELP_COMMANDS = {
|
|
3
|
+
"runtime.create": {
|
|
4
|
+
"kind": "command",
|
|
5
|
+
"command": "runtime.create",
|
|
6
|
+
"summary": "Create a browser runtime definition. This does not start the browser.",
|
|
7
|
+
"usage": "bctrl runtime create [flags]",
|
|
8
|
+
"flags": [
|
|
9
|
+
{
|
|
10
|
+
"name": "--space",
|
|
11
|
+
"value": "<id>",
|
|
12
|
+
"description": "Owning space id.",
|
|
13
|
+
"mapsTo": "input.spaceId"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"name": "--name",
|
|
17
|
+
"value": "<name>",
|
|
18
|
+
"description": "Runtime name.",
|
|
19
|
+
"mapsTo": "input.name"
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"name": "--config-file",
|
|
23
|
+
"value": "<path>",
|
|
24
|
+
"description": "Read runtime config JSON from a file.",
|
|
25
|
+
"mapsTo": "input.config"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "--metadata-file",
|
|
29
|
+
"value": "<path>",
|
|
30
|
+
"description": "Read runtime metadata JSON from a file.",
|
|
31
|
+
"mapsTo": "input.metadata"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"name": "--input",
|
|
35
|
+
"value": "<path>",
|
|
36
|
+
"description": "Read the full JSON request body from a file, or - for stdin."
|
|
37
|
+
}
|
|
38
|
+
],
|
|
39
|
+
"input": {
|
|
40
|
+
"fields": [
|
|
41
|
+
{
|
|
42
|
+
"name": "spaceId",
|
|
43
|
+
"type": "uuid",
|
|
44
|
+
"required": true
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "type",
|
|
48
|
+
"type": "\"browser\"",
|
|
49
|
+
"values": [
|
|
50
|
+
"\"browser\""
|
|
51
|
+
],
|
|
52
|
+
"required": true
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"name": "name",
|
|
56
|
+
"type": "string",
|
|
57
|
+
"required": false
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "metadata",
|
|
61
|
+
"type": "object",
|
|
62
|
+
"required": false
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "config",
|
|
66
|
+
"type": "object",
|
|
67
|
+
"required": false
|
|
68
|
+
}
|
|
69
|
+
]
|
|
70
|
+
},
|
|
71
|
+
"output": {
|
|
72
|
+
"fields": [
|
|
73
|
+
{
|
|
74
|
+
"name": "id",
|
|
75
|
+
"type": "uuid",
|
|
76
|
+
"required": true
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "name",
|
|
80
|
+
"type": "string",
|
|
81
|
+
"required": true
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"name": "type",
|
|
85
|
+
"type": "\"browser\" | \"desktop\" | \"spreadsheet\"",
|
|
86
|
+
"values": [
|
|
87
|
+
"\"browser\"",
|
|
88
|
+
"\"desktop\"",
|
|
89
|
+
"\"spreadsheet\""
|
|
90
|
+
],
|
|
91
|
+
"required": true
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "status",
|
|
95
|
+
"type": "\"active\" | \"stopped\" | \"failed\"",
|
|
96
|
+
"values": [
|
|
97
|
+
"\"active\"",
|
|
98
|
+
"\"stopped\"",
|
|
99
|
+
"\"failed\""
|
|
100
|
+
],
|
|
101
|
+
"required": true
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"name": "activeRunId",
|
|
105
|
+
"type": "uuid | null",
|
|
106
|
+
"required": true
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"name": "createdAt",
|
|
110
|
+
"type": "string",
|
|
111
|
+
"required": true
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"name": "updatedAt",
|
|
115
|
+
"type": "string",
|
|
116
|
+
"required": true
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"name": "config",
|
|
120
|
+
"type": "object",
|
|
121
|
+
"required": false
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"name": "metadata",
|
|
125
|
+
"type": "object | null",
|
|
126
|
+
"required": false
|
|
127
|
+
}
|
|
128
|
+
]
|
|
129
|
+
},
|
|
130
|
+
"examples": [
|
|
131
|
+
{
|
|
132
|
+
"command": "bctrl runtime create --space sp_123 --name checkout-test"
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"command": "bctrl runtime create --input runtime.json"
|
|
136
|
+
}
|
|
137
|
+
],
|
|
138
|
+
"next": [
|
|
139
|
+
{
|
|
140
|
+
"command": "bctrl runtime start <runtimeId>"
|
|
141
|
+
}
|
|
142
|
+
]
|
|
143
|
+
},
|
|
144
|
+
"runtime.start": {
|
|
145
|
+
"kind": "command",
|
|
146
|
+
"command": "runtime.start",
|
|
147
|
+
"summary": "Start a runtime and open its active run.",
|
|
148
|
+
"usage": "bctrl runtime start <runtimeId>",
|
|
149
|
+
"output": {
|
|
150
|
+
"fields": [
|
|
151
|
+
{
|
|
152
|
+
"name": "runtime",
|
|
153
|
+
"type": "object",
|
|
154
|
+
"required": true
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
"name": "run",
|
|
158
|
+
"type": "object",
|
|
159
|
+
"required": true
|
|
160
|
+
}
|
|
161
|
+
]
|
|
162
|
+
},
|
|
163
|
+
"examples": [
|
|
164
|
+
{
|
|
165
|
+
"command": "bctrl runtime start rt_123"
|
|
166
|
+
}
|
|
167
|
+
],
|
|
168
|
+
"next": [
|
|
169
|
+
{
|
|
170
|
+
"command": "bctrl runtime connection create <runtimeId>"
|
|
171
|
+
}
|
|
172
|
+
]
|
|
173
|
+
},
|
|
174
|
+
"runtime.connection.create": {
|
|
175
|
+
"kind": "command",
|
|
176
|
+
"command": "runtime.connection.create",
|
|
177
|
+
"summary": "Create a short-lived CDP connection lease for a started runtime.",
|
|
178
|
+
"usage": "bctrl runtime connection create <runtimeId> [flags]",
|
|
179
|
+
"flags": [
|
|
180
|
+
{
|
|
181
|
+
"name": "--protocol",
|
|
182
|
+
"value": "<protocol>",
|
|
183
|
+
"description": "Connection protocol. Defaults to cdp.",
|
|
184
|
+
"mapsTo": "input.protocol"
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
"name": "--input",
|
|
188
|
+
"value": "<path>",
|
|
189
|
+
"description": "Read the full JSON request body from a file, or - for stdin."
|
|
190
|
+
}
|
|
191
|
+
],
|
|
192
|
+
"input": {
|
|
193
|
+
"fields": [
|
|
194
|
+
{
|
|
195
|
+
"name": "protocol",
|
|
196
|
+
"type": "\"cdp\"",
|
|
197
|
+
"values": [
|
|
198
|
+
"\"cdp\""
|
|
199
|
+
],
|
|
200
|
+
"required": true
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"name": "options",
|
|
204
|
+
"type": "object",
|
|
205
|
+
"required": false
|
|
206
|
+
}
|
|
207
|
+
]
|
|
208
|
+
},
|
|
209
|
+
"output": {
|
|
210
|
+
"fields": [
|
|
211
|
+
{
|
|
212
|
+
"name": "id",
|
|
213
|
+
"type": "uuid",
|
|
214
|
+
"required": true
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
"name": "protocol",
|
|
218
|
+
"type": "\"cdp\" | \"cua\" | \"rdp\" | \"vnc\" | \"mcp\" | \"http\"",
|
|
219
|
+
"values": [
|
|
220
|
+
"\"cdp\"",
|
|
221
|
+
"\"cua\"",
|
|
222
|
+
"\"rdp\"",
|
|
223
|
+
"\"vnc\"",
|
|
224
|
+
"\"mcp\"",
|
|
225
|
+
"\"http\""
|
|
226
|
+
],
|
|
227
|
+
"required": true
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"name": "status",
|
|
231
|
+
"type": "\"active\" | \"expired\" | \"revoked\" | \"closed\"",
|
|
232
|
+
"values": [
|
|
233
|
+
"\"active\"",
|
|
234
|
+
"\"expired\"",
|
|
235
|
+
"\"revoked\"",
|
|
236
|
+
"\"closed\""
|
|
237
|
+
],
|
|
238
|
+
"required": true
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
"name": "runId",
|
|
242
|
+
"type": "uuid",
|
|
243
|
+
"required": true
|
|
244
|
+
},
|
|
245
|
+
{
|
|
246
|
+
"name": "createdAt",
|
|
247
|
+
"type": "datetime",
|
|
248
|
+
"required": true
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "expiresAt",
|
|
252
|
+
"type": "datetime | null",
|
|
253
|
+
"required": true
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "closedAt",
|
|
257
|
+
"type": "datetime | null",
|
|
258
|
+
"required": false
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": "revokedAt",
|
|
262
|
+
"type": "datetime | null",
|
|
263
|
+
"required": false
|
|
264
|
+
},
|
|
265
|
+
{
|
|
266
|
+
"name": "endpoint",
|
|
267
|
+
"type": "object",
|
|
268
|
+
"required": true
|
|
269
|
+
}
|
|
270
|
+
]
|
|
271
|
+
},
|
|
272
|
+
"examples": [
|
|
273
|
+
{
|
|
274
|
+
"command": "bctrl runtime connection create rt_123"
|
|
275
|
+
}
|
|
276
|
+
],
|
|
277
|
+
"next": [
|
|
278
|
+
{
|
|
279
|
+
"command": "bctrl run events <runId>"
|
|
280
|
+
}
|
|
281
|
+
]
|
|
282
|
+
}
|
|
283
|
+
};
|