浏览器 CLI
官方CLI为 浏览器库。管理会话,部署无服务器的功能,浏览网络,并从终端与浏览器库平台进行互动.
安装
npm install -g @browserbasehq/cli
需要节点.js 18+.
快速启动
# Set your API key
export BROWSERBASE_API_KEY=bb_live_...
# Fetch a webpage
bb fetch https://example.com
# Search the web
bb search "browserbase documentation"
# Browse interactively
bb browse https://example.com
# List your sessions
bb sessions list
图标
bb fetch <url>
在没有完整浏览器时检索网页内容 .
bb fetch https://example.com
bb fetch https://example.com --output page.json
bb fetch https://example.com --proxies --allow-redirects
| 旗帜 | 说明 |
|---|---|
--output <path> | 将回复写入文件 |
--proxies | 启用浏览器库代理支持 |
--allow-redirects | 跟随 HTTP 重定向 |
--allow-insecure-ssl | 旁通 TLS 证书验证 |
bb search <query>
使用浏览器库搜索 API 搜索网页 .
bb search "web automation tools"
bb search "browserbase" --num-results 5
| 旗帜 | 说明 |
|---|---|
--num-results <n> | 结果数目(1-25,默认为10) |
--output <path> | 将结果写入文件 |
bb browse [args...]
启动浏览器会话 。 转发至 @browserbasehq/browse-cli 软件包(首次使用的自动安装).
bb browse https://example.com
bb browse --yes # skip install prompt
bb sessions
管理远程浏览器会话 .
bb sessions list # List all sessions
bb sessions list --q "status=RUNNING" # Filter by metadata
bb sessions get <session-id> # Get session details
bb sessions create --body '{"projectId":"..."}'
bb sessions update <id> --status REQUEST_RELEASE
bb sessions debug <id> # Get debugger connection URLs
bb sessions logs <id> # View session logs
bb sessions recording <id> # Get rrweb recording events
bb sessions downloads get <id> # Download session artifacts (ZIP)
bb sessions uploads create <id> <file> # Upload a file to a session
bb functions
写入并部署无服务器浏览器自动化到云.
# Scaffold a new project
bb functions init my-function
# Run locally
bb functions dev handler.ts --port 3000
# Deploy to Browserbase
bb functions publish handler.ts
bb functions publish handler.ts --dry-run # preview without deploying
# Invoke a deployed function
bb functions invoke <function-id> --params '{"url":"https://example.com"}'
bb functions invoke --check-status <invocation-id>
| 子命令 | 说明 |
|---|---|
init [name] | 脚手架功能项目( U)--package-manager npm|pnpm(中文(简体) ) |
dev <entry> | 启动本地 Dev 服务器( E)--port, (中文(简体) ), --host, (中文(简体) ), --verbose(中文(简体) ) |
publish <entry> | 部署职能--dry-run(中文(简体) ) |
invoke [id] | 启动函数( I)--params, (中文(简体) ), --no-wait, (中文(简体) ), --check-status(中文(简体) ) |
bb projects
管理浏览器库项目 .
bb projects list
bb projects get <project-id>
bb projects usage <project-id>
bb contexts
坚持浏览器状态(cookies, localStorage)跨会话.
bb contexts create --body '{"projectId":"..."}'
bb contexts get <context-id>
bb contexts update <context-id> # Refresh upload URL
bb contexts delete <context-id>
bb extensions
管理远程会话的 Chrome 扩展名 .
bb extensions upload extension.zip
bb extensions get <extension-id>
bb extensions delete <extension-id>
bb skills
为 Claude Code 安装浏览器数据库代理技能 .
bb skills # Interactive install
bb skills install # Non-interactive install
bb skills --yes # Auto-accept prompts
配置
| 环境变量 | 说明 |
|---|---|
BROWSERBASE_API_KEY | 您的浏览器库 API 密钥( 需要) |
BROWSERBASE_PROJECT_ID | 函数默认工程 ID |
BROWSERBASE_BASE_URL | 自定义 API 基础 URL |
所有环境变量都可用 --api-key, (中文(简体) ), --project-id,或 --base-url 旗帜.
发展
bun install
bun run cli -- --help # Run locally
bun run check # Type-check
bun run build # Build to dist/
bun run test # Build + run tests
许可证
这个项目根据麻省理工学院许可证获得许可证——见: 自由主义 详细文件.