@clerk/testing/README.md

Utilities to help you create E2E test suites for apps using Clerk

<p align="center">
  <a href="https://clerk.com?utm_source=github&utm_medium=clerk_testing" target="_blank" rel="noopener noreferrer">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://images.clerk.com/static/logo-dark-mode-400x400.png">
      <img src="https://images.clerk.com/static/logo-light-mode-400x400.png" height="64">
    </picture>
  </a>
  <br />
  <h1 align="center">@clerk/testing</h1>
</p>

<div align="center">

[![Chat on Discord](https://img.shields.io/discord/856971667393609759.svg?logo=discord)](https://clerk.com/discord)
[![Clerk documentation](https://img.shields.io/badge/documentation-clerk-green.svg)](https://clerk.com/docs?utm_source=github&utm_medium=clerk_testing)
[![Follow on Twitter](https://img.shields.io/twitter/follow/ClerkDev?style=social)](https://twitter.com/intent/follow?screen_name=ClerkDev)

[Changelog](https://github.com/clerk/javascript/blob/main/packages/testing/CHANGELOG.md)
·
[Report a Bug](https://github.com/clerk/javascript/issues/new?assignees=&labels=needs-triage&projects=&template=BUG_REPORT.yml)
·
[Request a Feature](https://feedback.clerk.com/roadmap)
·
[Get help](https://clerk.com/contact/support?utm_source=github&utm_medium=clerk_testing)

</div>

## Getting started

This package provides utilities for testing Clerk applications.

It currently supports the following testing frameworks:

- [Playwright](https://playwright.dev/), a Node.js library to automate browsers and web pages.
- [Cypress](https://www.cypress.io/), a JavaScript-based end-to-end testing framework.

### Prerequisites

- Node.js `>=18.17.0` or later
- Playwright v1+ or Cypress v13.x or 14.x

### Installation

```shell
npm install @clerk/testing --save-dev
```

## Usage

Learn how to use `@clerk/testing` with different frameworks:

- [Testing with Playwright](https://clerk.com/docs/testing/playwright?utm_source=github&utm_medium=clerk_testing)
- [Testing with Cypress](https://clerk.com/docs/testing/cypress?utm_source=github&utm_medium=clerk_testing)

## Support

You can get in touch with us in any of the following ways:

- Join our official community [Discord server](https://clerk.com/discord)
- On [our support page](https://clerk.com/contact/support?utm_source=github&utm_medium=clerk_testing)

## Contributing

We're open to all community contributions! If you'd like to contribute in any way, please read [our contribution guidelines](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md) and [code of conduct](https://github.com/clerk/javascript/blob/main/docs/CODE_OF_CONDUCT.md).

## Security

`@clerk/testing` follows good practices of security, but 100% security cannot be assured.

`@clerk/testing` is provided **"as is"** without any **warranty**. Use at your own risk.

_For more information and to report security issues, please refer to our [security documentation](https://github.com/clerk/javascript/blob/main/docs/SECURITY.md)._

## License

This project is licensed under the **MIT license**.

See [LICENSE](https://github.com/clerk/javascript/blob/main/packages/testing/LICENSE) for more information.