# @browserbasehq/cli 中文文档

规范地址：https://npmcn.com/package/%40browserbasehq/cli/

版本：0\.5\.7
npm 元数据更新时间：2026-08-31T16:40:54.401Z
中文译文更新时间：2026-11-08T16:30:49.221Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40browserbasehq/cli
原文对照：https://npmcn.com/package/%40browserbasehq/cli/?lang=original
项目主页：https://github.com/browserbase/cli#readme
源码仓库：https://github.com/browserbase/cli

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

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：117 kB，30 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=18
- 运行依赖：7 个
- 首次发布：2026-03-14T19:40:47.169Z
- 最新版本发布：2026-04-26T01:07:41.832Z
- 近 30 天下载量：6449（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

浏览器Base CLI用于平台API,函数和浏览通过.

## 安装

```sh
npm install @browserbasehq/cli
```

也可以使用：`pnpm add @browserbasehq/cli`、`yarn add @browserbasehq/cli`、`bun add @browserbasehq/cli`

## README

# 浏览器 CLI

官方CLI为 [浏览器库](https://browserbase.com/)。管理会话,部署无服务器的功能,浏览网络,并从终端与浏览器库平台进行互动.

## 安装

```bash
npm install -g @browserbasehq/cli
```

需要节点.js 18+.

## 快速启动

```bash
# 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>`

在没有完整浏览器时检索网页内容 .

```bash
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 搜索网页 .

```bash
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` 软件包(首次使用的自动安装).

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

### `bb sessions`

管理远程浏览器会话 .

```bash
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`

写入并部署无服务器浏览器自动化到云.

```bash
# 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`

管理浏览器库项目 .

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

### `bb contexts`

坚持浏览器状态(cookies, localStorage)跨会话.

```bash
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 扩展名 .

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

### `bb skills`

为 Claude Code 安装浏览器数据库代理技能 .

```bash
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` 旗帜.

## 发展

```bash
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
```

## 许可证

这个项目根据麻省理工学院许可证获得许可证——见: [自由主义](https://npmcn.com/package/%40browserbasehq/cli/LICENSE) 详细文件.

## 常见问题

### @browserbasehq/cli 是什么？

浏览器Base CLI用于平台API,函数和浏览通过\.注意：该包已被作者标记为弃用——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。作者已将其标记为弃用，新项目建议寻找替代方案。