cypress README

The project's README from github.com/cypress-io/cypress. As one markdown file: README.md.

Cypress Logo

Documentation | Changelog | Roadmap

The web has evolved. Finally, testing has too.

Fast, easy and reliable testing for anything that runs in a browser.

Join us, we're hiring.

npm Discord chat StackShare

What is Cypress?

Why Cypress Video

Installing

npm version

Install Cypress for Mac, Linux, or Windows, then get started.

npm install cypress --save-dev

or

yarn add cypress --dev

or

pnpm add cypress --save-dev

installing-cli e1693232

Contributing

cypress CircleCI - develop branch

Please see our Contributing Guideline which explains repo organization, linting, testing, and other steps.

License

license

This project is licensed under the terms of the MIT license.

Badges

Configure a badge for your project's README to show your test status or test count in the Cypress Cloud.

cypress

cypress

Or let the world know your project is using Cypress with the badge below.

Cypress.io

[![Cypress.io](https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg)](https://www.cypress.io/)

cypress (cypress-io/cypress)

Searching Database…

What is this?Cypress is a JavaScript/TypeScript testing framework for anything that runs in a browser, built to make end-to-end and component testing fast, easy, and reliable.
Is this a standalone framework or just a wrapper around something like Selenium?It is a self-contained testing framework with its own test runner and GUI rather than a thin wrapper library; Cypress executes test code directly inside the browser alongside your application.
How do I install and run it?Install the Mac, Linux, or Windows build and get started from there; in a JS/TS project the typical path is adding it as an npm dev dependency and opening the test runner.
Do I need Node.js to build or run this?Yes, the repo is written in TypeScript and requires Node.js >=24.15.0 and Yarn >=1.22.22 to build and run.
Which operating systems does Cypress run on?It runs on Mac, Linux, and Windows.
What is Cypress Cloud?Cypress Cloud is a companion service that records your test runs so you can view results, get a test-status badge for your project, and access features like Test Replay.
Which component-testing frameworks does it support?It ships testing libraries for Angular, React, Svelte, and Vue, letting you mount and test individual components, not just full pages.
What is Test Replay?Test Replay is a Cypress Cloud feature that lets you step through a recorded test run as if it happened live, useful for debugging failures from CI without rerunning the suite locally.
What are similar projects?keploy, playwright, SeleniumBase, e2e, reticle, ava, nx, expect
Creator
cypress-io
Size
566.2 MB
Stars
51K
Age
11y
Commits · 90 Days