@bctrl/cli 0.1.2 → 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,110 +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 required: true;
-            }, {
-                readonly name: "run";
-                readonly type: "object";
-                readonly required: true;
-            }];
-        };
-        readonly examples: readonly [{
-            readonly command: "bctrl runtime start rt_123";
-        }];
-        readonly next: readonly [{
-            readonly command: "bctrl runtime connection create <runtimeId>";
-        }];
-    };
-    readonly "runtime.connection.create": {
-        readonly kind: "command";
-        readonly command: "runtime.connection.create";
-        readonly summary: "Create a short-lived CDP connection lease for a started runtime.";
-        readonly usage: "bctrl runtime connection create <runtimeId> [flags]";
-        readonly flags: readonly [{
-            readonly name: "--protocol";
-            readonly value: "<protocol>";
-            readonly description: "Connection protocol. Defaults to cdp.";
-            readonly mapsTo: "input.protocol";
-        }, {
-            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: "protocol";
-                readonly type: "\"cdp\"";
-                readonly values: readonly ["\"cdp\""];
-                readonly required: true;
-            }, {
-                readonly name: "options";
-                readonly type: "object";
-                readonly required: false;
-            }];
-        };
-        readonly output: {
-            readonly fields: readonly [{
-                readonly name: "id";
+                readonly name: "runtimeId";
                 readonly type: "uuid";
                 readonly required: true;
-            }, {
-                readonly name: "protocol";
-                readonly type: "\"cdp\" | \"cua\" | \"rdp\" | \"vnc\" | \"mcp\" | \"http\"";
-                readonly values: readonly ["\"cdp\"", "\"cua\"", "\"rdp\"", "\"vnc\"", "\"mcp\"", "\"http\""];
-                readonly required: true;
-            }, {
-                readonly name: "status";
-                readonly type: "\"active\" | \"expired\" | \"revoked\" | \"closed\"";
-                readonly values: readonly ["\"active\"", "\"expired\"", "\"revoked\"", "\"closed\""];
-                readonly required: true;
             }, {
                 readonly name: "runId";
                 readonly type: "uuid";
                 readonly required: true;
             }, {
-                readonly name: "createdAt";
-                readonly type: "datetime";
+                readonly name: "status";
+                readonly type: "\"active\" | \"stopped\" | \"failed\"";
+                readonly values: readonly ["\"active\"", "\"stopped\"", "\"failed\""];
                 readonly required: true;
             }, {
-                readonly name: "expiresAt";
-                readonly type: "datetime | null";
+                readonly name: "connectUrl";
+                readonly type: "string";
                 readonly required: true;
             }, {
-                readonly name: "closedAt";
-                readonly type: "datetime | null";
-                readonly required: false;
-            }, {
-                readonly name: "revokedAt";
-                readonly type: "datetime | null";
-                readonly required: false;
+                readonly name: "protocol";
+                readonly type: "\"cdp\"";
+                readonly values: readonly ["\"cdp\""];
+                readonly required: true;
             }, {
-                readonly name: "endpoint";
-                readonly type: "object";
+                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 command: "bctrl runtime connection create rt_123";
+            readonly audience: "cli";
+            readonly command: "bctrl runtime start rt_123";
         }];
         readonly next: readonly [{
+            readonly topic: "runs.activity.list";
             readonly command: "bctrl run events <runId>";
         }];
     };