For the complete documentation index, see llms.txt. This page is also available as Markdown.

Cypress integration

Integration with Cypress

Follow the steps below to have access to the comparison command so you can build visual regression tests

Setup

Install Cypress:

npm i -D cypress

Install the core package and the HTML report:

npm i -D cypress-image-diff-js cypress-image-diff-html-report

Then initialise Cypress if you don't have a project:

npx cypress open

Finally follow a suitable option for you below:

Once the above is complete, you will be all set to write a test!

If you have any struggles with integration, please refer to these examples.

Last updated