Skip to main content

Puppeteer JavaScript overview

Applitools Eyes SDK for Puppeteer.

For information about installing and configuring this SDK, see Testing web apps in JavaScript using Puppeteer on the Applitools Tutorial site.


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:

Entering the Applitools API key

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

If the Eyes server is not deployed in, 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>

Entering the server URL on Linux or a Mac


Entering the server URL on Windows


A test in Applitools Eyes always starts with a call and ends with eyes.close. The steps in the test are calls to eyes.check between and eyes.close calls.

A test is structured as following:
[step 1]
[step 2]

Using the Puppeteer SDK

After defining the API key, you will be able to use commands from eyes-puppeteer in your tests to take screenshots and use Applitools Eyes to manage them.


const {Eyes, Target} = require('@applitools/eyes-puppeteer')

(async () => {
const browser = await puppeteer.firefox.launch();
const context = await browser.newContext();
const page = await context.newPage();
await page.goto('');

const eyes = new Eyes();
await, " website", "My first Puppeteer test!")
await eyes.check('home page', Target.window().fully())
await eyes.closeAsync()

Common methods

Eyes constructor

Creates an instance of Eyes, which then exposes methods to run and configure visual tests.

const eyes = new Eyes(runner)
  • runner - A runner instance which manages tests across multiple Eyes instances. The runner can be an instance of either a ClassicRunenr or a VisualGridRunner. For more information, see the Runners section below.


Creates an Applitools test. This will start a session with the Applitools server., appName, testName, viewportSize)

Visual tests and baselines

By using the open, check, and close methods on Eyes, you are creating visual tests in Applitools Eyes. A visual test is a sequence of screenshots, compared with a baseline. The baseline is also a sequence of screenshots. The specific baseline to compare against is found by using the values for:

  • Browser
  • Operating system
  • App name
  • Test name
  • Viewport size

The baseline is created automatically when running a test with specific values for these parameters for the first time. For example, you run a test with Chrome on OS X and specify the app name, test name and viewport size via, 'some app', 'some test', {width: 1200, height: 800}). The first time the test runs with these parameters, a baseline will be created. Any subsequent execution with the same values will compare screenshots against this baseline. The test will actually be created after running eyes.close, and the results of the test are returned as a TestResults object.

For more information, see How Eyes compares checkpoints and baseline images in the Eyes Knowledge Center.


It's possible to aggregate tests that are run in different processes, or in different Eyes instances, under the same batch. This is done by providing the same batch ID to these tests.

For instructions, see the Organize tests in batches.

For more information, see How to organize your tests with batches in the Eyes Knowledge Center.


Generates a screenshot of the current page and add it to the Applitools Test.



Closes the Eyes test and check that all screenshots are valid.

It is important to call this at the end of each test, symmetrically to open(or in afterEach().

const testResults = await eyes.closeAsync(throwEx)
  • throwEx - (Boolean) throw an error if visual differences were found, or if the test failed for any other reason. The deault is true.

Return value: TestResults.


Used to manage multiple Eyes sessions. There are the following types of runners:

  • ClassicRunner - Used when the screenshot is taken by the SDK itself.

  • VisualGridRunner - Used when the screenshot is taken by the Ultrafast Grid.

For details, see Runners