# @testwatch/cli 中文文档

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

版本：0\.3\.0
npm 元数据更新时间：2026-11-02T15:33:38.620Z
中文译文更新时间：2026-11-02T16:12:31.124Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：39.5 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-10-09T10:46:42.248Z
- 最新版本发布：2026-11-02T15:33:38.394Z
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

从CI运行您的TestWatch端到端测试并等待判决。

## 安装

```sh
npm install @testwatch/cli
```

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

## README

# @testwatch / cli

运行您的 [TestWatch](https://testwatch.dev/) 从任何CI进行端到端测试，然后等待结果。

```bash
export TESTWATCH_API_KEY=tw_…        # TestWatch → Settings → API keys
npx @testwatch/cli run --app <app id> --wait --junit testwatch.xml
```

`--wait` 等待着 **最后** 在TestWatch检查了所有故障后，判决结果如下:

| 判决 | 意义 |
| --- | --- |
| `pass` | 每个测试都通过了（包括不稳定的通过） |
| `real_bug` | 该应用程序已损坏 |
| `needs_review` | 测试失败，需要一个人（通常：应用程序更改） |
| `infra` | 应用程序或其登录名不可用，或运行已取消 |

退出代码:

| 代码 | 意义 |
| --- | --- |
| `0` | 判决还没有出来 `--fail-on` (默认 `real_bug,needs_review,infra`） |
| `1` | 判决是在 `--fail-on` |
| `2` | 使用、授权、计划、网络或超时错误 |
| `130` | 被打断了。运行被取消，除非 `--no-cancel-on-abort` 是集。 |

其他选项:

-   `--env <name>`: 要运行的环境
-   `--env-url <deployed url>`：已部署的URL。它匹配环境自己的URL或其中之一 其预览模式。
-   `--url <preview url>`：运行这个预览URL(使用 `--env`,或应用程序的默认 环境）。它必须与环境的预览模式匹配。不是用 `--env-url`.
-   `--tag <t>` (重复)
-   `--tests <ids>`
-   `--account <name|id>`：以该帐户签署每个登录的测试(默认：每个测试的 自己的登录)。将跳过环境中不使用它的测试; 不签名的测试 在留下来签出。
-   `--timeout 30m`
-   `--json`
-   `testwatch whoami` 检查钥匙。

预览运行打印 `Preview · <host>`． 当TestWatch为测试提出PR修复时 布兰奇，报告打印出来了 `PR fix proposed — accept: <link>`: 在TestWatch中接受它，然后重新运行 这份工作。使用已接受的PR修复运行的测试将被标记 `(ran with accepted PR fix)`。出口 代码不会改变。

在GitHub Actions上，它编写了一个作业摘要，注释和输出 `run-id`， `url` 和 `verdict`。还有一个现成的行动: `testwatch-dev/action@v1`.

## 安全和支持

-   **制造商:** Vasyl Harastei (TestWatch)，soln á 24/23，746 01 Opava-m ě sto，捷克共和国.
-   **报告漏洞：** [security@testwatch.dev](mailto:security@testwatch.dev)． 信息披露政策: [https:// testwatch.de v/security # report](https://testwatch.dev/security#report).
-   **支持期:** 每个主要版本的安全修复至少5年后 主要版本的发布。
-   **SBOM:** 为已安装的软件包生成软件物料清单 `npm sbom` (如。 `npm sbom --sbom-format cyclonedx` 在一个项目中，这取决于 `@testwatch/cli`）。
-   CLI没有运行时依赖关系。已修复漏洞发布为GitHub安全 n github.com/测试监视开发建议。

## 常见问题

### @testwatch/cli 是什么？

从CI运行您的TestWatch端到端测试并等待判决。

### 如何安装 @testwatch/cli？

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

### @testwatch/cli 支持 TypeScript 吗？

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

### @testwatch/cli 支持 ESM 还是 CommonJS？

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

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

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

### @testwatch/cli 可以商用吗？

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

### @testwatch/cli 还在维护吗？

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