UNPKG

browse

Version:

Unified Browserbase CLI for browser automation and cloud APIs.

1,625 lines 156 kB
{ "commands": { "back": { "aliases": [], "args": {}, "description": "Navigate the active browser page backward.", "examples": [ "browse back", "browse back --session research", "browse back --wait domcontentloaded" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" }, "timeout": { "description": "Timeout in milliseconds.", "name": "timeout", "default": 30000, "hasDynamicHelp": false, "helpValue": "<ms>", "multiple": false, "type": "option" }, "wait": { "description": "Load state to wait for before returning.", "name": "wait", "default": "load", "hasDynamicHelp": false, "helpValue": "<state>", "multiple": false, "options": [ "load", "domcontentloaded", "networkidle" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "back", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "back.js" ] }, "cdp": { "aliases": [], "args": { "target": { "description": "CDP WebSocket URL, http(s) DevTools URL, or local port.", "name": "target", "required": true } }, "description": "Attach to a CDP endpoint and stream DevTools protocol events.", "examples": [ "browse cdp 9222", "browse cdp http://127.0.0.1:9222", "browse cdp ws://127.0.0.1:9222/devtools/browser/<id> --domain Network --domain Page", "browse cdp 9222 --pretty" ], "flags": { "domain": { "description": "CDP domain to enable. Repeat for multiple domains. Defaults to Network, Console, Runtime, Log, Page.", "name": "domain", "hasDynamicHelp": false, "helpValue": "<domain>", "multiple": true, "type": "option" }, "pretty": { "description": "Print compact human-readable event lines instead of NDJSON.", "name": "pretty", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cdp", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "cdp.js" ] }, "click": { "aliases": [], "args": { "selector": { "description": "Snapshot ref such as @0-12, XPath, or selector.", "name": "selector", "required": true } }, "description": "Click an element by snapshot ref, XPath, or selector. Use `browse mouse click` for raw coordinates.", "examples": [ "browse snapshot --compact", "browse click @0-12", "browse click 'button[type=submit]'", "browse click @0-12 --session research" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "click", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "click.js" ] }, "cursor": { "aliases": [], "args": {}, "description": "Enable a visible cursor overlay in the active browser page.", "examples": [ "browse cursor", "browse cursor --session research" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "cursor", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "cursor.js" ] }, "daemon": { "aliases": [], "args": {}, "description": "Run the private browse driver daemon.", "flags": { "session": { "description": "Named browser session.", "name": "session", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target": { "description": "Serialized driver connection target.", "name": "target", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "daemon", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "daemon.js" ] }, "doctor": { "aliases": [], "args": {}, "description": "Diagnose browse driver session and browser connection prerequisites.", "examples": [ "browse doctor", "browse doctor --remote", "browse doctor --auto-connect", "browse doctor --cdp 9222", "browse doctor --session research --json" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" }, "json": { "description": "Emit structured JSON for agents and CI. Always exits 0.", "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "doctor", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "doctor.js" ] }, "eval": { "aliases": [], "args": { "expression": { "description": "JavaScript expression to evaluate.", "name": "expression", "required": true } }, "description": "Evaluate JavaScript in the active browser page.", "examples": [ "browse eval 'document.title'", "browse eval 'document.querySelector(\"h1\")?.textContent'", "browse eval 'window.location.href' --session research" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "eval", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "eval.js" ] }, "fill": { "aliases": [], "args": { "selector": { "description": "Snapshot ref such as @0-8, XPath, or selector.", "name": "selector", "required": true }, "value": { "description": "Text value to fill.", "name": "value", "required": true } }, "description": "Fill an input-like element by snapshot ref, XPath, or selector.", "examples": [ "browse fill @0-8 'shrey@example.com'", "browse fill 'input[name=q]' 'browser automation' --press-enter", "browse fill @0-8 'draft text' --session research" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" }, "press-enter": { "description": "Press Enter after filling.", "name": "press-enter", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "fill", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "fill.js" ] }, "forward": { "aliases": [], "args": {}, "description": "Navigate the active browser page forward.", "examples": [ "browse forward", "browse forward --session research", "browse forward --wait domcontentloaded" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" }, "timeout": { "description": "Timeout in milliseconds.", "name": "timeout", "default": 30000, "hasDynamicHelp": false, "helpValue": "<ms>", "multiple": false, "type": "option" }, "wait": { "description": "Load state to wait for before returning.", "name": "wait", "default": "load", "hasDynamicHelp": false, "helpValue": "<state>", "multiple": false, "options": [ "load", "domcontentloaded", "networkidle" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "forward", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "forward.js" ] }, "get": { "aliases": [], "args": { "what": { "description": "Value to read. One of: url, title, text, html, value, box, visible, checked, markdown.", "name": "what", "options": [ "url", "title", "text", "html", "value", "box", "visible", "checked", "markdown" ], "required": true }, "selector": { "description": "Snapshot ref, XPath, or selector. Required for element reads; markdown defaults to body.", "name": "selector", "required": false } }, "description": "Read page data or element state from the active browser page.", "examples": [ "browse get url", "browse get title", "browse get text @0-12", "browse get markdown body", "browse get box 'button[type=submit]'" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "get", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "get.js" ] }, "highlight": { "aliases": [], "args": { "selector": { "description": "Snapshot ref such as @0-12, XPath, or selector.", "name": "selector", "required": true } }, "description": "Highlight an element by snapshot ref, XPath, or selector.", "examples": [ "browse highlight @0-12", "browse highlight 'button[type=submit]' --duration 1000", "browse highlight @0-12 --session research" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" }, "duration": { "description": "Highlight duration in milliseconds.", "name": "duration", "default": 2000, "hasDynamicHelp": false, "helpValue": "<ms>", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "highlight", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "highlight.js" ] }, "is": { "aliases": [], "args": { "check": { "description": "State to check.", "name": "check", "options": [ "visible", "checked" ], "required": true }, "selector": { "description": "Snapshot ref, XPath, or selector.", "name": "selector", "required": true } }, "description": "Check element state by snapshot ref, XPath, or selector.", "examples": [ "browse is visible @0-12", "browse is checked 'input[type=checkbox]'", "browse is visible @0-12 --session research" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "is", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "is.js" ] }, "open": { "aliases": [], "args": { "url": { "description": "URL to open.", "name": "url", "required": true } }, "description": "Open a URL in a browse driver session.", "examples": [ "browse open https://example.com", "browse open https://example.com --local --headed", "browse open https://example.com --remote", "browse open https://example.com --auto-connect", "browse open https://example.com --cdp 9222", "browse open https://example.com --cdp ws://127.0.0.1:9222/devtools/browser/<id> --target-id <target-id>", "browse open https://example.com --session research", "browse open https://example.com --wait networkidle --timeout 45000" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" }, "timeout": { "description": "Timeout in milliseconds.", "name": "timeout", "default": 30000, "hasDynamicHelp": false, "helpValue": "<ms>", "multiple": false, "type": "option" }, "wait": { "description": "Load state to wait for before returning.", "name": "wait", "default": "load", "hasDynamicHelp": false, "helpValue": "<state>", "multiple": false, "options": [ "load", "domcontentloaded", "networkidle" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "open", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "open.js" ] }, "press": { "aliases": [ "key" ], "args": { "key": { "description": "Key name or key chord, for example Enter, Escape, Meta+K.", "name": "key", "required": true } }, "description": "Press a keyboard key in the active page.", "examples": [ "browse press Enter", "browse press Escape", "browse key Meta+K" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "press", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "press.js" ] }, "refs": { "aliases": [], "args": {}, "description": "Show refs cached from the last browse snapshot in this session.", "examples": [ "browse refs", "browse refs --session research" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "refs", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "refs.js" ] }, "reload": { "aliases": [], "args": {}, "description": "Reload the active browser page.", "examples": [ "browse reload", "browse reload --session research", "browse reload --wait networkidle --timeout 45000" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" }, "timeout": { "description": "Timeout in milliseconds.", "name": "timeout", "default": 30000, "hasDynamicHelp": false, "helpValue": "<ms>", "multiple": false, "type": "option" }, "wait": { "description": "Load state to wait for before returning.", "name": "wait", "default": "load", "hasDynamicHelp": false, "helpValue": "<state>", "multiple": false, "options": [ "load", "domcontentloaded", "networkidle" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "reload", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "reload.js" ] }, "screenshot": { "aliases": [], "args": {}, "description": "Capture a screenshot of the active browser page.", "examples": [ "browse screenshot --path page.png", "browse screenshot --full-page --path page.png", "browse screenshot --type jpeg --quality 80", "browse screenshot --clip 0,0,800,600 --path clipped.png" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false, "type": "option" }, "animations": { "description": "Whether CSS animations run during capture.", "name": "animations", "hasDynamicHelp": false, "multiple": false, "options": [ "allow", "disabled" ], "type": "option" }, "caret": { "description": "Whether text caret is hidden during capture.", "name": "caret", "hasDynamicHelp": false, "multiple": false, "options": [ "hide", "initial" ], "type": "option" }, "clip": { "description": "Clip rectangle as x,y,width,height.", "name": "clip", "hasDynamicHelp": false, "helpValue": "<x,y,width,height>", "multiple": false, "type": "option" }, "full-page": { "description": "Capture the full scrollable page.", "name": "full-page", "allowNo": false, "type": "boolean" }, "path": { "char": "p", "description": "Write the screenshot to a file. Without this flag, base64 is printed.", "name": "path", "hasDynamicHelp": false, "helpValue": "<path>", "multiple": false, "type": "option" }, "quality": { "description": "JPEG quality from 0 to 100.", "name": "quality", "hasDynamicHelp": false, "helpValue": "<quality>", "multiple": false, "type": "option" }, "type": { "description": "Screenshot image type.", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "png", "jpeg" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "screenshot", "pluginAlias": "browse", "pluginName": "browse", "pluginType": "core", "strict": true, "isESM": true, "relativePath": [ "dist", "commands", "screenshot.js" ] }, "select": { "aliases": [], "args": { "selector": { "description": "Snapshot ref such as @0-9, XPath, or selector.", "name": "selector", "required": true }, "value": { "description": "Option value or label to select.", "name": "value", "required": true } }, "description": "Select an option on a select-like element by snapshot ref, XPath, or selector.", "examples": [ "browse select @0-9 'CA'", "browse select 'select[name=state]' 'CA'", "browse select @0-9 'CA' --value 'NV'" ], "flags": { "auto-connect": { "description": "Auto-discover and attach to a local browser with remote debugging enabled.", "name": "auto-connect", "allowNo": false, "type": "boolean" }, "cdp": { "description": "Attach directly to a CDP endpoint. Accepts a port, http(s) URL, or ws(s) URL.", "name": "cdp", "hasDynamicHelp": false, "helpValue": "<url|port>", "multiple": false, "type": "option" }, "headed": { "description": "Show a visible browser window for managed local sessions.", "name": "headed", "allowNo": false, "type": "boolean" }, "headless": { "description": "Run managed local sessions in headless mode.", "name": "headless", "allowNo": false, "type": "boolean" }, "local": { "description": "Use a managed local browser session.", "name": "local", "allowNo": false, "type": "boolean" }, "remote": { "description": "Use a remote Browserbase browser session.", "name": "remote", "allowNo": false, "type": "boolean" }, "session": { "char": "s", "description": "Named browser session to use. Defaults to BROWSE_SESSION or default.", "name": "session", "hasDynamicHelp": false, "helpValue": "<name>", "multiple": false, "type": "option" }, "target-id": { "description": "Select a specific CDP target when attaching to an existing browser.", "name": "target-id", "hasDynamicHelp": false, "helpValue": "<target-id>", "multiple": false,