Skip to main content

Getting started

Pupille is a visual testing tool, running directly on your computer and CI server.

Unlike other solutions, nothing runs in the cloud, and there is no need for paying a subscription.

Setting up​

Install Pupille​

Using the package manager of your choice:

npm install pupille

Set up your configuration​

Create a pupille.config.js file with the following empty skeleton:

/pupille.config.js
module.exports = {
  baseUrl: '',
  tests: [],
}

You can start adding the URLs you want to test like so:

/pupille.config.js
module.exports = {
  baseUrl: 'http://localhost:3000',
  tests: [{ url: '/login' }, { url: '/profile' }, { url: '/dashboard' }],
}

Testing it out​

Simply run pupille check:

npx pupille check

This will run the Pupille checker on your machine, and screenshots will be generated automatically for the configured URLs.

If the results are as expected, you can approve all of the new screenshots with npx pupille approve *. If only some of the URLs are fine, you can specify which you want to approve (for example: npx pupille approve /login,/profile).