Welcome to Applitools Eyes!

You are just 4 steps away from adding automated
visual validation to your tests

Step 1

Select automation environment

Applitools Eyes supports a wide variety of popular web, mobile and desktop test automation
frameworks and we're constantly working on supporting additional ones. If your framework is not
listed below, you can still visually validate your app by obtaining screenshots yourself and using
one of the screenshot SDKs to validate them.

Step 2

Install the SDK

The Applitools Eyes Appium JavaScript SDK allows you to easily add visual checkpoints to your JavaScript
Appium tests. It takes care of getting screenshots of your application from the underlying WebDriver, sending
them to the Eyes server for validation and failing the test in case differences are found.

npm install eyes.selenium --save-dev

Step 3

Run your first test

Applitools Eyes reports differences by comparing screenshots of your application with baseline images that
define the expected appearance of the application at each step of the test. By default, the Eyes SDK detects the
environment in which the application is running (namely, the operating system, the type of browser and its
viewport size) and compares the screenshots against baseline images that are specific to that environment. The
first time you run a test in a given environment, its screenshots will be automatically saved as its baseline.
Starting from the second run onward, you always have a baseline to compare against.

The test below is a simple JavaScript program that visually validates the Hello World web-page at
https://applitools.com/helloworld.
It consists of two visual checkpoints, each validating the entire application
window. The first time you run this test a new baseline will be created, and subsequent test runs will be
compared to this baseline. If any screenshot mismatch its baseline image in a perceptible way,
eyes.close() will throw a DiffsFoundError
which includes a URL that points to a detailed report where you can see the detected differences and take
appropriate actions such as reporting bugs, updating the baseline and more.

Before running the test, make sure to set the API key that identifies your account in the environment variable
APPLITOOLS_API_KEY or directly assign it to the
eyes.setApiKey() method. You can find your API key under the user menu located at
the
right hand side of the test manager toolbar. If you don't yet have an account
create it now to obtain your key.

Step 4

Analyze your test results

Congratulations! You've successfully run your first visual UI test with Applitools Eyes! A detailed
report is ready for your inspection at the
Applitools Eyes test manager. Watch this 5 minute
video to get acquainted with the test manager and to learn the basics of baseline maintenance.

Step 5

Learn more

Applitools Eyes is powerful platform for automated visual UI testing that supports full page
screenshots, page layout matching, cross device and browser testing, test batching, baseline
branching and merging, automated baseline maintenance, collaboration features, and much more.
You can learn all about these features at the Applitools Eyes
documentation and the
resources page.