安装

npm 安装

通过 npm 安装 cypress:

  1. cd /your/project/path
  1. npm install cypress --save-dev

这将在您的项目中将 Cypress 作为开发依赖项本地安装。

请确保您已经安装了 Node.js，并且已经运行了 npm init 或者在项目根目录下有一个 node_modules 文件夹或 package.json 文件，以确保 Cypress 被安装在正确的目录中。

对于 Cypress 二进制文件的下载，会尊重系统代理属性 http_proxy、https_proxy 和 no_proxy。您也可以使用 npm 属性 npm_config_proxy 和 npm_config_https_proxy。这些优先级较低，因此只有在解析系统属性不使用代理时才会使用它们。

最佳实践 建议的方法是使用 npm 安装 Cypress，因为：

  • Cypress 像其他依赖项一样进行版本控制。
  • 它简化了在持续集成中运行 Cypress 的过程。

yarn add

通过 Yarn 安装 Cypress：

  1. cd /your/project/path
  1. yarn add cypress --dev

对于 Cypress 二进制文件的下载，会尊重系统代理属性 http_proxy、https_proxy 和 no_proxy。

pnpm add

通过 pnpm 安装 Cypress：

  1. cd /your/project/path
  1. pnpm add --save-dev cypress

提示

请确保您已经在本地安装了 pnpm 环境。如果没有，请安装：npm install pnpm@latest --global。

直接下载

如果您的项目中没有使用 Node 或者包管理器（npm、pnpm 或 Yarn），或者您想快速尝试 Cypress，您可以随时直接从我们的 CDN 下载 Cypress。

无法通过直接下载将运行记录到 Cypress Cloud。这个下载仅用于快速尝试 Cypress。要将测试记录到 Cypress Cloud，您需要将 Cypress 安装为 npm 依赖项。

直接下载将始终获取最新可用版本。您的平台将自动检测到。

然后，您可以手动解压缩并双击。Cypress 将在不需要安装任何依赖项的情况下运行。

从旧版本进行直接下载

您可以通过在 URL 后面加上所需版本来从我们的 CDN 下载旧版本（例如 https://download.cypress.io/desktop/12.17.4）。

高级安装

如果您有更复杂的需求，想要提升 Cypress 工作流程的水平，或者只是需要帮助解决问题，请查看我们的 高级安装 参考。

持续集成

请阅读我们的 持续集成 文档以获取在 CI 中安装 Cypress 的帮助。在 Linux 中运行时，您可能需要安装一些系统依赖项，或者您可以使用我们的Docker 镜像，其中已经预先构建了所有需要的内容。

系统要求

操作系统

Cypress 是安装在您计算机上的桌面应用程序。桌面应用程序支持以下操作系统：

  • macOS 10.15 及以上（Intel 或 Apple Silicon 64 位（x64 或 arm64））
  • Linux Ubuntu 20.04 及以上，Fedora 38 及以上，Debian 10 及以上（x64 或 arm64）（请查看下面的Linux 先决条件）
  • Windows 10 及以上（仅 64 位）

Node.js

Cypress 需要 Node.js 才能安装。我们支持以下版本：

  • Node.js 18.x
  • Node.js 20.x 及以上

Cypress 通常与Node 的发布时间表保持一致。

硬件

在本地运行 Cypress 时，它应该可以在任何能够进行现代 Web 开发的机器上顺利运行。

但是，在 CI 中运行 Cypress 时，一些较低级别的配置可能无法可靠地运行 Cypress，特别是在录制视频或进行更长时间的测试运行时。

在 CI 中可能遇到的一些问题，可能表明资源不足的迹象包括：

  • 在 cypress run 过程中提前退出或突然关闭（“崩溃”）
  • 捕获的视频中存在冻结或丢失的帧
  • 运行时间增加

在 CI 中运行 Cypress 时，我们建议您具备以下硬件要求：

CPU

  • 至少 2 个 CPU 以运行 Cypress
  • 如果启用了视频录制，则需要额外的 1 个 CPU
  • 如果您在 Cypress 外运行了其他进程，例如：
    • 应用服务器（前端）
    • 应用服务器（后端）
    • 应用数据库
    • 任何额外的基础设施（Redis、Kafka 等）

内存

  • 至少 4GB，长时间测试运行建议 8GB+

Linux 先决条件

如果您使用的是 Linux，您需要在系统中安装所需的依赖项。根据您的系统默认设置，这些依赖项可能已经安装。如果没有，请运行下面列出的您操作系统的命令行。Cypress Docker 镜像已经包含了必要的依赖项。

Ubuntu/Debian

  1. apt-get install libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libnss3 libxss1 libasound2 libxtst6 xauth xvfb

Arch

  1. pacman -S gtk2 gtk3 alsa-lib xorg-server-xvfb libxss nss libnotify

CentOS

  1. yum install -y xorg-x11-server-Xvfb gtk2-devel gtk3-devel libnotify-devel GConf2 nss libXScrnSaver alsa-lib

Amazon Linux 2023

  1. dnf install -y xorg-x11-server-Xvfb gtk3-devel nss alsa-lib

Docker

已安装所有所需依赖项的 Docker 镜像可在 cypress/base 下找到。

如果您在容器中运行项目，那么您需要在包含 Node.js 进程的容器中安装 Cypress。

  1.   ui:    image: cypress/base:latest    # 如果针对特定的 Node.js 版本，使用例如    # image: cypress/base:18.12.1

cypress/base 是基本 Docker Node 镜像的替代品。

好的，现在安装 Cypress吧！