A quickstart guide to running your Cypress tests across 30+ desktop browsers.
Running your first Cypress test suite on BrowserStack is super easy - just install our CLI, configure the test run settings and start testing. Here’s a quick start guide to help you get started.
First, install the BrowserStack - Cypress CLI via npm
:
# Install the BrowserStack Cypress CLI
npm install -g browserstack-cypress-cli
Next, set up your BrowserStack credentials and configure the browsers that you
want to run your tests on. Use the init
command to generate a sample
browserstack.json
file, or alternatively create one from scratch.
# Create a sample configuration file for configurations and capabilities
browserstack-cypress init
Fill in the following details in the browserstack.json
file:
auth
- specify your username and access key. Learn about different auth
options here.browsers
- change the list of browsers and OS if you want to. Learn more
here.run_settings
- specify the cypress_config_file
, parallels
,
npm_dependencies
and any other options that you want to change.After you are done with the above changes, you should have something like this:
{
"auth": {
"username": "YOUR_USERNAME",
"access_key": "YOUR_ACCESS_KEY"
},
"browsers": [{
"browser": "chrome",
"os": "Windows 10",
"versions": ["latest", "latest - 1"]
},
{
"browser": "firefox",
"os": "OS X Mojave",
"versions": ["latest", "latest - 1"]
},
{
"browser": "edge",
"os": "OS X Catalina",
"versions": ["latest"]
}
],
"run_settings": {
"cypress_config_file": "./cypress.json",
"cypress_version": "6",
"project_name": "My sandbox project",
"build_name": "Build no. 1",
"parallels": "5"
}
}
Refer to the configuration options to learn more about all the options (in the
navigation pane on the left) you can use in browserstack.json
and the possible
values that you can mention.
After you specify the required run settings, you can run your tests on BrowserStack:
browserstack-cypress run --sync
You can access the test results on the BrowserStack Automate dashboard.
Contact our Support team for immediate help while we work on improving our docs.