Record your Cypress.io tests

Start by visiting our new test suite form. It will create an API key and guide you through each step.

• npm
• yarn
• pnpm
• bun

Terminal
npm install --save-dev @replayio/cypress

Terminal
npx replayio install

To use your API key, you can either use dotenv package and save it to a .env file or add the API key to your environment directly.

• .env
• macOS/Linux
• Windows

.env
REPLAY_API_KEY=<your_api_key>

Installing Replay Cypress is as simple as adding the plugin to your cypress.config.js and support files. Once installed, the plugin will let you record your tests with the Replay Chrome browser and add the Cypress timeline to Replay DevTools.

• CommonJS
• ESM

cypress/support/e2e.js
require('@replayio/cypress/support')

cypress.config.js
 1const { defineConfig } = require('cypress')
 2const { plugin: replayPlugin, wrapOn } = require('@replayio/cypress')
 3require('dotenv').config()
 4
 5module.exports = defineConfig({
 6  e2e: {
 7    setupNodeEvents(cyOn, config) {
 8      const on = wrapOn(cyOn)
 9      replayPlugin(on, config, {
10        upload: true, // automatically upload your replays do DevTools
11        apiKey: process.env.REPLAY_API_KEY,
12      })
13      return config
14    },
15  },
16})