Installing Cypress

Improve this doc

What you’ll learn

  • How to install Cypress via npm.
  • How to install Cypress via direct download.
  • How to version and run Cypress via package.json

System requirements

Cypress is a desktop application that is installed on your computer. The desktop application supports these operating systems:

  • Mac OS 10.9+ (Mavericks+), only 64bit binaries are provided for macOS.
  • Linux Ubuntu 12.04+, Fedora 21, Debian 8, 64-bit binaries
  • Windows 7+, only 32bit binaries are provided for Windows.

Installing

npm install

Installing Cypress via npm is easy:

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

This will install Cypress locally as a dev dependency for your project.

Make sure that you have already run npm init or have a node_modules folder or package.json file in the root of your project to ensure cypress is installed in the correct directory.

Notice that the Cypress npm package is a wrapper around the Cypress binary. The version of the npm package determines the version of the binary downloaded.
As of version 3.0, the binary is downloaded to a global cache directory to be used across projects.

Best Practice

The recommended approach is to install Cypress with npm because :

yarn add

Installing Cypress via yarn:

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

Direct download

If you’re not using Node.js or npm in your project or you just want to try Cypress out quickly, you can always download Cypress directly from our CDN.

The direct download will always grab the latest available version. Your platform will be detected automatically.

Just manually unzip and double click. Cypress will run without needing to install any dependencies.

Continuous integration

Please read our Continuous Integration docs for help installing Cypress in CI. When running in linux you’ll need to install some system dependencies or you can just use our Docker images which have everything you need prebuilt.

Opening Cypress

If you used npm to install, Cypress has now been installed to your ./node_modules directory, with its binary executable accessible from ./node_modules/.bin. This means you can call it from your project root either of the following ways:

The long way with the full path

./node_modules/.bin/cypress open

Or with the shortcut using npm bin

$(npm bin)/cypress open

Or by using npx

note: npx is included with npm > v5.2 or can be installed separately.

npx cypress open

Or by using yarn

yarn run cypress open

After a moment, the Cypress Test Runner will launch.

Adding npm scripts

While there’s nothing wrong with writing out the full path to the Cypress executable each time, it’s much easier and clearer to add Cypress commands to the scripts field in your package.json file.

{
  "scripts": {
    "cypress:open": "cypress open"
  }
}

Now you can invoke the command like so:

npm run cypress:open

…and Cypress will open right up for you.

CLI tools

By installing Cypress through npm you also get access to many other CLI commands.

As of version 0.20.0 Cypress is also a fully baked node_module you can require in your Node scripts.

You can read more about the CLI here.

Advanced

Environment variables

Name Description
CYPRESS_INSTALL_BINARY Destination of Cypress binary that's downloaded and installed
CYPRESS_DOWNLOAD_MIRROR Downloads the Cypress binary though a mirror server
CYPRESS_CACHE_FOLDER Changes the Cypress binary cache location
CYPRESS_RUN_BINARY Location of Cypress binary at run-time
CYPRESS_SKIP_BINARY_INSTALL removed use CYPRESS_INSTALL_BINARY=0 instead
CYPRESS_BINARY_VERSION removed use CYPRESS_INSTALL_BINARY instead

Install binary

Using the CYPRESS_INSTALL_BINARY environment variable, you can control how Cypress is installed. To override what is installed, you set CYPRESS_INSTALL_BINARY alongside the npm install command.

This is helpful if you want to:

  • Install a version different than the default npm package.
    CYPRESS_INSTALL_BINARY=2.0.1 npm install [email protected]
    
  • Specify an external URL (to bypass a corporate firewall).
    CYPRESS_INSTALL_BINARY=https://company.domain.com/cypress.zip npm install cypress
    
  • Specify a file to install locally instead of using the internet.
    CYPRESS_INSTALL_BINARY=/local/path/to/cypress.zip npm install cypress
    

In all cases, the fact that the binary was installed from a custom location is not saved in your package.json file. Every repeated installation needs to use the same environment variable to install the same binary.

Skipping installation

You can also force Cypress to skip the installation of the binary application by setting CYPRESS_INSTALL_BINARY=0. This could be useful if you want to prevent Cypress from downloading the Cypress binary at the time of npm install.

CYPRESS_INSTALL_BINARY=0 npm install

Now Cypress will skip its install phase once the npm module is installed.

Binary cache

As of version 3.0, Cypress downloads the matching Cypress binary to the global system cache, so that the binary can be shared between projects. By default, these locations are:

  • MacOS: ~/Library/Caches/Cypress
  • Linux: ~/.cache/Cypress
  • Windows: /AppData/Local/Cypress/Cache

To override the default cache folder, set the environment variable CYPRESS_CACHE_FOLDER.

CYPRESS_CACHE_FOLDER=~/Desktop/cypress_cache npm install
CYPRESS_CACHE_FOLDER=~/Desktop/cypress_cache npm run test

CYPRESS_CACHE_FOLDER will need to exist every time cypress is launched. To ensure this, consider exporting this environment variable. For example, in a .bash_profile (MacOS, Linux), or using RegEdit (Windows).

Run binary

Setting the environment variable CYPRESS_RUN_BINARY overrides where the npm module finds the Cypress binary.

CYPRESS_RUN_BINARY should be a path to an already unzipped binary executable. The Cypress commands open, run, and verify will then launch the provided binary.

Mac

CYPRESS_RUN_BINARY=~/Downloads/Cypress.app/Contents/MacOS/Cypress cypress run

Linux

CYPRESS_RUN_BINARY=~/Downloads/Cypress/Cypress cypress run

Windows

CYPRESS_RUN_BINARY=~/Downloads/Cypress/Cypress.exe cypress run

We recommend not exporting the CYPRESS_RUN_BINARY environment variable, since it will affect every cypress module installed on your file system.

Hosting

If you want to download a specific Cypress version for a given platform (Operating System), you can get it from our CDN. You may also want to host Cypress yourself and serve it from a local network.

The download server url is https://download.cypress.io.

See https://download.cypress.io/desktop.json for all available platforms.

Method Url Description
GET /desktop Download Cypress at latest version (platform auto-detected)
GET /desktop.json Returns JSON containing latest available CDN destinations
GET /desktop?platform=p Download Cypress for a specific platform
GET /desktop/:version Download Cypress with a specified version
GET /desktop/:version?platform=p Download Cypress with a specified version and platform

Example of downloading Cypress 3.0.0 for Windows platform:

https://download.cypress.io/desktop/3.0.0?platform=win

Mirroring

If you choose to mirror the entire Cypress download site, you can specify CYPRESS_DOWNLOAD_MIRROR to set the download server url from https://download.cypress.io to your own mirror.

For example:

CYPRESS_DOWNLOAD_MIRROR="https://www.example.com" cypress install

Cypress will then attempt to download a binary with this format: https://www.example.com/desktop/:version?platform=p