# @argos-ci/cypress 中文文档

规范地址：https://npmcn.com/package/%40argos-ci/cypress/

版本：7\.4\.0
npm 元数据更新时间：2026-10-21T13:16:15.004Z
中文译文更新时间：2026-11-06T18:31:49.396Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40argos-ci/cypress
原文对照：https://npmcn.com/package/%40argos-ci/cypress/?lang=original
项目主页：https://argos-ci.com/docs/reference/cypress
源码仓库：https://github.com/argos-ci/argos-javascript

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

- 包体积（解压后）：22.5 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：4 个
- peer 依赖：cypress \>=12 \<17
- 首次发布：2022-08-30T09:37:19.651Z
- 最新版本发布：2026-10-21T13:16:14.251Z
- 近 30 天下载量：55855（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：170（近 12 个月 58 个）

## 中文简介

Cypress SDK与Argos进行视觉测试.

## 安装

```sh
npm install @argos-ci/cypress
```

也可以使用：`pnpm add @argos-ci/cypress`、`yarn add @argos-ci/cypress`、`bun add @argos-ci/cypress`

## README

[![Argos](https://raw.githubusercontent.com/argos-ci/argos/main/resources/logos/github-readme-logo-light.png)](https://argos-ci.com/?utm_source=github&utm_medium=logo)

**团队和AI代理的开源视觉测试平台.**

# 官方 Argos Cypress 集成系统

[![npm version](https://img.shields.io/npm/v/@argos-ci/cypress.svg)](https://www.npmjs.com/package/@argos-ci/cypress) [![npm dm](https://img.shields.io/npm/dm/@argos-ci/cypress.svg)](https://www.npmjs.com/package/@argos-ci/cypress) [![npm dt](https://img.shields.io/npm/dt/@argos-ci/cypress.svg)](https://www.npmjs.com/package/@argos-ci/cypress)

从您手中抓取稳定的 Argos 截图 [齐压](https://www.cypress.io/) 测试.

访问 [Cypress SDK 文档](https://argos-ci.com/docs/reference/cypress) 用于向导,API参考,以及更多.

## 安装

```sh
npm install --save-dev @argos-ci/cypress
```

## 使用量

在您的 Cypress 配置中注册 Argos 任务 :

```ts
// cypress.config.js
const { defineConfig } = require("cypress");
const { registerArgosTask } = require("@argos-ci/cypress/task");

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      registerArgosTask(on, config, {
        // Upload the screenshots to Argos only on CI.
        uploadToArgos: !!process.env.CI,
      });

      return config;
    },
  },
});
```

在支持文件中导入命令 :

```ts
// cypress/support/e2e.js
import "@argos-ci/cypress/support";
```

然后用 `cy.argosScreenshot` 在测试中:

```ts
// cypress/e2e/example.cy.js
describe("Homepage", () => {
  it("takes a screenshot", () => {
    cy.visit("http://localhost:3000");
    cy.argosScreenshot("homepage");
  });
});
```

## 链接

-   [官方 SDK 文档](https://argos-ci.com/docs/reference/cypress)
-   [快速启动](https://argos-ci.com/docs/quickstart/cypress-quickstart)
-   [解析器](https://argos-ci.com/discord)

## 常见问题

### @argos-ci/cypress 是什么？

Cypress SDK与Argos进行视觉测试\.

### 如何安装 @argos-ci/cypress？

在项目目录运行 npm install @argos-ci/cypress，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：cypress（\>=12 \<17）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @argos-ci/cypress 支持 TypeScript 吗？

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

### @argos-ci/cypress 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @argos-ci/cypress 需要什么版本的 Node\.js？

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

### @argos-ci/cypress 可以商用吗？

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

### @argos-ci/cypress 的下载量有多少？

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

### @argos-ci/cypress 还在维护吗？

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