@browserbasehq/cli

中文文档
0.5.7发布于 2026/04/26ES Module近 30 天下载 6449

Browserbase CLI for platform APIs, functions, and browse passthrough.

此软件包已被标记为弃用

The Browserbase CLI is now published as 'browse'. Please migrate by running: npm uninstall -g @browserbasehq/cli && npm install -g browse

原始使用文档
文档目录15 节
  1. Installation
  2. Quick Start
  3. Commands
  4. bb fetch <url>
  5. bb search <query>
  6. bb browse [args...]
  7. bb sessions
  8. bb functions
  9. bb projects
  10. bb contexts
  11. bb extensions
  12. bb skills
  13. Configuration
  14. Development
  15. License

Browserbase CLI

The official CLI for Browserbase. Manage sessions, deploy serverless functions, browse the web, and interact with the full Browserbase platform from your terminal.

Installation

npm install -g @browserbasehq/cli

Requires Node.js 18+.

Quick Start

# 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

Commands

bb fetch <url>

Retrieve webpage content without a full browser session.

bb fetch https://example.com
bb fetch https://example.com --output page.json
bb fetch https://example.com --proxies --allow-redirects
FlagDescription
--output <path>Write response to file
--proxiesEnable Browserbase proxy support
--allow-redirectsFollow HTTP redirects
--allow-insecure-sslBypass TLS certificate verification

bb search <query>

Search the web using the Browserbase Search API.

bb search "web automation tools"
bb search "browserbase" --num-results 5
FlagDescription
--num-results <n>Number of results (1-25, default 10)
--output <path>Write results to file

bb browse [args...]

Launch a browser session. Forwards to the @browserbasehq/browse-cli package (auto-installs on first use).

bb browse https://example.com
bb browse --yes  # skip install prompt

bb sessions

Manage remote browser 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

Write and deploy serverless browser automation to the cloud.

# 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>
SubcommandDescription
init [name]Scaffold a Functions project (--package-manager npm|pnpm)
dev <entry>Start local dev server (--port, --host, --verbose)
publish <entry>Deploy function (--dry-run)
invoke [id]Invoke a function (--params, --no-wait, --check-status)

bb projects

Manage Browserbase projects.

bb projects list
bb projects get <project-id>
bb projects usage <project-id>

bb contexts

Persist browser state (cookies, localStorage) across sessions.

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

Manage Chrome extensions for remote sessions.

bb extensions upload extension.zip
bb extensions get <extension-id>
bb extensions delete <extension-id>

bb skills

Install Browserbase agent skills for Claude Code.

bb skills           # Interactive install
bb skills install   # Non-interactive install
bb skills --yes     # Auto-accept prompts

Configuration

Environment VariableDescription
BROWSERBASE_API_KEYYour Browserbase API key (required)
BROWSERBASE_PROJECT_IDDefault project ID for Functions
BROWSERBASE_BASE_URLCustom API base URL

All environment variables can be overridden per-command with --api-key, --project-id, or --base-url flags.

Development

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

License

This project is licensed under the MIT License — see the LICENSE file for details.

版本与发布记录

@browserbasehq/cli 共发布 15 个版本,首次发布于 2026/03/15;过去 12 个月发布了 15 个版本。

版本发布日期距今
0.5.7latest2026/04/266 个月前
0.5.62026/04/256 个月前
0.5.52026/04/246 个月前
0.5.42026/04/077 个月前
0.5.32026/04/077 个月前
0.5.22026/04/067 个月前

关于 @browserbasehq/cli 的常见问题

@browserbasehq/cli 是什么?

Browserbase CLI for platform APIs, functions, and browse passthrough.注意:该包已被作者标记为弃用——The Browserbase CLI is now published as 'browse'. Please migrate by running: npm uninstall -g @browserbasehq/cli && npm install -g browse

如何安装 @browserbasehq/cli?

在项目目录运行 npm install @browserbasehq/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 bb,可以用 npx bb 直接运行。

@browserbasehq/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/browserbasehq__cli 是否存在。

@browserbasehq/cli 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@browserbasehq/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@browserbasehq/cli 可以商用吗?

@browserbasehq/cli 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@browserbasehq/cli 的下载量有多少?

根据 npm 官方下载统计,@browserbasehq/cli 在 2026/10/09 – 2026/11/07 这 30 天内被下载 6,449 次,日均约 215 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@browserbasehq/cli 还在维护吗?

最新版本 0.5.7 发布于 2026/04/26(6 个月前);至今共发布 15 个版本,其中过去 12 个月发布了 15 个;首次发布于 2026/03/15。作者已将其标记为弃用,新项目建议寻找替代方案。