@bctrl/cli 0.1.3 → 0.1.4

package/dist/generated/help.d.ts

@@ -1,44 +1,20 @@
 export declare const CLI_HELP_COMMANDS: {
-    readonly "runtime.create": {
-        readonly kind: "command";
-        readonly command: "runtime.create";
+    readonly "runtimes.create": {
+        readonly kind: "topic";
+        readonly topic: "runtimes.create";
+        readonly aliases: readonly ["runtime.create", "bctrl runtime create"];
+        readonly title: "Create a runtime";
         readonly summary: "Create a browser runtime definition. This does not start the browser.";
-        readonly usage: "bctrl runtime create [flags]";
-        readonly flags: readonly [{
-            readonly name: "--space";
-            readonly value: "<id>";
-            readonly description: "Owning space id.";
-            readonly mapsTo: "input.spaceId";
-        }, {
-            readonly name: "--name";
-            readonly value: "<name>";
-            readonly description: "Runtime name.";
-            readonly mapsTo: "input.name";
-        }, {
-            readonly name: "--config-file";
-            readonly value: "<path>";
-            readonly description: "Read runtime config JSON from a file.";
-            readonly mapsTo: "input.config";
-        }, {
-            readonly name: "--metadata-file";
-            readonly value: "<path>";
-            readonly description: "Read runtime metadata JSON from a file.";
-            readonly mapsTo: "input.metadata";
-        }, {
-            readonly name: "--input";
-            readonly value: "<path>";
-            readonly description: "Read the full JSON request body from a file, or - for stdin.";
-        }];
         readonly input: {
             readonly fields: readonly [{
                 readonly name: "spaceId";
-                readonly type: "uuid";
-                readonly required: true;
+                readonly type: "uuid | \"default\"";
+                readonly required: false;
             }, {
                 readonly name: "type";
                 readonly type: "\"browser\"";
                 readonly values: readonly ["\"browser\""];
-                readonly required: true;
+                readonly required: false;
             }, {
                 readonly name: "name";
                 readonly type: "string";
@@ -58,14 +34,18 @@ export declare const CLI_HELP_COMMANDS: {
                 readonly name: "id";
                 readonly type: "uuid";
                 readonly required: true;
+            }, {
+                readonly name: "spaceId";
+                readonly type: "uuid";
+                readonly required: true;
             }, {
                 readonly name: "name";
                 readonly type: "string";
                 readonly required: true;
             }, {
                 readonly name: "type";
-                readonly type: "\"browser\" | \"desktop\" | \"spreadsheet\"";
-                readonly values: readonly ["\"browser\"", "\"desktop\"", "\"spreadsheet\""];
+                readonly type: "\"browser\"";
+                readonly values: readonly ["\"browser\""];
                 readonly required: true;
             }, {
                 readonly name: "status";
@@ -76,13 +56,17 @@ export declare const CLI_HELP_COMMANDS: {
                 readonly name: "activeRunId";
                 readonly type: "uuid | null";
                 readonly required: true;
+            }, {
+                readonly name: "lastActivityAt";
+                readonly type: "datetime";
+                readonly required: false;
             }, {
                 readonly name: "createdAt";
-                readonly type: "string";
+                readonly type: "datetime";
                 readonly required: true;
             }, {
                 readonly name: "updatedAt";
-                readonly type: "string";
+                readonly type: "datetime";
                 readonly required: true;
             }, {
                 readonly name: "config";
@@ -94,39 +78,141 @@ export declare const CLI_HELP_COMMANDS: {
                 readonly required: false;
             }];
         };
+        readonly api: {
+            readonly method: "POST";
+            readonly path: "/v1/runtimes";
+            readonly operationId: "runtimes.create";
+            readonly requestFields: readonly ["spaceId", "type", "name", "config", "metadata"];
+            readonly responseFields: readonly ["id", "spaceId", "name", "type", "status", "activeRunId", "lastActivityAt", "createdAt", "updatedAt", "config", "metadata"];
+        };
+        readonly sdk: readonly [{
+            readonly language: "typescript";
+            readonly package: "@bctrl/sdk";
+            readonly method: "client.runtimes.create";
+        }];
+        readonly cli: {
+            readonly command: "bctrl runtime create";
+            readonly usage: "bctrl runtime create [flags]";
+            readonly flags: readonly [{
+                readonly name: "--space";
+                readonly value: "<id>";
+                readonly description: "Owning space id.";
+            }, {
+                readonly name: "--name";
+                readonly value: "<name>";
+                readonly description: "Runtime name.";
+            }, {
+                readonly name: "--profile";
+                readonly description: "Persist browser state across runtime starts.";
+            }, {
+                readonly name: "--proxy";
+                readonly value: "<id-or-url>";
+                readonly description: "Saved proxy id or inline custom proxy URL.";
+            }, {
+                readonly name: "--device";
+                readonly value: "<desktop|mobile>";
+                readonly description: "Fingerprint device filter.";
+            }, {
+                readonly name: "--os";
+                readonly value: "<windows|macos|android|ios>";
+                readonly description: "Fingerprint OS filter.";
+            }, {
+                readonly name: "--browser";
+                readonly value: "<chrome|edge|safari>";
+                readonly description: "Fingerprint browser filter.";
+            }, {
+                readonly name: "--browser-version";
+                readonly value: "<version>";
+                readonly description: "Fingerprint browser version filter.";
+            }, {
+                readonly name: "--locale";
+                readonly value: "<locale>";
+                readonly description: "Fingerprint locale/language filter; repeat to set an ordered language stack.";
+            }, {
+                readonly name: "--config-file";
+                readonly value: "<path>";
+                readonly description: "Read runtime config JSON from a file.";
+            }, {
+                readonly name: "--metadata-file";
+                readonly value: "<path>";
+                readonly description: "Read runtime metadata JSON from a file.";
+            }, {
+                readonly name: "--input";
+                readonly value: "<path>";
+                readonly description: "Read the full JSON request body from a file, or - for stdin.";
+            }];
+        };
         readonly examples: readonly [{
+            readonly audience: "cli";
             readonly command: "bctrl runtime create --space sp_123 --name checkout-test";
         }, {
+            readonly audience: "cli";
+            readonly command: "bctrl runtime create --name mobile-de --proxy pxy_123 --device mobile --os ios --browser safari --locale de-DE --locale de";
+        }, {
+            readonly audience: "cli";
             readonly command: "bctrl runtime create --input runtime.json";
         }];
         readonly next: readonly [{
+            readonly topic: "runtimes.start";
             readonly command: "bctrl runtime start <runtimeId>";
         }];
     };
-    readonly "runtime.start": {
-        readonly kind: "command";
-        readonly command: "runtime.start";
+    readonly "runtimes.start": {
+        readonly kind: "topic";
+        readonly topic: "runtimes.start";
+        readonly aliases: readonly ["runtime.start", "bctrl runtime start"];
+        readonly title: "Start a runtime";
         readonly summary: "Start a runtime and open its active run.";
-        readonly usage: "bctrl runtime start <runtimeId>";
         readonly output: {
             readonly fields: readonly [{
-                readonly name: "runtime";
-                readonly type: "object";
+                readonly name: "runtimeId";
+                readonly type: "uuid";
                 readonly required: true;
             }, {
-                readonly name: "run";
-                readonly type: "object";
+                readonly name: "runId";
+                readonly type: "uuid";
                 readonly required: true;
             }, {
-                readonly name: "browser";
-                readonly type: "object";
+                readonly name: "status";
+                readonly type: "\"active\" | \"stopped\" | \"failed\"";
+                readonly values: readonly ["\"active\"", "\"stopped\"", "\"failed\""];
+                readonly required: true;
+            }, {
+                readonly name: "connectUrl";
+                readonly type: "string";
+                readonly required: true;
+            }, {
+                readonly name: "protocol";
+                readonly type: "\"cdp\"";
+                readonly values: readonly ["\"cdp\""];
+                readonly required: true;
+            }, {
+                readonly name: "started";
+                readonly type: "boolean";
                 readonly required: true;
             }];
         };
+        readonly api: {
+            readonly method: "POST";
+            readonly path: "/v1/runtimes/{runtimeId}/start";
+            readonly operationId: "runtimes.start";
+            readonly responseFields: readonly ["runtimeId", "runId", "status", "connectUrl", "protocol", "started"];
+        };
+        readonly sdk: readonly [{
+            readonly language: "typescript";
+            readonly package: "@bctrl/sdk";
+            readonly method: "client.runtimes.start";
+        }];
+        readonly cli: {
+            readonly command: "bctrl runtime start";
+            readonly usage: "bctrl runtime start <runtimeId>";
+        };
         readonly examples: readonly [{
+            readonly audience: "cli";
             readonly command: "bctrl runtime start rt_123";
         }];
         readonly next: readonly [{
+            readonly topic: "runs.activity.list";
             readonly command: "bctrl run events <runId>";
         }];
     };

package/dist/generated/help.js

@@ -1,47 +1,20 @@
 // Generated by scripts/generate/cli-help.mjs. Do not edit by hand.
 export const CLI_HELP_COMMANDS = {
-    "runtime.create": {
-        "kind": "command",
-        "command": "runtime.create",
-        "summary": "Create a browser runtime definition. This does not start the browser.",
-        "usage": "bctrl runtime create [flags]",
-        "flags": [
-            {
-                "name": "--space",
-                "value": "<id>",
-                "description": "Owning space id.",
-                "mapsTo": "input.spaceId"
-            },
-            {
-                "name": "--name",
-                "value": "<name>",
-                "description": "Runtime name.",
-                "mapsTo": "input.name"
-            },
-            {
-                "name": "--config-file",
-                "value": "<path>",
-                "description": "Read runtime config JSON from a file.",
-                "mapsTo": "input.config"
-            },
-            {
-                "name": "--metadata-file",
-                "value": "<path>",
-                "description": "Read runtime metadata JSON from a file.",
-                "mapsTo": "input.metadata"
-            },
-            {
-                "name": "--input",
-                "value": "<path>",
-                "description": "Read the full JSON request body from a file, or - for stdin."
-            }
+    "runtimes.create": {
+        "kind": "topic",
+        "topic": "runtimes.create",
+        "aliases": [
+            "runtime.create",
+            "bctrl runtime create"
         ],
+        "title": "Create a runtime",
+        "summary": "Create a browser runtime definition. This does not start the browser.",
         "input": {
             "fields": [
                 {
                     "name": "spaceId",
-                    "type": "uuid",
-                    "required": true
+                    "type": "uuid | \"default\"",
+                    "required": false
                 },
                 {
                     "name": "type",
@@ -49,7 +22,7 @@ export const CLI_HELP_COMMANDS = {
                     "values": [
                         "\"browser\""
                     ],
-                    "required": true
+                    "required": false
                 },
                 {
                     "name": "name",
@@ -75,6 +48,11 @@ export const CLI_HELP_COMMANDS = {
                     "type": "uuid",
                     "required": true
                 },
+                {
+                    "name": "spaceId",
+                    "type": "uuid",
+                    "required": true
+                },
                 {
                     "name": "name",
                     "type": "string",
@@ -82,11 +60,9 @@ export const CLI_HELP_COMMANDS = {
                 },
                 {
                     "name": "type",
-                    "type": "\"browser\" | \"desktop\" | \"spreadsheet\"",
+                    "type": "\"browser\"",
                     "values": [
-                        "\"browser\"",
-                        "\"desktop\"",
-                        "\"spreadsheet\""
+                        "\"browser\""
                     ],
                     "required": true
                 },
@@ -105,14 +81,19 @@ export const CLI_HELP_COMMANDS = {
                     "type": "uuid | null",
                     "required": true
                 },
+                {
+                    "name": "lastActivityAt",
+                    "type": "datetime",
+                    "required": false
+                },
                 {
                     "name": "createdAt",
-                    "type": "string",
+                    "type": "datetime",
                     "required": true
                 },
                 {
                     "name": "updatedAt",
-                    "type": "string",
+                    "type": "datetime",
                     "required": true
                 },
                 {
@@ -127,51 +108,208 @@ export const CLI_HELP_COMMANDS = {
                 }
             ]
         },
+        "api": {
+            "method": "POST",
+            "path": "/v1/runtimes",
+            "operationId": "runtimes.create",
+            "requestFields": [
+                "spaceId",
+                "type",
+                "name",
+                "config",
+                "metadata"
+            ],
+            "responseFields": [
+                "id",
+                "spaceId",
+                "name",
+                "type",
+                "status",
+                "activeRunId",
+                "lastActivityAt",
+                "createdAt",
+                "updatedAt",
+                "config",
+                "metadata"
+            ]
+        },
+        "sdk": [
+            {
+                "language": "typescript",
+                "package": "@bctrl/sdk",
+                "method": "client.runtimes.create"
+            }
+        ],
+        "cli": {
+            "command": "bctrl runtime create",
+            "usage": "bctrl runtime create [flags]",
+            "flags": [
+                {
+                    "name": "--space",
+                    "value": "<id>",
+                    "description": "Owning space id."
+                },
+                {
+                    "name": "--name",
+                    "value": "<name>",
+                    "description": "Runtime name."
+                },
+                {
+                    "name": "--profile",
+                    "description": "Persist browser state across runtime starts."
+                },
+                {
+                    "name": "--proxy",
+                    "value": "<id-or-url>",
+                    "description": "Saved proxy id or inline custom proxy URL."
+                },
+                {
+                    "name": "--device",
+                    "value": "<desktop|mobile>",
+                    "description": "Fingerprint device filter."
+                },
+                {
+                    "name": "--os",
+                    "value": "<windows|macos|android|ios>",
+                    "description": "Fingerprint OS filter."
+                },
+                {
+                    "name": "--browser",
+                    "value": "<chrome|edge|safari>",
+                    "description": "Fingerprint browser filter."
+                },
+                {
+                    "name": "--browser-version",
+                    "value": "<version>",
+                    "description": "Fingerprint browser version filter."
+                },
+                {
+                    "name": "--locale",
+                    "value": "<locale>",
+                    "description": "Fingerprint locale/language filter; repeat to set an ordered language stack."
+                },
+                {
+                    "name": "--config-file",
+                    "value": "<path>",
+                    "description": "Read runtime config JSON from a file."
+                },
+                {
+                    "name": "--metadata-file",
+                    "value": "<path>",
+                    "description": "Read runtime metadata JSON from a file."
+                },
+                {
+                    "name": "--input",
+                    "value": "<path>",
+                    "description": "Read the full JSON request body from a file, or - for stdin."
+                }
+            ]
+        },
         "examples": [
             {
+                "audience": "cli",
                 "command": "bctrl runtime create --space sp_123 --name checkout-test"
             },
             {
+                "audience": "cli",
+                "command": "bctrl runtime create --name mobile-de --proxy pxy_123 --device mobile --os ios --browser safari --locale de-DE --locale de"
+            },
+            {
+                "audience": "cli",
                 "command": "bctrl runtime create --input runtime.json"
             }
         ],
         "next": [
             {
+                "topic": "runtimes.start",
                 "command": "bctrl runtime start <runtimeId>"
             }
         ]
     },
-    "runtime.start": {
-        "kind": "command",
-        "command": "runtime.start",
+    "runtimes.start": {
+        "kind": "topic",
+        "topic": "runtimes.start",
+        "aliases": [
+            "runtime.start",
+            "bctrl runtime start"
+        ],
+        "title": "Start a runtime",
         "summary": "Start a runtime and open its active run.",
-        "usage": "bctrl runtime start <runtimeId>",
         "output": {
             "fields": [
                 {
-                    "name": "runtime",
-                    "type": "object",
+                    "name": "runtimeId",
+                    "type": "uuid",
                     "required": true
                 },
                 {
-                    "name": "run",
-                    "type": "object",
+                    "name": "runId",
+                    "type": "uuid",
                     "required": true
                 },
                 {
-                    "name": "browser",
-                    "type": "object",
+                    "name": "status",
+                    "type": "\"active\" | \"stopped\" | \"failed\"",
+                    "values": [
+                        "\"active\"",
+                        "\"stopped\"",
+                        "\"failed\""
+                    ],
+                    "required": true
+                },
+                {
+                    "name": "connectUrl",
+                    "type": "string",
+                    "required": true
+                },
+                {
+                    "name": "protocol",
+                    "type": "\"cdp\"",
+                    "values": [
+                        "\"cdp\""
+                    ],
+                    "required": true
+                },
+                {
+                    "name": "started",
+                    "type": "boolean",
                     "required": true
                 }
             ]
         },
+        "api": {
+            "method": "POST",
+            "path": "/v1/runtimes/{runtimeId}/start",
+            "operationId": "runtimes.start",
+            "responseFields": [
+                "runtimeId",
+                "runId",
+                "status",
+                "connectUrl",
+                "protocol",
+                "started"
+            ]
+        },
+        "sdk": [
+            {
+                "language": "typescript",
+                "package": "@bctrl/sdk",
+                "method": "client.runtimes.start"
+            }
+        ],
+        "cli": {
+            "command": "bctrl runtime start",
+            "usage": "bctrl runtime start <runtimeId>"
+        },
         "examples": [
             {
+                "audience": "cli",
                 "command": "bctrl runtime start rt_123"
             }
         ],
         "next": [
             {
+                "topic": "runs.activity.list",
                 "command": "bctrl run events <runId>"
             }
         ]

package/dist/root.js

@@ -1,9 +1,11 @@
 import { Command } from 'commander';
 import { createAiCommand } from './commands/ai/index.js';
+import { createApiKeyCommand } from './commands/api-key/index.js';
 import { createAuthCommand } from './commands/auth/index.js';
-import { createBrowserCommand } from './commands/browser/index.js';
+import { createBrowserExtensionCommand } from './commands/browser-extension/index.js';
 import { createFileCommand } from './commands/file/index.js';
-import { createInvocationCommand } from './commands/invocation/index.js';
+import { createHelpCommand } from './commands/help/index.js';
+import { createProxyCommand } from './commands/proxy/index.js';
 import { createRunCommand } from './commands/run/index.js';
 import { createRuntimeCommand } from './commands/runtime/index.js';
 import { createSpaceCommand } from './commands/space/index.js';
@@ -11,6 +13,7 @@ import { createSubaccountCommand } from './commands/subaccount/index.js';
 import { createToolCommand } from './commands/tool/index.js';
 import { createToolCallCommand } from './commands/tool-call/index.js';
 import { createToolsetCommand } from './commands/toolset/index.js';
+import { createUsageCommand } from './commands/usage/index.js';
 import { createVaultCommand } from './commands/vault/index.js';
 import { createVersionCommand } from './commands/version/version.js';
 export function createRootCommand(factory) {
@@ -25,16 +28,19 @@ export function createRootCommand(factory) {
     command.addCommand(createVersionCommand(factory));
     command.addCommand(createAuthCommand(factory));
     command.addCommand(createAiCommand(factory));
-    command.addCommand(createBrowserCommand(factory));
+    command.addCommand(createApiKeyCommand(factory));
+    command.addCommand(createBrowserExtensionCommand(factory));
     command.addCommand(createFileCommand(factory));
-    command.addCommand(createInvocationCommand(factory));
+    command.addCommand(createHelpCommand(factory));
     command.addCommand(createRunCommand(factory));
     command.addCommand(createRuntimeCommand(factory));
+    command.addCommand(createProxyCommand(factory));
     command.addCommand(createSpaceCommand(factory));
     command.addCommand(createSubaccountCommand(factory));
     command.addCommand(createToolCommand(factory));
     command.addCommand(createToolsetCommand(factory));
     command.addCommand(createToolCallCommand(factory));
+    command.addCommand(createUsageCommand(factory));
     command.addCommand(createVaultCommand(factory));
     return command;
 }