Module for adding visual regression testing to Cypress
Switch branches/tags
Clone or download
Latest commit 368e2c8 Dec 8, 2018

Cypress Visual Regression


Build Status

Module for adding visual regression testing to Cypress.

Getting Started


$ npm install cypress-visual-regression

Add the following config to your cypress.json file:

  "screenshotsFolder": "cypress/snapshots/actual",
  "trashAssetsBeforeRuns": true

Add the plugin to cypress/plugins/index.js:

const getCompareSnapshotsPlugin = require('cypress-visual-regression/dist/plugin');

module.exports = (on) => {

Add the command to cypress/support/commands.js:

const compareSnapshotCommand = require('cypress-visual-regression/dist/command');


To Use

Add cy.compareSnapshot('home'); in your tests specs whenever you want to test for visual regressions, making sure to replace home with a relevant name. You can also add an optional error threshold: Value can range from 0.00 (no difference) to 1.00 (every pixel is different). So, if you enter an error threshold of 0.50, the test would fail only if 0.51 percent of pixels are different.

Take the base images:

$ ./node_modules/.bin/cypress run --env type=base --config screenshotsFolder=cypress/snapshots/base

Find regressions:

$ ./node_modules/.bin/cypress run --env type=actual




  1. Allow end user to customize options (screenshot directory)
  2. Test functionality of taking screenshots without running visual regression
  3. Prevent "base" tests runs from actually running the regular Cypress tests