# @bugbug-io/cli 中文文档

规范地址：https://npmcn.com/package/%40bugbug-io/cli/

版本：14\.22\.0
npm 元数据更新时间：2026-11-05T05:47:08.144Z
中文译文更新时间：2026-11-08T20:26:43.228Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bugbug-io/cli
原文对照：https://npmcn.com/package/%40bugbug-io/cli/?lang=original
项目主页：https://docs.bugbug.io/integrations/cli

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

- 包体积（解压后）：5.3 MB，25 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24
- 运行依赖：0 个
- 首次发布：2026-08-20T11:56:47.336Z
- 最新版本发布：2026-11-05T05:47:07.975Z
- 近 30 天下载量：2529（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 41 个）

## 中文简介

BugBug CLI 用于测试自动化、 CI 工作流程和 AI 代理插件安装

## 安装

```sh
npm install @bugbug-io/cli
```

也可以使用：`pnpm add @bugbug-io/cli`、`yarn add @bugbug-io/cli`、`bun add @bugbug-io/cli`

## README

![BugBug logo](https://bugbug.io/favicon-96x96.png)

# BugBug 语录

## 所需资源

-   节点.js v24 或以上
-   BugBug 账户或 API 令牌

## 安装 CLI

```sh
npm install -g @bugbug-io/cli
bugbug --help
```

或者在没有全局安装的情况下运行它:

```sh
npx @bugbug-io/cli --help
```

CLI和MCP访问需要BugBug Pro计划或更高. 捆绑的 BugBug 在所有计划中都有技能.

## 签名并运行您的第一个测试

```sh
bugbug login
bugbug tests run <testId>
```

`bugbug login` 打开浏览器并存储 CLI 证书。 用于 CI 或脚本 ,以 `--token` 或者说 `BUGBUG_API_TOKEN`。 。 。 .

自我托管的MCP客户端请参见 [无记名符号设置](https://npmcn.com/public-docs/ai-testing/mcp.md#bearer-token-authentication-for-self-hosted-clients)。 。 。 .

## 将 repo 链接到 BugBug 项目

运行 `bugbug init` 在您的仓库中将目录绑入一个 BugBug 项目:

```sh
bugbug init
```

交互 它询问如何认证 - 浏览器登录, 或粘贴的项目 或组织 API 令牌 - 然后让您选择项目链接 。 这个 如果您已经运行, 认证步骤会被跳过 `bugbug login`在 CI 或任意 非交互 shell, 传递两个值 :

```sh
bugbug --token <api-token> --project-id <project-id> init
```

`bugbug project init` 是同一个命令.

Init 写着 `projectId` 改为 a `bugbug.yaml` 在当前目录和存储中 在全局配置中单独的符号 : `~/.bugbug/config.yaml`键 那个项目 命令从该目录或任何子目录中运行 自行解决项目和象征,所以 `bugbug tests list` 需要没有 旗帜. `bugbug.yaml` 确是安全的,迹象绝不是写在它的上面的.

## 环境变量

| 变量 | 说明 |
| --- | --- |
| `BUGBUG_API_TOKEN` | 用于认证请求的 API 令牌 |
| `BUGBUG_PROJECT_ID` | 项目ID(非互动模式下的组织标志需要) |
| `BUGBUG_LOG_LEVEL` | 日志级别; 设置为 `debug` 以启用动词记录 |
| `BUGBUG_TELEMETRY` | 设定为 `false` 禁用遥测 |
| `DO_NOT_TRACK` | 标准退出; 设置为 `1`编号 :`true` 禁用遥测 |
| `CI` | 何时 `true`,部队平面(非互动)输出 |

## 图标

运行 `bugbug` 没有交互式导航参数,或 `bugbug <command> --help` 关于任何命令的细节.

### 认证

```bash
bugbug login          # Authenticate and store a user token in the global config
bugbug logout         # Clear the stored user token and current project
```

### 项目

```bash
bugbug init                       # Create bugbug.yaml pinning this directory to a project
bugbug project settings           # Read project settings
bugbug project export             # Export project as a ZIP (bugbug-project-export-<timestamp>.zip)
bugbug project export -o out.zip  # Export to a specific file
bugbug project import out.zip     # Import a project from a ZIP archive
```

### 测试

```bash
bugbug tests list                 # List tests
bugbug tests list -s "login"      # Filter tests by name
bugbug tests show <testId>         # Show test details
bugbug tests run <testId>          # Run a test (waits for completion by default)
bugbug tests run <testId> --profile "Production"
bugbug tests run <testId> --tag smoke --tag critical
bugbug tests run <testId> --variable FOO=bar --variable BAZ=qux
bugbug tests run <testId> --no-wait        # Queue the run and exit immediately
bugbug tests run <testId> --reporter junit --output-path report.xml
bugbug tests tags set <testId> --tag smoke # Replace test tags by name
bugbug tests tags set <testId>             # Clear test tags
bugbug tests export <testId> --format yaml
bugbug tests export <testId> --format zip -o test.zip
bugbug tests import test.yaml             # Import a test from YAML or ZIP (--folder-id <id> to choose a test folder)
```

### 测试运行

```bash
bugbug testruns show <runId>               # Show the result of a test run
bugbug testruns logs <runId>               # Get logs for a test run
bugbug testruns stop <runId>               # Stop a running test run
bugbug testruns report <runId> -o out.xml  # Get the JUnit XML report
bugbug testruns tags set <runId> --tag flaky
bugbug testruns tags set <runId>           # Clear directly assigned run tags
bugbug testruns notes set <runId> "Retried successfully"
bugbug testruns notes set <runId>           # Clear run notes
```

### 诉讼

```bash
bugbug suites list                # List suites
bugbug suites list -s "checkout"  # Filter suites by name
bugbug suites show <suiteId>       # Show suite details
bugbug suites run <suiteId>        # Run a suite (waits for completion by default)
bugbug suites run <suiteId> --profile "Production" --variable FOO=bar
bugbug suites run <suiteId> --tag smoke
bugbug suites run <suiteId> --no-wait
bugbug suites tags set <suiteId> --tag regression
bugbug suites tags set <suiteId>   # Clear suite tags
```

### 套接字运行

```bash
bugbug suiteruns show <runId>              # Show the result of a suite run (--compact: failed tests only)
bugbug suiteruns stop <runId>              # Stop a running suite run
bugbug suiteruns report <runId> -o out.xml # Get the JUnit XML report
bugbug suiteruns tags set <runId> --tag nightly
bugbug suiteruns tags set <runId>          # Clear directly assigned run tags
bugbug suiteruns notes set <runId> "Nightly follow-up"
bugbug suiteruns notes set <runId>         # Clear run notes
```

### 简介

```bash
bugbug profiles list              # List run profiles
```

### 标记

```bash
bugbug tags list                  # List tags in the active project
bugbug --json tags list           # Emit tag details as JSON
```

### AI 客户端( 插件: MCP + 技能)

```bash
bugbug plugin --agent=<agent>
bugbug plugin --agent=<agent> --dry-run  # Show what would be installed, writing nothing
```

支助 `--agent` 值 : `cursor`, (中文(简体) ), `claude`, (中文(简体) ), `vscode`, (中文(简体) ), `codex`, (中文(简体) ), `copilot`。 。 。 .

### 简称

上方命名空格命令上的第一简指针地图 :

```bash
bugbug run test <testId>
bugbug run suite <suiteId>
bugbug list test
bugbug list suite
bugbug list profile
bugbug stop test <runId>
bugbug stop suite <runId>
bugbug report test <runId>
bugbug report suite <runId>
bugbug logs test <runId>
bugbug export project
bugbug export test <testId>
bugbug import project export.zip
bugbug import test test.yaml
```

## 全球选项

-   `-t, --token <token>`: BugBug 的 API 令牌( 覆盖配置)
-   `-p, --project-id <projectId>`: 项目ID(仅用于非互动模式下的组织标志)
-   `-v, --verbose`: 启用动词记录,包括 HTTP 请求
-   `--ci`: CI 方便输出(平面日志,无交互UI,故障后出站1)
-   `--json`: Emit JSON 输出( 表示非交互)
-   `--disable-telemetry`: 禁用遥测
-   `-h, --help`: 显示帮助信息

## 许可证

麻省理工学院

## 常见问题

### @bugbug-io/cli 是什么？

BugBug CLI 用于测试自动化、 CI 工作流程和 AI 代理插件安装

### 如何安装 @bugbug-io/cli？

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

### @bugbug-io/cli 支持 TypeScript 吗？

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

### @bugbug-io/cli 支持 ESM 还是 CommonJS？

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

### @bugbug-io/cli 需要什么版本的 Node\.js？

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

### @bugbug-io/cli 可以商用吗？

@bugbug-io/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bugbug-io/cli 的下载量有多少？

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

### @bugbug-io/cli 还在维护吗？

最新版本 14\.22\.0 发布于 2026/11/05（3 天前）；至今共发布 41 个版本，其中过去 12 个月发布了 41 个；首次发布于 2026/08/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。