Set the record flag

Learn how to set the record flag and use the Cypress Dashboard service to view your test results.

Cypress record flag records your test runs and other details related to your Cypress tests and uses the Cypress Dashboard service to publish them to the dashboard. When you use this flag, your test results along with the screenshots, test status, etc. are published to both the BrowserStack and Cypress dashboards.

You must pass the record-key and the project-id flags along with the record flag to generate test results on the Cypress dashboard. Without either of the flags, though the Cypress build runs, the record functionality will not be supported. You can still see the test results on the Automate dashboard.

In this guide, you will learn about:

• Setting record flag using browserstack.json
• Setting record flag using the CLI

Set record flag using browserstack.json

Add the record, record-key, and project-id key within the run_settings object in the browserstack.json file.

The following code snippet shows a sample configuration.

//browserstack.json
"run_settings": {
  ...
    "record": true,
    "record-key": "<your_record-key>",
    "projectId": "<your_cypress_project_id>"
}

Set record flag using the CLI

Use the --record argument in the CLI to view test results on the Cypress dashboard as follows:

For example:

 browserstack-cypress run  --record --record-key "<your_record-key>" --projectId "<your_cypress_project_id>"

Points to remember

Before you set the record flag, note the following points:

• For any of the keys/arguments, the values set through CLI takes precedence over the values set in the browserstack.json file.
• The projectId key/argument set through CLI or the browserstack.json file takes precedence over the value set in the Cypress configuration file.