Have questions? We’re here to help! Contact us in Discord or at firstname.lastname@example.org.
To record tests and upload replays in other CI providers, you’ll need to complete the following steps in your workflow.
@replayio/cypressmust be installed in your CI environment before the tests execute.
If your workflow has an existing
yarncommand to install project dependencies, then you are all set.
If not, you’ll need to add a step to install all project dependencies, or you can manually install just the Replay package directly with
npm i @replayio/cypress.
Installing Replay Browsers
@replayio/cypressalso installs the required Replay Browsers. However, if you have a setting to suppress browser installations during
yarn, you’ll need to also manually install the Replay Browsers in your workflow using:
npx @replayio/cypress install
Update test run command
Your existing test run command (for example,
npx cypress run) must be updated to include the name of a Replay Browser and required environment variables to record.
You should make this update wherever your run command is defined, typically in
package.jsonor directly in the workflow file.
Pass the following with your run command to record with Replay:
RECORD_ALL_CONTENT=1if using “Replay Firefox”
--browser "Browser Name"(either “Replay Chromium” or “Replay Firefox”)
For example, to record with “Replay Firefox”, use the following command:
RECORD_ALL_CONTENT=1 RECORD_REPLAY_METADATA_FILE=$(mktemp) npx cypress run --browser "Replay Chromium"
If you don’t specify a browser, the Cypress default Electron will be used.
@replayio/replayCLI in your workflow to add source control metadata and upload replays to your team.
- Install the CLI
- Add metadata for all replays generated during the test run
- Upload replays with your API Key
npm i -g @replayio/replay replay metadata --init --keys source --warn replay upload-all --api-key <api key>
You can also set
RECORD_REPLAY_API_KEYas an environment variable instead of passing to the
upload-allcommand. This allows you to store the API Key in your CI provider to keep it secure.
The Replay CLI provides other commands and options, such as filtering which replays are uploaded.