@applitools/eyes-puppeteer

Applitools Eyes SDK for Puppeteer.

Installation

Install eyes-puppeteer as a local dev dependency in your tested project:

npm i -D @applitools/eyes-puppeteer

Getting started

To get started with this SDK, you need to set the following:

Applitools API key
Eyes server URL - Required only if the Eyes server is not deployed on the Eyes public server.

Entering the Applitools API key {#API}

To authenticate via the Applitools server and run tests, you need to set the environment variable APPLITOOLS_API_KEY to the API key provided from Applitools Eyes. For details how to retrieve your API key, see the Applitools documentation in the Eyes Knowledge Center.

Entering the API Key on Linux or a Mac

export APPLITOOLS_API_KEY=<your_key>
npm test

Entering the API Key on Windows

set APPLITOOLS_API_KEY=<your_key>
npx test

Entering the API Key programmatically

eyes.setApiKey('<your API key>')

Eyes server URL {#URL}

If the Eyes server is not deployed in https://eyes.applitools.com, you need to set the Server URL in the environment variable APPLITOOLS_SERVER_URL before running tests.

The server URL of your Applitools Eyes dashboard is in the format https://<MY_COMPANY>.applitools.com

Entering the server URL on Linux or a Mac

export APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>

Entering the server URL on Windows

set APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>

Further information

For further information, see: