## Applitools Eyes SDK for [WebdriverIO](https://webdriver.io/)

## Installation

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

```shell
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](#API)
* [Eyes server URL](#URL) - Only required if the Eyes server is not deployed on the Eyes public server.

### Entering the Applitools API Key

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](https://applitools.com/tutorials/getting-started/retrieve-api-key).

To set the API Key on Linux or macOS:

```bash
export APPLITOOLS_API_KEY=<API_key>
```

To set the API Key on Windows:

```bash
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:

```bash
export APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>
```

To set the server URL on Windows:

```bash
set APPLITOOLS_SERVER_URL=<YOUR_SERVER_URL>
```



## Further information

For further information, see:

* [Quickstart](https://applitools.com/tutorials/sdks/webdriverio/quickstart)
* [Overview](https://applitools.com/tutorials/sdks/webdriverio)
* [Changelog](https://applitools.com/tutorials/sdks/webdriverio/changelog)