# @currents/cli 中文文档

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

版本：4\.0\.5
npm 元数据更新时间：2026-10-30T10:16:23.499Z
中文译文更新时间：2026-11-11T05:05:47.996Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：5.7 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=14\.17\.0
- 运行依赖：1 个
- 首次发布：2021-05-08T05:31:29.438Z
- 最新版本发布：2023-12-08T13:30:56.088Z
- 近 30 天下载量：56060（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 0 个）

## 中文简介

将 Cypress 与 [当前](https://currents.dev/?utm_source=currents_cli) - Cypress Cloud的替补

## 安装

```sh
npm install @currents/cli
```

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

## README

# @ 当前/ cli

将 Cypress 与 [当前](https://currents.dev/?utm_source=currents_cli) - Cypress Cloud的替补

![](https://user-images.githubusercontent.com/1637928/213367982-78987b7a-411a-4d2e-9486-ca204847022e.png)

[当前](https://currents.dev/?utm_source=currents_cli) | [更改日志](https://npmcn.com/package/%40currents/cli/CHANGELOG.md) | [兼容性](https://currents.dev/readme/guides/cypress-compatibility) | [文档](https://currents.dev/readme/guides/currents-cli)

* * *

**2023年12月 最新情况**

如果你看见 `Error: certificate has expired`,请升级到4.0.4+版本.

**2023年3月 最新情况**

QQ Cypress 12.6.0+ 用户请使用 [https://github.com/currents-dev/cypress-cloud 页面存档备份,存于互联网档案馆](https://github.com/currents-dev/cypress-cloud) 如果你看见 `Cypress does not support recording test results to this third party service` 错误 qq

* * *

## CLI 使用量

使用电流作为管弦乐和录音服务. 司令部将所有CLI旗下通过来进行Cypress并进行幕后Cypress.

```sh
npm install @currents/cli cypress
npx currents run --parallel --record --key XXXXXX --ci-build-id build-001
```

## API 密码

### `run`

通过它的 Cypress 运行 [模块 API](https://docs.cypress.io/guides/guides/module-api)

```ts
run(config: CypressCommandLine.CypressRunOptions): Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>
```

示例

```ts
import { run } from "@currents/cli";

const cypressOptions: Partial<CypressCommandLine.CypressRunOptions> = {
  browser: "chrome",
  parallel: true,
  record: true,
  key: "Currents key from https://app.currents.dev",
  tag: "smoke",
};
const results = await run(cypressOptions);
```

### `spawn`

Spawn Cypress作为一个孩子的过程,继承了所有的旗帜和环境变量. 它引用 `process.exit` 使用执行结束时的儿童程序退出代码.

```ts
spawn(): Promise<void>
```

示例

```ts
import { spawn } from "@currents/cli";

await spawn();
```

## 中断更改

### 版本 4+

4+版本不修改Cypress的本地安装. 下列辅助二进制被贬值:

-   `currents-prepare` 脚本被贬. 使用 `run` 或者说 `spawn` API代替.
-   `currents-reset` 脚本已贬值, 使用 `run` 或者说 `spawn` API代替.
-   `patch` API被贬. 使用 `run` 或者说 `spawn` 换句话说.

## 常见问题

### @currents/cli 是什么？

将 Cypress 与 当前 - Cypress Cloud的替补

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

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

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

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

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

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

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

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

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

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

### @currents/cli 的下载量有多少？

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

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

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