Record your first replay

Install the Cypress plugin in your project:

• npm
• yarn
• pnpm
• bun

Terminal
npm install @replayio/cypress -D

Simply add the Replay plugin to your project configuration and support files.

• CommonJS
• ESM

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

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

In order to automatically upload your test replays you need to save an API key in your environment. To generate an API key, log in to Replay App open the settings menu. Read more.

With everything set up, you can now run your test locally:

• npm
• yarn
• pnpm
• bun

Terminal
npx cypress run --browser replay-chromium

After your test finishes it will generate a link to Replay DevTools where you can inspect your test run.

You’re ready to inspect your local test run in Replay DevTools now. You can also record your tests in your CI environment. Learn how to set up Replay with your Cypress tests on GitHub Actions and other CI providers.