{ "doc": { "id": "app/references/advanced-installation", "title": "Advanced Installation Instructions for Cypress", "description": "Learn how to install Cypress with a custom binary, skip the installation of the Cypress binary, change the Cypress binary cache location or download URL and more", "section": "app", "source_path": "/llm/markdown/app/references/advanced-installation.md", "version": "524ff5211e60b5d53e55d6ad976d83966f66e7cd", "updated_at": "2026-04-30T14:20:05.396Z", "headings": [ { "id": "app/references/advanced-installation#advanced-installation", "text": "Advanced Installation", "level": 1 }, { "id": "app/references/advanced-installation#what-youll-learn", "text": "What you'll learn", "level": 5 }, { "id": "app/references/advanced-installation#environment-variables", "text": "Environment variables", "level": 2 }, { "id": "app/references/advanced-installation#proxy-configuration", "text": "Proxy configuration", "level": 2 }, { "id": "app/references/advanced-installation#install-binary", "text": "Install binary", "level": 2 }, { "id": "app/references/advanced-installation#skipping-installation", "text": "Skipping installation", "level": 3 }, { "id": "app/references/advanced-installation#troubleshoot-installation", "text": "Troubleshoot installation", "level": 3 }, { "id": "app/references/advanced-installation#binary-cache", "text": "Binary cache", "level": 2 }, { "id": "app/references/advanced-installation#run-binary", "text": "Run binary", "level": 2 }, { "id": "app/references/advanced-installation#mac", "text": "Mac", "level": 3 }, { "id": "app/references/advanced-installation#linux", "text": "Linux", "level": 3 }, { "id": "app/references/advanced-installation#windows", "text": "Windows", "level": 3 }, { "id": "app/references/advanced-installation#download-urls", "text": "Download URLs", "level": 2 }, { "id": "app/references/advanced-installation#mirroring", "text": "Mirroring", "level": 2 }, { "id": "app/references/advanced-installation#download-path-template", "text": "Download path template", "level": 2 }, { "id": "app/references/advanced-installation#using-a-custom-certificate-authority-ca", "text": "Using a custom certificate authority (CA)", "level": 2 }, { "id": "app/references/advanced-installation#opt-out-of-sending-exception-data-to-cypress", "text": "Opt out of sending exception data to Cypress", "level": 2 }, { "id": "app/references/advanced-installation#opt-out-on-linux-or-macos", "text": "Opt out on Linux or macOS", "level": 3 }, { "id": "app/references/advanced-installation#opt-out-on-windows", "text": "Opt out on Windows", "level": 3 }, { "id": "app/references/advanced-installation#opt-out-of-cypress-commercial-messaging", "text": "Opt out of Cypress commercial messaging", "level": 2 }, { "id": "app/references/advanced-installation#install-pre-release-version", "text": "Install pre-release version", "level": 2 }, { "id": "app/references/advanced-installation#windows-subsystem-for-linux", "text": "Windows Subsystem for Linux", "level": 2 }, { "id": "app/references/advanced-installation#uninstall-cypress", "text": "Uninstall Cypress", "level": 2 } ] }, "content": { "type": "root", "children": [ { "type": "heading", "depth": 1, "children": [ { "type": "text", "value": "Advanced Installation" } ] }, { "type": "heading", "depth": 5, "children": [ { "type": "text", "value": "What you'll learn" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "How to install Cypress with a custom binary" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "How to skip the installation of the Cypress binary" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "How to change the Cypress binary cache location or download URL" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "How to use a custom certificate authority (CA)" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "How to opt out of sending exception data to Cypress" } ] } ] } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Environment variables" } ] }, { "type": "table", "align": [ null, null ], "children": [ { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Name" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Description" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`CYPRESS_INSTALL_BINARY`" } ] }, { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "#Install-binary", "children": [ { "type": "text", "value": "Destination of Cypress binary that's downloaded and installed" } ] } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`CYPRESS_CONNECT_RETRY_THRESHOLD`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Overrides the maximum number of retries when connecting to a browser. The default value is 62." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`CYPRESS_DOWNLOAD_MIRROR`" } ] }, { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "#Mirroring", "children": [ { "type": "text", "value": "Downloads the Cypress binary through a mirror server" } ] } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`CYPRESS_DOWNLOAD_PATH_TEMPLATE`" } ] }, { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "#Download-path-template", "children": [ { "type": "text", "value": "Allows generating a custom URL to download the Cypress binary from" } ] } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`CYPRESS_CACHE_FOLDER`" } ] }, { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "#Binary-cache", "children": [ { "type": "text", "value": "Changes the Cypress binary cache location" } ] } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`CYPRESS_RUN_BINARY`" } ] }, { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "#Run-binary", "children": [ { "type": "text", "value": "Location of Cypress binary at run-time" } ] } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`CYPRESS_VERIFY_TIMEOUT`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Overrides the timeout duration for the `verify` command. The default value is 30000." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`CYPRESS_SKIP_VERIFY`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Skips the " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#cypress-verify", "children": [ { "type": "text", "value": "`verify` command" } ] }, { "type": "text", "value": " when `true`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "CYPRESS_SKIP_BINARY_INSTALL" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "removed use `CYPRESS_INSTALL_BINARY=0` instead" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "CYPRESS_BINARY_VERSION" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "removed use `CYPRESS_INSTALL_BINARY` instead" } ] } ] } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Proxy configuration" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "System " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/proxy-configuration.md", "children": [ { "type": "text", "value": "proxy properties" } ] }, { "type": "text", "value": " `http_proxy`, `https_proxy` and `no_proxy` are respected for the download of the Cypress binary. You can also use the npm properties `npm_config_proxy` and `npm_config_https_proxy`. Those have lower priority, so they will only be used if the system properties are being resolved to not use a proxy." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Install binary" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "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." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "This is helpful if you want to:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": true, "children": [ { "type": "listItem", "spread": true, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Install a version different than the default npm package." } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_INSTALL_BINARY=13.7.0 npm install cypress@13.7.1" } ] }, { "type": "listItem", "spread": true, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Specify an external URL (to bypass a corporate firewall)." } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_INSTALL_BINARY=https://company.domain.com/cypress.zip npm install cypress" } ] }, { "type": "listItem", "spread": true, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Specify a file to install locally instead of using the internet." } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_INSTALL_BINARY=/local/path/to/cypress.zip npm install cypress" } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "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." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Skipping installation" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "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`." } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_INSTALL_BINARY=0 npm install" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Now Cypress will skip its install phase once the npm module is installed." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Troubleshoot installation" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The Cypress " }, { "type": "link", "title": null, "url": "https://docs.npmjs.com/cli/using-npm/scripts", "children": [ { "type": "text", "value": "Life Cycle script" } ] }, { "type": "text", "value": " `postinstall` installs the Cypress binary after the " }, { "type": "link", "title": null, "url": "https://www.npmjs.com/package/cypress", "children": [ { "type": "text", "value": "Cypress npm module" } ] }, { "type": "text", "value": " has been installed. Package managers however execute the `postinstall` step in the background by default which hides the debug output. Execute `cypress install` separately with " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/troubleshooting.md#Log-sources", "children": [ { "type": "text", "value": "debug logging" } ] }, { "type": "text", "value": " enabled to view the debug logs." } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "npm" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Yarn" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "pnpm" } ] } ] } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_INSTALL_BINARY=0 npm install cypress --save-devDEBUG=cypress:cli* npx cypress install" }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_INSTALL_BINARY=0 yarn add cypress --devDEBUG=cypress:cli* yarn cypress install" }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_INSTALL_BINARY=0 pnpm add --save-dev cypressDEBUG=cypress:cli* pnpm cypress install" }, { "type": "paragraph", "children": [ { "type": "text", "value": "To set environment variables `CYPRESS_INSTALL_BINARY` and `DEBUG` in Windows CMD or PowerShell terminals, refer to examples in " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/troubleshooting.md#Print-DEBUG-logs", "children": [ { "type": "text", "value": "Print DEBUG Logs" } ] }, { "type": "text", "value": "." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "In Continuous Integration (CI) use the following commands to display debug logs from the Cypress binary installation:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "npm" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Yarn" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "pnpm" } ] } ] } ] }, { "type": "code", "lang": null, "meta": null, "value": "DEBUG=cypress:cli* npm ci --foreground-scripts" }, { "type": "code", "lang": null, "meta": null, "value": "yarn install --frozen-lockfile --ignore-scripts # Yarn v1 Classic onlyDEBUG=cypress:cli* yarn cypress install" }, { "type": "code", "lang": null, "meta": null, "value": "pnpm install --frozen-lockfile --ignore-scriptsDEBUG=cypress:cli* pnpm cypress install" }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Binary cache" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress downloads the matching Cypress binary to the global system cache, so that the binary can be shared between projects. By default, global cache folders are:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "MacOS: `~/Library/Caches/Cypress`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Linux: `~/.cache/Cypress`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Windows: `/AppData/Local/Cypress/Cache`" } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "To override the default cache folder, set the environment variable `CYPRESS_CACHE_FOLDER`." } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_CACHE_FOLDER=~/Desktop/cypress_cache npm install" }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_CACHE_FOLDER=~/Desktop/cypress_cache npm run test" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress will automatically replace the `~` with the user's home directory. So you can pass `CYPRESS_CACHE_FOLDER` as a string from CI configuration files, for example:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "environment: CYPRESS_CACHE_FOLDER: '~/.cache/Cypress'" }, { "type": "paragraph", "children": [ { "type": "text", "value": "See also " }, { "type": "link", "title": null, "url": "/llm/markdown/app/continuous-integration/overview.md#Caching", "children": [ { "type": "text", "value": "Continuous Integration - Caching" } ] }, { "type": "text", "value": " section in the documentation." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "`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)." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Run binary" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Setting the environment variable `CYPRESS_RUN_BINARY` overrides where the npm module finds the Cypress binary." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "`CYPRESS_RUN_BINARY` should be a path to an already unzipped Cypress binary executable. The Cypress commands " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#cypress-open", "children": [ { "type": "text", "value": "open" } ] }, { "type": "text", "value": ", " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#cypress-run", "children": [ { "type": "text", "value": "run" } ] }, { "type": "text", "value": " and " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#cypress-verify", "children": [ { "type": "text", "value": "verify" } ] }, { "type": "text", "value": " will then launch the provided binary." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The following example " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#cypress-run", "children": [ { "type": "text", "value": "cypress run" } ] }, { "type": "text", "value": " commands assume that you have first downloaded the Cypress binary to the default `Downloads` directory of your operating system." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Depending on how you then unzip the downloaded Cypress binary `cypress.zip` file, using a CLI command or alternatively a GUI interface, the directory structure may include one additional top-level directory named `cypress`, which you may need to add to the path defined by `CYPRESS_RUN_BINARY`." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If available, use the following to avoid the additional top-level directory level:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "unzip -q cypress" }, { "type": "paragraph", "children": [ { "type": "text", "value": "The examples below are for npm. If you are using Yarn or pnpm as package manager, replace `npx` with `yarn` or `pnpm` as appropriate. See " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#How-to-run-commands", "children": [ { "type": "text", "value": "How to run commands" } ] }, { "type": "text", "value": "." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Mac" } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_RUN_BINARY=~/Downloads/Cypress.app/Contents/MacOS/Cypress npx cypress run" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Linux" } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_RUN_BINARY=~/Downloads/Cypress/Cypress npx cypress run" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Windows" } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_RUN_BINARY=~/Downloads/Cypress/Cypress.exe npx cypress run" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress assumes that `CYPRESS_RUN_BINARY` points to a writeable directory structure so that it can save and re-use the results of verifying the Cypress binary. If you encounter a `permission denied` failure message from " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#cypress-verify", "children": [ { "type": "text", "value": "cypress verify" } ] }, { "type": "text", "value": ", you may be able to work around the failure by setting the environment variable `CYPRESS_SKIP_VERIFY` to `true`." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Download URLs" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If you want to download a specific Cypress version for a given platform (Operating System), you can get it from our CDN." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The download server URL is `https://download.cypress.io`." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "We currently have the following downloads available:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Windows 64-bit (`?platform=win32&arch=x64`)" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Linux 64-bit (`?platform=linux`)" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "macOS 64-bit (`?platform=darwin`)" } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Here are the available download URLs:" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "See " }, { "type": "link", "title": null, "url": "https://download.cypress.io/desktop.json", "children": [ { "type": "text", "value": "https://download.cypress.io/desktop.json" } ] }, { "type": "text", "value": " for all available platforms." } ] }, { "type": "table", "align": [ null, null, null ], "children": [ { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Method" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "URL" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Description" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`GET`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`/desktop`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Download Cypress at latest version (platform auto-detected)" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`GET`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`/desktop.json`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Returns JSON containing latest available CDN destinations" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`GET`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`/desktop?platform=p&arch=a`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Download Cypress for a specific platform and/or architecture" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`GET`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`/desktop/:version`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Download Cypress with a specified version" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`GET`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`/desktop/:version?platform=p&arch=a`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Download Cypress with a specified version and platform and/or architecture" } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Example of downloading Cypress `12.17.4` for Windows 64-bit:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "https://download.cypress.io/desktop/12.17.4?platform=win32&arch=x64" }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Mirroring" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "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." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "For example:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_DOWNLOAD_MIRROR=\"https://www.example.com\" cypress install" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress will then attempt to download a binary with this format: `https://www.example.com/desktop/:version?platform=p`" } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Download path template" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "You can use the `CYPRESS_DOWNLOAD_PATH_TEMPLATE` environment variable to download the Cypress binary from a custom URL that's generated based on endpoint, version, platform and architecture." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The following replacements are supported:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`${endpoint}` is replaced with `https://download.cypress.io/desktop/:version`. If `CYPRESS_DOWNLOAD_MIRROR` is set, its value is used instead of `https://download.cypress.io` (note that the `/desktop` remains!)" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`${platform}` is replaced with the platform the installation is running on (e.g. `win32`, `linux`, `darwin`)" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`${arch}` is replaced with the architecture the installation is running on (e.g. `x64`, `arm64`)" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`${version}` is replaced with the version number that's being installed (e.g. `10.11.0`)" } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Examples:" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "To install the binary from a download mirror that matches the exact file structure of `https://cdn.cypress.io`:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "export CYPRESS_DOWNLOAD_MIRROR=https://cypress-download.localexport CYPRESS_DOWNLOAD_PATH_TEMPLATE='${endpoint}/${platform}-${arch}/cypress.zip'# Example of a resulting URL: https://cypress-download.local/desktop/10.11.0/linux-x64/cypress.zip" }, { "type": "paragraph", "children": [ { "type": "text", "value": "To install the binary from a download server with a custom file structure:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "export CYPRESS_DOWNLOAD_PATH_TEMPLATE='https://software.local/cypress/${platform}/${arch}/${version}/cypress.zip'# Example of a resulting URL: https://software.local/cypress/linux/x64/10.11.0/cypress.zip" }, { "type": "paragraph", "children": [ { "type": "text", "value": "To define `CYPRESS_DOWNLOAD_PATH_TEMPLATE` in `.npmrc`, put a backslash before every `$`:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "CYPRESS_DOWNLOAD_PATH_TEMPLATE=\\${endpoint}/\\${platform}-\\${arch}/cypress.zip" }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Using a custom certificate authority (CA)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress can be configured to use the `ca` and `cafile` options from your npm config file to download the Cypress binary." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "For example, to use the CA at `/home/person/certs/ca.crt` when downloading Cypress, add the following to your `.npmrc`:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cafile=/home/person/certs/ca.crt" }, { "type": "paragraph", "children": [ { "type": "text", "value": "If neither `cafile` nor `ca` are set, Cypress looks at the system environment variable `NODE_EXTRA_CA_CERTS` and uses the corresponding certificate(s) as an extension for the trusted certificate authority when downloading the Cypress binary." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Note that the npm config is used as a replacement, and the node environment variable is used as an extension." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Opt out of sending exception data to Cypress" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "When an exception is thrown regarding Cypress, we send along the exception data to `https://api.cypress.io`. We solely use this information to help develop a better product." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If you would like to opt out of sending any exception data to Cypress, you can do so by setting `CYPRESS_CRASH_REPORTS=0` in your system environment variables." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Opt out on Linux or macOS" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "To opt out of sending exception data on Linux or macOS, run the following command in a terminal before installing Cypress:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "export CYPRESS_CRASH_REPORTS=0" }, { "type": "paragraph", "children": [ { "type": "text", "value": "To make these changes permanent, you can add this command to your shell's `~/.profile` (`~/.zsh_profile`, `~/.bash_profile`, etc.) to run them on every login." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Opt out on Windows" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "To opt out of sending exception data on Windows, run the following command in the Command Prompt before installing Cypress:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "set CYPRESS_CRASH_REPORTS=0" }, { "type": "paragraph", "children": [ { "type": "text", "value": "To accomplish the same thing in PowerShell:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "$env:CYPRESS_CRASH_REPORTS = \"0\"" }, { "type": "paragraph", "children": [ { "type": "text", "value": "To save the `CYPRESS_CRASH_REPORTS` variable for use in all new shells, use `setx`:" } ] }, { "type": "code", "lang": null, "meta": null, "value": "setx CYPRESS_CRASH_REPORTS 0" }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Opt out of Cypress commercial messaging" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress may occasionally display messages in your CI logs related to our commercial offerings and how they could benefit you during your workflows." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If you would like to opt out of all commercial messaging, you can do so by setting `CYPRESS_COMMERCIAL_RECOMMENDATIONS=0` in your system environment variables." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Install pre-release version" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "If you would like to install a pre-release version of Cypress to test out functionality that has not yet been released, here is how:" } ] }, { "type": "list", "ordered": true, "start": 1, "spread": true, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Open up the list of commits to `develop` on the Cypress repo: " }, { "type": "link", "title": null, "url": "https://github.com/cypress-io/cypress/commits/develop", "children": [ { "type": "text", "value": "https://github.com/cypress-io/cypress/commits/develop" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Find the commit that you would like to install the pre-release version of. Click the comment icon (highlighted in red below):" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "You should see several comments from the `cypress-bot` user with instructions for installing Cypress pre-releases. Pick the one that corresponds to your operating system and CPU architecture, and follow the instructions there to install the pre-release." } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress pre-releases are only available for 60 days after they are built. Do not rely on these being available past 60 days." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Windows Subsystem for Linux" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress requires an " }, { "type": "link", "title": null, "url": "https://en.wikipedia.org/wiki/X.Org_Server", "children": [ { "type": "text", "value": "X-server" } ] }, { "type": "text", "value": " (X11) to display the Cypress UI from a Windows Subsystem for Linux installation. This requirement is met by current versions of Windows Subsystem for Linux (WSL2) with X11 support being included through Windows Subsystem for Linux GUI (WSLg)." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Refer to " }, { "type": "link", "title": null, "url": "https://github.com/microsoft/wslg", "children": [ { "type": "text", "value": "GitHub: Windows Subsystem for Linux GUI (WSLg)" } ] }, { "type": "text", "value": " for installation instructions on Ubuntu and install the " }, { "type": "link", "title": null, "url": "/llm/markdown/app/get-started/install-cypress.md#Linux-Prerequisites", "children": [ { "type": "text", "value": "prerequisite Linux packages" } ] }, { "type": "text", "value": " before running Cypress." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Refer to Microsoft Learn " }, { "type": "link", "title": null, "url": "https://learn.microsoft.com/en-us/windows/wsl/", "children": [ { "type": "text", "value": "Windows Subsystem for Linux Documentation" } ] }, { "type": "text", "value": " for additional information." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress.io does not specifically support the use of Cypress under Windows Subsystem for Linux (WSL). If you want to report an issue, please ensure that you can reproduce it without using WSL on one of the Cypress " }, { "type": "link", "title": null, "url": "/llm/markdown/app/get-started/install-cypress.md#Operating-System", "children": [ { "type": "text", "value": "supported operating systems" } ] }, { "type": "text", "value": "." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Uninstall Cypress" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "To uninstall Cypress from a project, use the same package manager you used to " }, { "type": "link", "title": null, "url": "/llm/markdown/app/get-started/install-cypress.md", "children": [ { "type": "text", "value": "install Cypress" } ] }, { "type": "text", "value": ":" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "npm" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Yarn" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "pnpm" } ] } ] } ] }, { "type": "code", "lang": null, "meta": null, "value": "npm uninstall cypress" }, { "type": "code", "lang": null, "meta": null, "value": "yarn remove cypress" }, { "type": "code", "lang": null, "meta": null, "value": "pnpm remove cypress" }, { "type": "paragraph", "children": [ { "type": "text", "value": "To uninstall all cached Cypress binary versions, use the " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#cypress-cache-clear", "children": [ { "type": "text", "value": "cypress cache clear" } ] }, { "type": "text", "value": " command with the appropriate package manager prefix described in " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/command-line.md#How-to-run-commands", "children": [ { "type": "text", "value": "How to run commands" } ] }, { "type": "text", "value": ". Alternatively, delete the " }, { "type": "link", "title": null, "url": "#Binary-cache", "children": [ { "type": "text", "value": "Cypress binary cache" } ] }, { "type": "text", "value": " (see above) manually." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "To delete cached " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/troubleshooting.md#Clear-App-Data", "children": [ { "type": "text", "value": "Cypress App Data" } ] }, { "type": "text", "value": ", manually delete the following directories / folders:" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "macOS: `~/Library/Application Support/Cypress`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Linux: `~/.config/Cypress`" } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "Windows: `$APPDATA/Cypress` (POSIX-syntax) or `%APPDATA%\\Cypress` (Windows-syntax)" } ] } ] } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Refer to your package manager documentation for details of package manager `cache clean` commands to remove other packages cached by npm, Yarn or pnpm." } ] } ] }, "token_estimate": 2679 }