# @applitools/eyes-playwright

> Applitools Eyes SDK for Playwright

Latest version **1.50.1** (published 2026-10-14) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install @applitools/eyes-playwright
pnpm add @applitools/eyes-playwright
yarn add @applitools/eyes-playwright
bun add @applitools/eyes-playwright
```

Provides the command `eyes-setup`.

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.50.1 |
| Published | 2026-10-14 |
| First published | 2020-08-05 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12.13.0 |
| Dependencies | 9 |
| Unpacked size | 1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Applitools Team |
| Maintainers | danielputerman, gearm, amit.rokach, roy.sela, applitools-admin, applitools-readonly, iasisapp, noam.mendel, arik-applitools, yotammadem, denis.styrt, kyrylo.onufriiev, ormeda, clementbarry, idosapplitools, gofilord, alex.burdeynyy, ronikar_applitools, benny.halberstadt, grayscale64, fatihsolhan-applitools, itaiz134, dockermaster, anandbagmar, itaytamir-at, sergovapplitools, fluxomni.io, mmilapp, noam.gaash, roeefr, anastasia.koifman, aretm_borodavka, yonittzairilevy, asundaram-applitools, amir.groisman, emasuary, naama.shoham, adamcarmi, mulygottlieb, yoavnaveh-applitools, chaimaharonson, movsho, netta.bondy, shirbin, ranhadar, dmytro-h, rostyslav.pidburachynskyi.applitools, taltool |
| Keywords | eyes-playwright, applitools, eyes, test automation, visual regression, automation, testing, tests, playwright |

## Links

- npm: https://www.npmjs.com/package/@applitools/eyes-playwright
- Homepage: https://applitools.com/tutorials/sdks/playwright-ts-standard
- npm.io page: https://npm.io/package/@applitools/eyes-playwright

## Dependencies (9)

- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [yargs](https://npm.io/package/yargs.md) 17.7.2
- [@applitools/req](https://npm.io/package/@applitools/req.md) 1.11.5
- [@applitools/eyes](https://npm.io/package/@applitools/eyes.md) 1.47.1
- [@applitools/utils](https://npm.io/package/@applitools/utils.md) 1.15.3
- [@inquirer/prompts](https://npm.io/package/@inquirer/prompts.md) 7.0.1
- [@applitools/logger](https://npm.io/package/@applitools/logger.md) 2.3.2
- [@applitools/core-nlp](https://npm.io/package/@applitools/core-nlp.md) 0.2.1
- [@applitools/spec-driver-playwright](https://npm.io/package/@applitools/spec-driver-playwright.md) 1.9.13

## Alternatives

- [@snazzah/davey](https://npm.io/package/@snazzah/davey.md) — 1.5M weekly downloads
- [@vendure/testing](https://npm.io/package/@vendure/testing.md) — 8.3K weekly downloads
- [vue-simple-context-menu](https://npm.io/package/vue-simple-context-menu.md) — 6.6K weekly downloads
- [cypress-webpack-preprocessor-v5](https://npm.io/package/cypress-webpack-preprocessor-v5.md) — 2.1K weekly downloads
- [@backstage/plugin-catalog-backend-module-puppetdb](https://npm.io/package/@backstage/plugin-catalog-backend-module-puppetdb.md) — 1.3K weekly downloads

## Recent versions

- 1.50.1 (latest) — 2026-10-14
- 1.31.0 (beta) — 2024-11-11
- 1.50.0 — 2026-10-13
- 1.49.4 — 2026-10-01
- 1.49.3 — 2026-09-28
- 1.49.2 — 2026-09-23
- 1.49.1 — 2026-09-17
- 1.49.0 — 2026-09-15
- 1.48.5 — 2026-09-14
- 1.48.4 — 2026-08-31
- 1.48.3 — 2026-08-23
- 1.48.2 — 2026-08-19
- 1.48.1 — 2026-08-10
- 1.48.0 — 2026-08-05
- 1.47.15 — 2026-07-30
- … 198 more at https://npm.io/package/@applitools/eyes-playwright/versions

## README

## Applitools Eyes SDK for Playwright

## Installation

### Install playwright
If you don't already have playwright installed, install with the following command. More info can be [found here](https://playwright.dev/docs/intro):

```bash
npm init playwright@latest
```

### Install the Eyes SDK

In your project directory, install the Applitools Eyes SDK for Playwright:

```bash
npm install -D @applitools/eyes-playwright
```

### Run the interactive CLI setup

To configure your project for Applitools Eyes, run the setup tool:

```bash
npx eyes-setup
``` 

The CLI will:

- Configure your project for Applitools Eyes.
- Attempt to modify imports where possible.
- Add configuration settings to your `playwright.config.ts` file.
- Add a demo test to help you get started.
    - You can run the demo test with `npx eyes-setup run-example`

_Note: In cases where imports cannot be modified automatically (e.g., when importing the `test` object from another npm package), you may need to adjust them manually. More details are provided in the [Integration with Playwright](https://applitools.com/tutorials/playwright/integration-with-playwright) section._


:::info
You may be prompted to enter your Eyes Server URL. If you are using the Applitools public cloud, your server URL will be `https://eyes.applitools.com`. If you're using a private deployment, enter your account's server URL instead.
:::

### Set your Applitools API key

When prompted by the CLI, enter your Applitools API key. If you don't have one, you can sign up for a free account and obtain your API key [from the Applitools Dashboard](https://applitools.com/tutorials/playwright/applitools-dashboard#accessing-the-applitools-dashboard).

Alternatively, you can set the API key as an environment variable:

```bash
export APPLITOOLS_API_KEY='your_api_key_here'
```

It's advisable to set your API key as an environment variable `APPLITOOLS_API_KEY` instead of hardcoding it in your configuration file. This approach keeps your API key secure since configuration files are often checked into version control systems.


## Further information

For further information, see:

### Playwright with Fixtures

* [Quickstart](https://applitools.com/tutorials/playwright)
* [Overview](https://applitools.com/tutorials/playwright/api/overview)
* [Changelog](https://applitools.com/tutorials/playwright/api/changelog)

### Playwright Standard

* [Quickstart](https://applitools.com/tutorials/sdks/playwright-ts-standard/quickstart)
* [Overview](https://applitools.com/tutorials/sdks/playwright-ts-standard)
* [Changelog](https://applitools.com/tutorials/sdks/playwright-ts-standard/changelog)

---
_Source: https://npm.io/package/@applitools/eyes-playwright · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._