@applitools/eyes-webdriverio

Applitools Eyes SDK for WebdriverIO

Installation

To install Eyes-WebdriverIO as a local development dependency in your test project:

npm install --save-dev @applitools/eyes-webdriverio

This command will add the @applitools/eyes-webdriverio package to your project's package.json file and install it in the node_modules directory.

Setting API Key and Server URL

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

• Applitools API key
• Eyes server URL - Only required 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, set the environment variable APPLITOOLS_API_KEY to the API key provided by Applitools Eyes. For details on how to retrieve your API key, see the Applitools documentation.

To set the API Key on Linux or macOS:

export APPLITOOLS_API_KEY=<API_key>

To set the API Key on Windows:

set APPLITOOLS_API_KEY=<API_key>

Eyes Server URL {#URL}

If the Eyes server is not deployed at https://eyes.applitools.com, set the server URL in the environment variable APPLITOOLS_SERVER_URL.

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

To set the server URL on Linux or macOS:

export APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>

To set the server URL on Windows:

set APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>

Further information

For further information, see:

• Quickstart
• Overview
• Changelog