Specify a Cypress version

Learn about the versions of Cypress we support and how to configure your builds.

As Cypress versions are released, it is recommended that your test scripts use the latest version to benefit from the recent enhancements and bug fixes. The Cypress versions are defined using the .latest format such that your test scripts always use the latest minor version.

Also, when Cypress versions are set as 8 or 7, BrowserStack uses the latest minor version to run the tests.

You will learn:

Supported Cypress versions

We support the two latest major versions of Cypress, namely v8 and v7 versions. If you want your test scripts to always use the latest Cypress minor version, set the version to either 8.latest or 8 for v8 and 7.latest or 7 for v7.

Note: You can still clearly set the Cypress minor versions in your code, such as 8.2.0 or 7.2.0. However, using the .latest flag ensures your tests always run on the latest minor version.

The following table lists the supported Cypress versions and how they must be defined in the browserstack.json file.

Cypress versions Set in browserstack.json as…
8.5.0 8.latest or 8
8.4.1 8.latest-1
8.3.1 8.latest-2
8.3.0 8.latest-3
8.2.0 8.latest-4
8.1.0 8.latest-5
8.0.0 8.latest-6
7.6.0 7.latest or 7
7.2.0 7.latest-1
Important: The support for Cypress version 6 or older versions ends on 31st December 2021. If you’re using v6 or older versions, migrate to one of the two latest major versions at the earliest.

Set the Cypress version

Set the cypress_version key to the required version as the value in the browserstack.json file.

Key Description Possible values
cypress_version Set the required Cypress version. 7.latest or 7 to run tests on 7.6.0,
8.latest or 8 to run tests on 8.5.0
Note: Check out Supported Cypress versions for the complete list of supported versions.

In browserstack.json, set the cypress version as seen in the following code snippet.

browserstack.json
{
  ...
  "run_settings": {
      ...
      #alternatively, can be set as "8".
      "cypress_version": "8.latest",
      ...
    }
  ...
}

Supported Cypress patch versions

The most recent patch versions for all minor versions are supported.

For example, for minor version 8.1, if there exist two patch versions, namely 8.1.2 and 8.1.1, only 8.1.2 will be supported.

If you have a use case where you need to use a Cypress version other than the one we support, please reach out to our Support team.

We're sorry to hear that. Please share your feedback so we can do better







Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better







Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Talk to an Expert