browse
Version:
Unified Browserbase CLI for browser automation and cloud APIs.
6,907 lines • 216 kB
JSON
{
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"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 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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"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 --remote --verified --proxies",
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "press",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"press.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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"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",
"browse screenshot --path page.png",
"browse screenshot --full-page",
"browse screenshot --type jpeg --quality 80",
"browse screenshot --clip 0,0,800,600 --path clipped.png",
"browse screenshot --base64"
],
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"animations": {
"description": "Whether CSS animations run during capture.",
"name": "animations",
"hasDynamicHelp": false,
"multiple": false,
"options": [
"allow",
"disabled"
],
"type": "option"
},
"base64": {
"description": "Print base64 to stdout instead of writing a file (legacy default).",
"exclusive": [
"path"
],
"name": "base64",
"allowNo": false,
"type": "boolean"
},
"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 this file. Defaults to screenshot-<timestamp>.png (or .jpeg with --type jpeg) in the current directory.",
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"value": {
"description": "Additional option value for multi-select controls. Repeat for multiple values.",
"name": "value",
"hasDynamicHelp": false,
"helpValue": "<value>",
"multiple": true,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "select",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"select.js"
]
},
"snapshot": {
"aliases": [],
"args": {},
"description": "Print the active page accessibility snapshot and cache refs for element commands. Pass --full to also include the ref maps (xpathMap, urlMap).",
"examples": [
"browse snapshot",
"browse snapshot --full",
"browse snapshot --filter submit",
"browse snapshot --max-depth 4"
],
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"full": {
"description": "Also include the ref maps (xpathMap, urlMap).",
"name": "full",
"allowNo": false,
"type": "boolean"
},
"compact": {
"description": "Deprecated and has no effect; use --full to include the ref maps.",
"name": "compact",
"allowNo": false,
"type": "boolean"
},
"filter": {
"description": "Filter output lines by text or /regex/ while preserving matching ancestors.",
"name": "filter",
"hasDynamicHelp": false,
"helpValue": "<text|/regex/>",
"multiple": false,
"type": "option"
},
"max-depth": {
"description": "Trim snapshot output deeper than this tree depth.",
"name": "max-depth",
"hasDynamicHelp": false,
"helpValue": "<depth>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "snapshot",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"snapshot.js"
]
},
"status": {
"aliases": [],
"args": {},
"description": "Show the browse driver daemon status for a named session.",
"examples": [
"browse status",
"browse status --session research"
],
"flags": {
"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"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "status",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"status.js"
]
},
"stop": {
"aliases": [],
"args": {},
"description": "Stop the browse driver daemon for a named session.",
"examples": [
"browse stop",
"browse stop --session research",
"browse stop --force"
],
"flags": {
"force": {
"description": "Clean up daemon state files if the daemon is unresponsive.",
"name": "force",
"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"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "stop",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"stop.js"
]
},
"type": {
"aliases": [],
"args": {
"text": {
"description": "Text to type.",
"name": "text",
"required": true
}
},
"description": "Type text into the active page at the current focus.",
"examples": [
"browse type 'hello world'",
"browse type 'hello world' --delay 25",
"browse type 'hello world' --mistakes"
],
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"delay": {
"description": "Delay between keystrokes in milliseconds.",
"name": "delay",
"hasDynamicHelp": false,
"helpValue": "<ms>",
"multiple": false,
"type": "option"
},
"mistakes": {
"description": "Allow human-like typing mistakes when supported by the browser driver.",
"name": "mistakes",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "type",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"type.js"
]
},
"upload": {
"aliases": [],
"args": {
"selector": {
"description": "Snapshot ref such as @0-4, XPath, or selector.",
"name": "selector",
"required": true
},
"file": {
"description": "File path to upload.",
"name": "file",
"required": true
}
},
"description": "Upload one or more files into a file input by snapshot ref, XPath, or selector.",
"examples": [
"browse upload @0-4 ./resume.pdf",
"browse upload 'input[type=file]' ./one.png --file ./two.png",
"browse upload @0-4 ./resume.pdf --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"file": {
"description": "Additional file path. Repeat for multiple files.",
"name": "file",
"hasDynamicHelp": false,
"helpValue": "<path>",
"multiple": true,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "upload",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"upload.js"
]
},
"viewport": {
"aliases": [],
"args": {
"width": {
"description": "Viewport width in CSS pixels.",
"name": "width",
"required": true
},
"height": {
"description": "Viewport height in CSS pixels.",
"name": "height",
"required": true
}
},
"description": "Set the viewport size for the active browser page.",
"examples": [
"browse viewport 1280 720",
"browse viewport 390 844 --scale 2",
"browse viewport 1280 720 --scale 1.5",
"browse viewport 1440 900 --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"scale": {
"description": "Device scale factor.",
"name": "scale",
"default": "1",
"hasDynamicHelp": false,
"helpValue": "<scale>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "viewport",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"viewport.js"
]
},
"wait": {
"aliases": [],
"args": {
"type": {
"description": "Wait type.",
"name": "type",
"options": [
"load",
"selector",
"timeout"
],
"required": true
},
"arg": {
"description": "Load state, selector, or timeout milliseconds depending on wait type.",
"name": "arg",
"required": false
}
},
"description": "Wait for a load state, selector state, or timeout in the active page.",
"examples": [
"browse wait load",
"browse wait load networkidle --timeout 45000",
"browse wait selector @0-12 --state visible",
"browse wait timeout 1000"
],
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"state": {
"description": "Selector state to wait for.",
"name": "state",
"default": "visible",
"hasDynamicHelp": false,
"multiple": false,
"options": [
"attached",
"detached",
"hidden",
"visible"
],
"type": "option"
},
"timeout": {
"description": "Timeout in milliseconds.",
"name": "timeout",
"default": 30000,
"hasDynamicHelp": false,
"helpValue": "<ms>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "wait",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"wait.js"
]
},
"cloud:fetch": {
"aliases": [],
"args": {
"url": {
"description": "URL to fetch.",
"name": "url",
"required": true
}
},
"description": "Retrieve webpage content using the lightweight Browserbase Fetch API.",
"examples": [
"browse cloud fetch https://www.google.com",
"browse cloud fetch https://example.com --format raw",
"browse cloud fetch https://example.com --allow-insecure-ssl --output page.html",
"browse cloud fetch https://example.com --format json --schema '{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\"}},\"required\":[\"title\"]}'"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"allow-insecure-ssl": {
"description": "Bypass TLS certificate verification.",
"name": "allow-insecure-ssl",
"allowNo": false,
"type": "boolean"
},
"allow-redirects": {
"description": "Follow HTTP redirects.",
"name": "allow-redirects",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Enable Browserbase proxy support.",
"name": "proxies",
"allowNo": false,
"type": "boolean"
},
"format": {
"description": "Fetched content format. Defaults to markdown for token-efficient output.",
"name": "format",
"default": "markdown",
"hasDynamicHelp": false,
"helpValue": "<format>",
"multiple": false,
"options": [
"raw",
"markdown",
"json"
],
"type": "option"
},
"schema": {
"description": "JSON Schema for structured extraction. Required when --format json.",
"name": "schema",
"hasDynamicHelp": false,
"helpValue": "<schema>",
"multiple": false,
"type": "option"
},
"output": {
"description": "Write the fetched content to a file.",
"name": "output",
"hasDynamicHelp": false,
"helpValue": "<output>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:fetch",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"fetch.js"
]
},
"cloud:search": {
"aliases": [],
"args": {
"query": {
"description": "Search query.",
"name": "query",
"required": true
}
},
"description": "Search the web using the Browserbase Search API.",
"examples": [
"browse cloud search \"best restaurants in SF\"",
"browse cloud search \"web scraping tools\" --num-results 5",
"browse cloud search \"browserbase docs\" --json",
"browse cloud search \"browserbase docs\" --output results.json"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"format": {
"description": "Output format. Defaults to table in a terminal and JSON when piped.",
"name": "format",
"hasDynamicHelp": false,
"helpValue": "<format>",
"multiple": false,
"options": [
"table",
"json"
],
"type": "option"
},
"json": {
"description": "Print raw JSON output.",
"name": "json",
"allowNo": false,
"type": "boolean"
},
"wide": {
"description": "Show full table values without truncation.",
"name": "wide",
"allowNo": false,
"type": "boolean"
},
"num-results": {
"description": "Number of results to return (1-25, default 10).",
"name": "num-results",
"hasDynamicHelp": false,
"helpValue": "<count>",
"multiple": false,
"type": "option"
},
"output": {
"description": "Write the search results as JSON to a file.",
"name": "output",
"hasDynamicHelp": false,
"helpValue": "<output>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:search",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"search.js"
]
},
"functions:dev": {
"aliases": [],
"args": {
"entrypoint": {
"description": "Function entrypoint file.",
"name": "entrypoint",
"required": true
}
},
"description": "Run the local Browserbase Functions development server.",
"examples": [
"browse functions dev index.ts",
"browse functions dev index.ts --port 3000 --verbose"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"host": {
"description": "Host to bind to.",
"name": "host",
"default": "127.0.0.1",
"hasDynamicHelp": false,
"helpValue": "<host>",
"multiple": false,
"type": "option"
},
"port": {
"description": "Port to listen on.",
"name": "port",
"default": 14113,
"hasDynamicHelp": false,
"helpValue": "<port>",
"multiple": false,
"type": "option"
},
"verbose": {
"description": "Print verbose runtime logs.",
"name": "verbose",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "functions:dev",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"functions",
"dev.js"
]
},
"functions:init": {
"aliases": [],
"args": {
"projectName": {
"description": "Directory name for the new Functions project.",
"name": "projectName",
"required": false
}
},
"description": "Initialize a new Browserbase Functions project.",
"examples": [
"browse functions init my-function",
"browse functions init my-function --package-manager npm"
],
"flags": {
"package-manager": {
"description": "Package manager to use.",
"name": "package-manager",
"default": "pnpm",
"hasDynamicHelp": false,
"multiple": false,
"options": [
"npm",
"pnpm"
],
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "functions:init",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"functions",
"init.js"
]
},
"functions:invoke": {
"aliases": [],
"args": {
"functionId": {
"description": "Function ID to invoke.",
"name": "functionId",
"required": false
}
},
"description": "Invoke a deployed Browserbase Function or check invocation status.",
"examples": [
"browse functions invoke <function-id> --params '{\"url\":\"https://example.com\"}'",
"browse functions invoke <function-id> --no-wait",
"browse functions invoke --check-status <invocation-id>"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"check-status": {
"description": "Invocation ID to inspect without creating a new invocation.",
"name": "check-status",
"hasDynamicHelp": false,
"helpValue": "<invocationId>",
"multiple": false,
"type": "option"
},
"no-wait": {
"description": "Return immediately after creating the invocation.",
"name": "no-wait",
"allowNo": false,
"type": "boolean"
},
"params": {
"description": "JSON params to pass to the function.",
"name": "params",
"hasDynamicHelp": false,
"helpValue": "<params>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "functions:invoke",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"functions",
"invoke.js"
]
},
"functions:publish": {
"aliases": [],
"args": {
"entrypoint": {
"description": "Function entrypoint file.",
"name": "entrypoint",
"required": true
}
},
"description": "Package and upload a Browserbase Function build.",
"examples": [
"browse functions publish index.ts --dry-run",
"browse functions publish index.ts"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"dry-run": {
"description": "Show what would be published without uploading.",
"name": "dry-run",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "functions:publish",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"functions",
"publish.js"
]
},
"network:clear": {
"aliases": [],
"args": {},
"description": "Clear captured network request directories for the active browser session.",
"examples": [
"browse network clear",
"browse network clear --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "network:clear",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"network",
"clear.js"
]
},
"network:off": {
"aliases": [],
"args": {},
"description": "Disable network capture for the active browser session.",
"examples": [
"browse network off",
"browse network off --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "network:off",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"network",
"off.js"
]
},
"network:on": {
"aliases": [],
"args": {},
"description": "Enable network capture for the active browser session.",
"examples": [
"browse network on",
"browse network on --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "network:on",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"network",
"on.js"
]
},
"network:path": {
"aliases": [],
"args": {},
"description": "Print the network capture directory for the active browser session.",
"examples": [
"browse network path",
"browse network path --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "network:path",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"network",
"path.js"
]
},
"mouse:click": {
"aliases": [],
"args": {
"x": {
"description": "Viewport x coordinate.",
"name": "x",
"required": true
},
"y": {
"description": "Viewport y coordinate.",
"name": "y",
"required": true
}
},
"description": "Click raw viewport coordinates in the active page.",
"examples": [
"browse mouse click 240 320",
"browse mouse click 240 320 --button right",
"browse mouse click 240 320 --click-count 2"
],
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"button": {
"description": "Mouse button to use.",
"name": "button",
"default": "left",
"hasDynamicHelp": false,
"helpValue": "<button>",
"multiple": false,
"options": [
"left",
"middle",
"right"
],
"type": "option"
},
"click-count": {
"description": "Number of clicks to send.",
"name": "click-count",
"default": 1,
"hasDynamicHelp": false,
"helpValue": "<count>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "mouse:click",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"mouse",
"click.js"
]
},
"mouse:drag": {
"aliases": [],
"args": {
"fromX": {
"description": "Starting viewport x coordinate.",
"name": "fromX",
"required": true
},
"fromY": {
"description": "Starting viewport y coordinate.",
"name": "fromY",
"required": true
},
"toX": {
"description": "Ending viewport x coordinate.",
"name": "toX",
"required": true
},
"toY": {
"description": "Ending viewport y coordinate.",
"name": "toY",
"required": true
}
},
"description": "Drag from one raw viewport coordinate to another.",
"examples": [
"browse mouse drag 100 100 400 400",
"browse mouse drag 100 100 400 400 --steps 20 --delay 10"
],
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"button": {
"description": "Mouse button to use.",
"name": "button",
"default": "left",
"hasDynamicHelp": false,
"helpValue": "<button>",
"multiple": false,
"options": [
"left",
"middle",
"right"
],
"type": "option"
},
"delay": {
"description": "Delay between drag steps in milliseconds.",
"name": "delay",
"default": 0,
"hasDynamicHelp": false,
"helpValue": "<ms>",
"multiple": false,
"type": "option"
},
"steps": {
"description": "Number of intermediate drag steps.",
"name": "steps",
"default": 10,
"hasDynamicHelp": false,
"helpValue": "<steps>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "mouse:drag",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"mouse",
"drag.js"
]
},
"mouse:hover": {
"aliases": [],
"args": {
"x": {
"description": "Viewport x coordinate.",
"name": "x",
"required": true
},
"y": {
"description": "Viewport y coordinate.",
"name": "y",
"required": true
}
},
"description": "Move the mouse to raw viewport coordinates in the active page.",
"examples": [
"browse mouse hover 240 320",
"browse mouse hover 240 320 --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "mouse:hover",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"mouse",
"hover.js"
]
},
"mouse:scroll": {
"aliases": [],
"args": {
"x": {
"description": "Viewport x coordinate.",
"name": "x",
"required": true
},
"y": {
"description": "Viewport y coordinate.",
"name": "y",
"required": true
},
"deltaX": {
"description": "Horizontal scroll delta.",
"name": "deltaX",
"required": true
},
"deltaY": {
"description": "Vertical scroll delta.",
"name": "deltaY",
"required": true
}
},
"description": "Scroll from raw viewport coordinates in the active page.",
"examples": [
"browse mouse scroll 400 500 0 600",
"browse mouse scroll 400 500 0 -600"
],
"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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "mouse:scroll",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"mouse",
"scroll.js"
]
},
"skills:add": {
"aliases": [],
"args": {
"skill": {
"description": "Skill id in the form <domain>/<task>.",
"name": "skill",
"required": false
}
},
"description": "Install a browser automation skill.",
"examples": [
"browse skills add yelp.com/extract-reviews",
"browse skills add mcdonalds.order.online/order-delivery-42q71n"
],
"flags": {},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "skills:add",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"skills",
"add.js"
]
},
"skills:find": {
"aliases": [],
"args": {
"query": {
"description": "Skill slug or search query.",
"name": "query",
"required": true
}
},
"description": "Find Browse.sh catalog skills by slug, domain, title, description, category, alias, or tag.",
"examples": [
"browse skills find yelp",
"browse skills find reviews",
"browse skills find yelp.com/extract-reviews",
"browse skills find travel --limit 5",
"browse skills find \"restaurant reviews\" --json"
],
"flags": {
"format": {
"description": "Output format. Defaults to table in a terminal and JSON when piped.",
"name": "format",
"hasDynamicHelp": false,
"helpValue": "<format>",
"multiple": false,
"options": [
"table",
"json"
],
"type": "option"
},
"json": {
"description": "Print raw JSON output.",
"name": "json",
"allowNo": false,
"type": "boolean"
},
"wide": {
"description": "Show full table values without truncation.",
"name": "wide",
"allowNo": false,
"type": "boolean"
},
"all": {
"description": "Show all matching skills in table output.",
"name": "all",
"allowNo": false,
"type": "boolean"
},
"limit": {
"description": "Maximum matching skills to show in table output.",
"name": "limit",
"default": 25,
"hasDynamicHelp": false,
"helpValue": "<count>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "skills:find",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"skills",
"find.js"
]
},
"skills:install": {
"aliases": [],
"args": {},
"description": "Install the bundled browse CLI skill.",
"examples": [
"browse skills install"
],
"flags": {},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "skills:install",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"skills",
"install.js"
]
},
"skills:list": {
"aliases": [],
"args": {},
"description": "List Browse.sh catalog skills.",
"examples": [
"browse skills list",
"browse skills list --limit 10",
"browse skills list --all",
"browse skills list --json"
],
"flags": {
"format": {
"description": "Output format. Defaults to table in a terminal and JSON when piped.",
"name": "format",
"hasDynamicHelp": false,
"helpValue": "<format>",
"multiple": false,
"options": [
"table",
"json"
],
"type": "option"
},
"json": {
"description": "Print raw JSON output.",
"name": "json",
"allowNo": false,
"type": "boolean"
},
"wide": {
"description": "Show full table values without truncation.",
"name": "wide",
"allowNo": false,
"type": "boolean"
},
"all": {
"description": "Show all returned skills in table output.",
"name": "all",
"allowNo": false,
"type": "boolean"
},
"limit": {
"description": "Maximum skills to show in table output.",
"name": "limit",
"default": 25,
"hasDynamicHelp": false,
"helpValue": "<count>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "skills:list",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"skills",
"list.js"
]
},
"skills:show": {
"aliases": [],
"args": {},
"description": "Print the bundled browse skill (usage patterns, workflows, gotchas) to stdout. Run before using browse in an agent.",
"examples": [
"browse skills show"
],
"flags": {},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "skills:show",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"skills",
"show.js"
]
},
"tab:close": {
"aliases": [],
"args": {
"tab": {
"description": "Optional tab index or targetId. Prefer targetId from `browse tab list` when indices may change.",
"name": "tab",
"required": false
}
},
"description": "Close a tab by index or targetId. Without an argument, closes the active tab. Prefer targetId for stability.",
"examples": [
"browse tab close",
"browse tab close 1",
"browse tab close <target-id>",
"browse tab close <target-id> --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "tab:close",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"tab",
"close.js"
]
},
"tab:list": {
"aliases": [],
"args": {},
"description": "List tabs in the active browser session, including stable targetIds.",
"examples": [
"browse tab list",
"browse tab list --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "tab:list",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"tab",
"list.js"
]
},
"tab:new": {
"aliases": [],
"args": {
"url": {
"description": "Optional URL to open in the new tab.",
"name": "url",
"required": false
}
},
"description": "Open a new tab and make it active.",
"examples": [
"browse tab new",
"browse tab new https://example.com",
"browse tab new https://example.com --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "tab:new",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"tab",
"new.js"
]
},
"tab:switch": {
"aliases": [],
"args": {
"tab": {
"description": "Tab index or targetId. Prefer targetId from `browse tab list` when indices may change.",
"name": "tab",
"required": true
}
},
"description": "Switch the active tab by index or targetId. Prefer targetId from `browse tab list` for stable agent workflows.",
"examples": [
"browse tab list",
"browse tab switch 1",
"browse tab switch <target-id>",
"browse tab switch <target-id> --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"
},
"chrome-arg": {
"description": "Add a Chrome launch arg for managed local sessions. Repeatable.",
"name": "chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"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"
},
"ignore-default-chrome-arg": {
"description": "Drop one of Chrome's default launch args for managed local sessions. Repeatable.",
"name": "ignore-default-chrome-arg",
"hasDynamicHelp": false,
"helpValue": "<flag>",
"multiple": true,
"type": "option"
},
"local": {
"description": "Use a managed local browser session.",
"name": "local",
"allowNo": false,
"type": "boolean"
},
"no-default-chrome-args": {
"description": "Launch managed local Chrome without any of its default launch args.",
"name": "no-default-chrome-args",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Route the remote session through Browserbase proxies. Requires --remote.",
"name": "proxies",
"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"
},
"verified": {
"description": "Open the remote session as a Verified (advanced-stealth) browser. Requires --remote and a Browserbase Scale plan.",
"name": "verified",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "tab:switch",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"tab",
"switch.js"
]
},
"templates:clone": {
"aliases": [],
"args": {
"slug": {
"description": "Template slug.",
"name": "slug",
"required": true
},
"path": {
"description": "Destination directory. Defaults to the template slug.",
"name": "path",
"required": false
}
},
"description": "Scaffold a ready-to-run project from a Browserbase template.",
"examples": [
"browse templates clone google-trends-keywords",
"browse templates clone amazon-product-scraping --language python ./my-scraper",
"browse templates clone dynamic-form-filling ./form-bot --language typescript"
],
"flags": {
"json": {
"description": "Print clone result as JSON.",
"name": "json",
"allowNo": false,
"type": "boolean"
},
"language": {
"description": "Template language. Defaults to TypeScript when available, then Python.",
"name": "language",
"hasDynamicHelp": false,
"helpValue": "<language>",
"multiple": false,
"options": [
"typescript",
"python"
],
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "templates:clone",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"templates",
"clone.js"
]
},
"templates:find": {
"aliases": [],
"args": {
"query": {
"description": "Template slug or search query.",
"name": "query",
"required": true
}
},
"description": "Find Browserbase templates by slug, title, category, or tag.",
"examples": [
"browse templates find google-trends-keywords",
"browse templates find amazon",
"browse templates find Python --wide",
"browse templates find Python --json"
],
"flags": {
"format": {
"description": "Output format. Defaults to table in a terminal and JSON when piped.",
"name": "format",
"hasDynamicHelp": false,
"helpValue": "<format>",
"multiple": false,
"options": [
"table",
"json"
],
"type": "option"
},
"json": {
"description": "Print raw JSON output.",
"name": "json",
"allowNo": false,
"type": "boolean"
},
"wide": {
"description": "Show full table values without truncation.",
"name": "wide",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "templates:find",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"templates",
"find.js"
]
},
"templates:list": {
"aliases": [],
"args": {},
"description": "List Browserbase templates.",
"examples": [
"browse templates list",
"browse templates list --category \"Web Automation\"",
"browse templates list --tag Python --source Browserbase",
"browse templates list --wide",
"browse templates list --json"
],
"flags": {
"format": {
"description": "Output format. Defaults to table in a terminal and JSON when piped.",
"name": "format",
"hasDynamicHelp": false,
"helpValue": "<format>",
"multiple": false,
"options": [
"table",
"json"
],
"type": "option"
},
"json": {
"description": "Print raw JSON output.",
"name": "json",
"allowNo": false,
"type": "boolean"
},
"wide": {
"description": "Show full table values without truncation.",
"name": "wide",
"allowNo": false,
"type": "boolean"
},
"category": {
"description": "Filter templates by category.",
"name": "category",
"hasDynamicHelp": false,
"helpValue": "<category>",
"multiple": false,
"type": "option"
},
"source": {
"description": "Filter templates by source.",
"name": "source",
"hasDynamicHelp": false,
"helpValue": "<source>",
"multiple": false,
"type": "option"
},
"tag": {
"description": "Filter templates by tag.",
"name": "tag",
"hasDynamicHelp": false,
"helpValue": "<tag>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "templates:list",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"templates",
"list.js"
]
},
"cloud:contexts:add": {
"aliases": [],
"args": {
"name": {
"description": "Local name to save.",
"name": "name",
"required": true
},
"id": {
"description": "Existing Browserbase context ID.",
"name": "id",
"required": true
}
},
"description": "Save a local name for an existing Browserbase context ID so you can reuse it by name (e.g. an ID a teammate shared or one created on another device).",
"examples": [
"browse cloud contexts add github 45ed525f-63a5-490d-b4c4-853f50643b90",
"browse cloud contexts add github <new-id> --force"
],
"flags": {
"force": {
"description": "Overwrite the name if it is already saved locally.",
"name": "force",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:contexts:add",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"contexts",
"add.js"
]
},
"cloud:contexts:create": {
"aliases": [],
"args": {},
"description": "Create a Browserbase context. Pass --name to save a local alias you can reuse instead of the context ID.",
"examples": [
"browse cloud contexts create",
"browse cloud contexts create --name github",
"browse cloud contexts create --body '{\"region\":\"us-west-2\"}'",
"echo '{\"region\":\"us-west-2\"}' | browse cloud contexts create --stdin"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"name": {
"description": "Save a local alias for the new context so you can reuse it by name.",
"name": "name",
"hasDynamicHelp": false,
"helpValue": "<name>",
"multiple": false,
"type": "option"
},
"body": {
"description": "Optional JSON request body.",
"name": "body",
"hasDynamicHelp": false,
"helpValue": "<body>",
"multiple": false,
"type": "option"
},
"stdin": {
"description": "Read JSON request body from stdin.",
"name": "stdin",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:contexts:create",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"contexts",
"create.js"
]
},
"cloud:contexts:delete": {
"aliases": [],
"args": {
"id": {
"description": "Context ID or saved name.",
"name": "id",
"required": true
}
},
"description": "Delete a Browserbase context by ID or saved name.",
"examples": [
"browse cloud contexts delete <context-id>",
"browse cloud contexts delete github"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:contexts:delete",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"contexts",
"delete.js"
]
},
"cloud:contexts:get": {
"aliases": [],
"args": {
"id": {
"description": "Context ID or saved name.",
"name": "id",
"required": true
}
},
"description": "Get a Browserbase context by ID or saved name.",
"examples": [
"browse cloud contexts get <context-id>",
"browse cloud contexts get github"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:contexts:get",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"contexts",
"get.js"
]
},
"cloud:contexts:list": {
"aliases": [],
"args": {},
"description": "List Browserbase contexts you have saved locally with a name.",
"examples": [
"browse cloud contexts list",
"browse cloud contexts list --json"
],
"flags": {
"format": {
"description": "Output format. Defaults to table in a terminal and JSON when piped.",
"name": "format",
"hasDynamicHelp": false,
"helpValue": "<format>",
"multiple": false,
"options": [
"table",
"json"
],
"type": "option"
},
"json": {
"description": "Print raw JSON output.",
"name": "json",
"allowNo": false,
"type": "boolean"
},
"wide": {
"description": "Show full table values without truncation.",
"name": "wide",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:contexts:list",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"contexts",
"list.js"
]
},
"cloud:contexts:update": {
"aliases": [],
"args": {
"id": {
"description": "Context ID or saved name.",
"name": "id",
"required": true
}
},
"description": "Refresh the upload URL for a Browserbase context.",
"examples": [
"browse cloud contexts update <context-id>",
"browse cloud contexts update github"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:contexts:update",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"contexts",
"update.js"
]
},
"cloud:projects:get": {
"aliases": [],
"args": {
"id": {
"description": "Project ID.",
"name": "id",
"required": true
}
},
"description": "Get a project by ID.",
"examples": [
"browse cloud projects get <project-id>"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:projects:get",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"projects",
"get.js"
]
},
"cloud:projects:list": {
"aliases": [],
"args": {},
"description": "List projects visible to the current API key.",
"examples": [
"browse cloud projects list",
"browse cloud projects list --json"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"format": {
"description": "Output format. Defaults to table in a terminal and JSON when piped.",
"name": "format",
"hasDynamicHelp": false,
"helpValue": "<format>",
"multiple": false,
"options": [
"table",
"json"
],
"type": "option"
},
"json": {
"description": "Print raw JSON output.",
"name": "json",
"allowNo": false,
"type": "boolean"
},
"wide": {
"description": "Show full table values without truncation.",
"name": "wide",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:projects:list",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"projects",
"list.js"
]
},
"cloud:projects:usage": {
"aliases": [],
"args": {
"id": {
"description": "Project ID.",
"name": "id",
"required": true
}
},
"description": "Get project usage.",
"examples": [
"browse cloud projects usage <project-id>"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:projects:usage",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"projects",
"usage.js"
]
},
"cloud:extensions:delete": {
"aliases": [],
"args": {
"id": {
"description": "Extension ID.",
"name": "id",
"required": true
}
},
"description": "Delete a Chrome extension.",
"examples": [
"browse cloud extensions delete <extension-id>"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:extensions:delete",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"extensions",
"delete.js"
]
},
"cloud:extensions:get": {
"aliases": [],
"args": {
"id": {
"description": "Extension ID.",
"name": "id",
"required": true
}
},
"description": "Get a Chrome extension by ID.",
"examples": [
"browse cloud extensions get <extension-id>"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:extensions:get",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"extensions",
"get.js"
]
},
"cloud:extensions:upload": {
"aliases": [],
"args": {
"file": {
"description": "Path to extension ZIP file.",
"name": "file",
"required": true
}
},
"description": "Upload a Chrome extension ZIP file.",
"examples": [
"browse cloud extensions upload ./extension.zip"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:extensions:upload",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"extensions",
"upload.js"
]
},
"cloud:secrets:create": {
"aliases": [],
"args": {
"key": {
"description": "Name exposed in the function context.secrets object.",
"name": "key",
"required": true
}
},
"description": "Create a project secret. Encrypts the value locally with the project public key.",
"examples": [
"browse cloud secrets create SERVICE_TOKEN",
"browse cloud secrets create SERVICE_TOKEN --env MY_SERVICE_TOKEN",
"browse cloud secrets create SERVICE_TOKEN --stdin < ./secret.txt"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"env": {
"description": "Read the secret value from the named environment variable.",
"exclusive": [
"stdin"
],
"name": "env",
"hasDynamicHelp": false,
"helpValue": "VARIABLE_NAME",
"multiple": false,
"type": "option"
},
"stdin": {
"description": "Read the exact secret value from stdin, preserving whitespace.",
"exclusive": [
"env"
],
"name": "stdin",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:secrets:create",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"secrets",
"create.js"
]
},
"cloud:secrets:delete": {
"aliases": [],
"args": {
"secretId": {
"description": "Project secret ID (e.g. d2c4f48f-38e9-4b82-a36a-2b373fd14a65).",
"name": "secretId",
"required": true
}
},
"description": "Delete a project secret.",
"examples": [
"browse cloud secrets delete <secretId>",
"browse cloud secrets delete d2c4f48f-38e9-4b82-a36a-2b373fd14a65"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:secrets:delete",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"secrets",
"delete.js"
]
},
"cloud:secrets:get": {
"aliases": [],
"args": {
"secretId": {
"description": "Project secret ID (e.g. d2c4f48f-38e9-4b82-a36a-2b373fd14a65).",
"name": "secretId",
"required": true
}
},
"description": "Get project secret metadata. Does not return the secret value.",
"examples": [
"browse cloud secrets get <secretId>",
"browse cloud secrets get d2c4f48f-38e9-4b82-a36a-2b373fd14a65"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:secrets:get",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"secrets",
"get.js"
]
},
"cloud:secrets:list": {
"aliases": [],
"args": {},
"description": "List project secret metadata with cursor pagination.",
"examples": [
"browse cloud secrets list",
"browse cloud secrets list --start-at 2026-01-01T00:00:00Z",
"browse cloud secrets list --start-at 2026-01-01T00:00:00Z --end-at 2026-02-01T00:00:00Z",
"browse cloud secrets list --limit 10"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"limit": {
"description": "Maximum results per page (API default: 20).",
"name": "limit",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"cursor": {
"description": "nextCursor from the previous page. Keep the same filters.",
"name": "cursor",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"start-at": {
"description": "Include secrets created on or after this RFC 3339 timestamp.",
"name": "start-at",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"end-at": {
"description": "Include secrets created on or before this RFC 3339 timestamp.",
"name": "end-at",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:secrets:list",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"secrets",
"list.js"
]
},
"cloud:secrets:update": {
"aliases": [],
"args": {
"secretId": {
"description": "Project secret ID (e.g. d2c4f48f-38e9-4b82-a36a-2b373fd14a65).",
"name": "secretId",
"required": true
}
},
"description": "Replace a secret value, encrypting it locally with the current project public key.",
"examples": [
"browse cloud secrets update <secretId>",
"browse cloud secrets update d2c4f48f-38e9-4b82-a36a-2b373fd14a65",
"browse cloud secrets update <secretId> --env MY_SERVICE_TOKEN",
"browse cloud secrets update <secretId> --stdin < ./secret.txt"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"env": {
"description": "Read the secret value from the named environment variable.",
"exclusive": [
"stdin"
],
"name": "env",
"hasDynamicHelp": false,
"helpValue": "VARIABLE_NAME",
"multiple": false,
"type": "option"
},
"stdin": {
"description": "Read the exact secret value from stdin, preserving whitespace.",
"exclusive": [
"env"
],
"name": "stdin",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:secrets:update",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"secrets",
"update.js"
]
},
"cloud:sessions:create": {
"aliases": [],
"args": {},
"description": "Create a new browser session. Use flags for common options, or --body/--stdin for the full API.",
"examples": [
"browse cloud sessions create --proxies --verified",
"browse cloud sessions create --region us-east-1 --timeout 300",
"browse cloud sessions create --solve-captchas --context-id ctx_abc --persist",
"browse cloud sessions create --body '{\"keepAlive\":true}'",
"echo '{\"keepAlive\":true,\"proxies\":true}' | browse cloud sessions create --stdin"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"body": {
"description": "Optional JSON request body.",
"name": "body",
"hasDynamicHelp": false,
"helpValue": "<body>",
"multiple": false,
"type": "option"
},
"stdin": {
"description": "Read JSON request body from stdin.",
"name": "stdin",
"allowNo": false,
"type": "boolean"
},
"proxies": {
"description": "Enable Browserbase proxy.",
"name": "proxies",
"allowNo": false,
"type": "boolean"
},
"advanced-stealth": {
"hidden": true,
"name": "advanced-stealth",
"allowNo": false,
"type": "boolean"
},
"verified": {
"description": "Enable Browserbase Verified browser mode.",
"name": "verified",
"allowNo": false,
"type": "boolean"
},
"solve-captchas": {
"description": "Enable automatic CAPTCHA solving. Use --no-solve-captchas to disable.",
"name": "solve-captchas",
"allowNo": true,
"type": "boolean"
},
"block-ads": {
"description": "Enable ad blocking.",
"name": "block-ads",
"allowNo": false,
"type": "boolean"
},
"region": {
"description": "Session region. (choices: \"us-west-2\", \"us-east-1\", \"eu-central-1\", \"ap-southeast-1\")",
"name": "region",
"hasDynamicHelp": false,
"helpValue": "<region>",
"multiple": false,
"options": [
"us-west-2",
"us-east-1",
"eu-central-1",
"ap-southeast-1"
],
"type": "option"
},
"keep-alive": {
"description": "Keep session alive after disconnection.",
"name": "keep-alive",
"allowNo": false,
"type": "boolean"
},
"timeout": {
"description": "Session timeout in seconds.",
"name": "timeout",
"hasDynamicHelp": false,
"helpValue": "<seconds>",
"multiple": false,
"type": "option"
},
"context-id": {
"description": "Browserbase context ID, or a name saved with 'contexts create --name', for persistent state.",
"name": "context-id",
"hasDynamicHelp": false,
"helpValue": "<id|name>",
"multiple": false,
"type": "option"
},
"persist": {
"description": "Persist context changes after session ends.",
"name": "persist",
"allowNo": false,
"type": "boolean"
},
"record-session": {
"description": "Enable session recording. Use --no-record-session to disable.",
"name": "record-session",
"allowNo": true,
"type": "boolean"
},
"log-session": {
"description": "Enable session logging. Use --no-log-session to disable.",
"name": "log-session",
"allowNo": true,
"type": "boolean"
},
"viewport": {
"description": "Browser viewport dimensions (e.g. 1920x1080).",
"name": "viewport",
"hasDynamicHelp": false,
"helpValue": "<WxH>",
"multiple": false,
"type": "option"
},
"extension-id": {
"description": "Chrome extension ID to load.",
"name": "extension-id",
"hasDynamicHelp": false,
"helpValue": "<id>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:sessions:create",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"sessions",
"create.js"
]
},
"cloud:sessions:debug": {
"aliases": [],
"args": {
"id": {
"description": "Session ID.",
"name": "id",
"required": true
}
},
"description": "Get live debugger URLs for a Browserbase session.",
"examples": [
"browse cloud sessions debug <session-id>"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:sessions:debug",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"sessions",
"debug.js"
]
},
"cloud:sessions:get": {
"aliases": [],
"args": {
"id": {
"description": "Session ID.",
"name": "id",
"required": true
}
},
"description": "Get a Browserbase session by ID.",
"examples": [
"browse cloud sessions get <session-id>"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:sessions:get",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"sessions",
"get.js"
]
},
"cloud:sessions:list": {
"aliases": [],
"args": {},
"description": "List Browserbase sessions.",
"examples": [
"browse cloud sessions list",
"browse cloud sessions list --limit 5",
"browse cloud sessions list --status RUNNING",
"browse cloud sessions list --q \"user_metadata['env']:'staging'\"",
"browse cloud sessions list --json"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"format": {
"description": "Output format. Defaults to table in a terminal and JSON when piped.",
"name": "format",
"hasDynamicHelp": false,
"helpValue": "<format>",
"multiple": false,
"options": [
"table",
"json"
],
"type": "option"
},
"json": {
"description": "Print raw JSON output.",
"name": "json",
"allowNo": false,
"type": "boolean"
},
"wide": {
"description": "Show full table values without truncation.",
"name": "wide",
"allowNo": false,
"type": "boolean"
},
"all": {
"description": "Show all returned sessions in table output.",
"name": "all",
"allowNo": false,
"type": "boolean"
},
"limit": {
"description": "Maximum sessions to show in table output.",
"name": "limit",
"default": 20,
"hasDynamicHelp": false,
"helpValue": "<count>",
"multiple": false,
"type": "option"
},
"q": {
"description": "Session metadata query (e.g. \"user_metadata['env']:'staging'\").",
"name": "q",
"hasDynamicHelp": false,
"helpValue": "<q>",
"multiple": false,
"type": "option"
},
"status": {
"description": "Filter sessions by status.",
"name": "status",
"hasDynamicHelp": false,
"helpValue": "<status>",
"multiple": false,
"options": [
"RUNNING",
"ERROR",
"TIMED_OUT",
"COMPLETED"
],
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:sessions:list",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"sessions",
"list.js"
]
},
"cloud:sessions:logs": {
"aliases": [],
"args": {
"id": {
"description": "Session ID.",
"name": "id",
"required": true
}
},
"description": "Get Browserbase session logs.",
"examples": [
"browse cloud sessions logs <session-id>",
"browse cloud sessions logs <session-id> --only-errors",
"browse cloud sessions logs <session-id> --only-errors --failed-requests"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"only-errors": {
"description": "Return only the high-signal error records (console errors/exceptions, HTTP 4xx/5xx, network failures) instead of the full CDP firehose.",
"name": "only-errors",
"allowNo": false,
"type": "boolean"
},
"failed-requests": {
"dependsOn": [
"only-errors"
],
"description": "With --only-errors, narrow to failed / error-status network requests only.",
"name": "failed-requests",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:sessions:logs",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"sessions",
"logs.js"
]
},
"cloud:sessions:update": {
"aliases": [],
"args": {
"id": {
"description": "Session ID.",
"name": "id",
"required": true
}
},
"description": "Update a Browserbase session.",
"examples": [
"browse cloud sessions update <session-id> --status REQUEST_RELEASE",
"browse cloud sessions update <session-id> --body '{\"status\":\"REQUEST_RELEASE\"}'"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"status": {
"description": "Session status update. (choices: \"REQUEST_RELEASE\")",
"name": "status",
"default": "REQUEST_RELEASE",
"hasDynamicHelp": false,
"helpValue": "<status>",
"multiple": false,
"options": [
"REQUEST_RELEASE"
],
"type": "option"
},
"body": {
"description": "Optional JSON request body. Merged with --status when provided.",
"name": "body",
"hasDynamicHelp": false,
"helpValue": "<body>",
"multiple": false,
"type": "option"
},
"stdin": {
"description": "Read JSON request body from stdin.",
"name": "stdin",
"allowNo": false,
"type": "boolean"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:sessions:update",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"sessions",
"update.js"
]
},
"functions:secrets:attach": {
"aliases": [],
"args": {
"functionId": {
"description": "Function ID (e.g. 7b6e1c42-8d93-4a15-b2f0-9c6d3e8a5041).",
"name": "functionId",
"required": true
},
"secretId": {
"description": "Project secret ID (e.g. d2c4f48f-38e9-4b82-a36a-2b373fd14a65).",
"name": "secretId",
"required": true
}
},
"description": "Attach an existing project secret to a function.",
"examples": [
"browse functions secrets attach <functionId> <secretId>",
"browse functions secrets attach 7b6e1c42-8d93-4a15-b2f0-9c6d3e8a5041 d2c4f48f-38e9-4b82-a36a-2b373fd14a65"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "functions:secrets:attach",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"functions",
"secrets",
"attach.js"
]
},
"functions:secrets:detach": {
"aliases": [],
"args": {
"functionId": {
"description": "Function ID (e.g. 7b6e1c42-8d93-4a15-b2f0-9c6d3e8a5041).",
"name": "functionId",
"required": true
},
"secretId": {
"description": "Project secret ID (e.g. d2c4f48f-38e9-4b82-a36a-2b373fd14a65).",
"name": "secretId",
"required": true
}
},
"description": "Detach a secret from a function without deleting the secret.",
"examples": [
"browse functions secrets detach <functionId> <secretId>",
"browse functions secrets detach 7b6e1c42-8d93-4a15-b2f0-9c6d3e8a5041 d2c4f48f-38e9-4b82-a36a-2b373fd14a65"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "functions:secrets:detach",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"functions",
"secrets",
"detach.js"
]
},
"functions:secrets:list": {
"aliases": [],
"args": {
"functionId": {
"description": "Function ID (e.g. 7b6e1c42-8d93-4a15-b2f0-9c6d3e8a5041).",
"name": "functionId",
"required": true
}
},
"description": "List metadata for secrets attached to a function with cursor pagination.",
"examples": [
"browse functions secrets list <functionId>",
"browse functions secrets list 7b6e1c42-8d93-4a15-b2f0-9c6d3e8a5041",
"browse functions secrets list <functionId> --start-at 2026-01-01T00:00:00Z",
"browse functions secrets list <functionId> --start-at 2026-01-01T00:00:00Z --end-at 2026-02-01T00:00:00Z",
"browse functions secrets list <functionId> --limit 10"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"limit": {
"description": "Maximum results per page (API default: 20).",
"name": "limit",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"cursor": {
"description": "nextCursor from the previous page. Keep the same filters.",
"name": "cursor",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"start-at": {
"description": "Include secrets created on or after this RFC 3339 timestamp.",
"name": "start-at",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
},
"end-at": {
"description": "Include secrets created on or before this RFC 3339 timestamp.",
"name": "end-at",
"hasDynamicHelp": false,
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "functions:secrets:list",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"functions",
"secrets",
"list.js"
]
},
"cloud:sessions:downloads:get": {
"aliases": [],
"args": {
"id": {
"description": "Session ID.",
"name": "id",
"required": true
}
},
"description": "Download Browserbase session files as a ZIP archive.",
"examples": [
"browse cloud sessions downloads get <session-id>",
"browse cloud sessions downloads get <session-id> --output ./downloads.zip"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
},
"output": {
"description": "Path to write the ZIP file.",
"name": "output",
"hasDynamicHelp": false,
"helpValue": "<output>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:sessions:downloads:get",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"sessions",
"downloads",
"get.js"
]
},
"cloud:sessions:uploads:create": {
"aliases": [],
"args": {
"id": {
"description": "Session ID.",
"name": "id",
"required": true
},
"file": {
"description": "Path to file to upload.",
"name": "file",
"required": true
}
},
"description": "Upload a file to a Browserbase session.",
"examples": [
"browse cloud sessions uploads create <session-id> ./file.pdf"
],
"flags": {
"api-key": {
"description": "Override the Browserbase API key.",
"name": "api-key",
"hasDynamicHelp": false,
"helpValue": "<apiKey>",
"multiple": false,
"type": "option"
},
"base-url": {
"description": "Override the Browserbase API base URL.",
"name": "base-url",
"hasDynamicHelp": false,
"helpValue": "<baseUrl>",
"multiple": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [],
"id": "cloud:sessions:uploads:create",
"pluginAlias": "browse",
"pluginName": "browse",
"pluginType": "core",
"strict": true,
"isESM": true,
"relativePath": [
"dist",
"commands",
"cloud",
"sessions",
"uploads",
"create.js"
]
}
},
"version": "0.11.0"
}