Skip to main content

Plugins

Plugins provide a way to support and extend the behavior of Cypress. Follow these instructions to submit your own plugin.

info
Looking for the API docs?

Check out our Plugins Guide or our API docs for writing a plugin.

Preprocessors

A preprocessor is the plugin responsible for preparing a support file or a test file for the browser. By default, Cypress comes packaged with webpack preprocessor already installed. Read the Preprocessors API docs to learn more.

  • Webpack

    official

    Watches and bundles your spec files via webpack.

    #webpack

  • Watch

    official

    Watches your spec files and serves them as-is. Useful as an example reference or if you don't need transpiling/bundling.

    #file-watcher

  • Cucumber

    community

    Run cucumber/gherkin-syntaxed specs with cypress.io.

    #file-watcher #cucumber

  • Cytorus

    community

    Run cucumber/gherkin-syntaxed specs with cypress.io.

    #gherkin #cucumber

  • cypress-app-watcher-preprocessor

    community

    Reruns Cypress tests when the back end server restarts.

    #file-watcher

  • cypress-eslint-preprocessor

    community

    Runs linting via ESLint on your spec files as they are loaded and display errors in the console.

    #eslint

  • Rollup

    community

    Watches and bundles your spec files via Rollup.

    #rollup

  • cypress-markdown-preprocessor

    community

    Cypress preprocessor for extracting tests from Markdown files.

    #markdown

  • cypress-rollup-preprocessor

    community

    Cypress preprocessor for bundling JavaScript via rollup.

    #rollup

  • @bahmutov/cypress-esbuild-preprocessor

    community

    Bundle Cypress specs using esbuild.

    #esbuild

  • cypress-esbuild-preprocessor

    community

    Uses evanw/esbuild to bundle your specs.

    #esbuild

  • cypress-vite

    community

    Cypress preproccessor for running specs using vite.

    #vite

Development Tools

  • Docker

    official

    Docker images providing all the dependencies to run Cypress in CI including browsers.

    #docker #continuous-integration

  • eslint-plugin-cypress

    official

    ESLint plugin that sets globals for writing tests in Cypress.

    #eslint

  • CircleCI Cypress Orb

    official

    Cypress Orb for CircleCI configuration to correctly install, cache and run Cypress.io tests in CircleCI with very little effort.

    #continuous-integration #circleci

  • Cypress Github Actions

    official

    GitHub Action for running Cypress end-to-end and component tests. Includes npm, pnpm and Yarn installation, custom caching and lots of configuration options.

    #continuous-integration #github-actions

  • @cypress/code-coverage

    official

    Plugin to save code coverage collected during Cypress tests.

    #coverage

  • @cypress/instrument-cra

    official

    NPM module for create-react-app applications to instrument source code without ejecting react-scripts.

    #coverage

  • Cypress Chrome Recorder

    official

    Tool to export Cypress Tests from Google Chrome DevTools' Recordings programmatically.

    #recording #chrome #automation #devtools

  • Cypress Chrome Recorder Extension

    official

    Official Cypress extension for Chrome DevTools that allows you to export Cypress tests directly from the Recorder panel.

    #recording #chrome #extension #devtools

  • @cypress/grep

    official

    Filter tests using its title or tags.

    #grep

  • TypeScript

    official

    Official TypeScript definitions for the Cypress API.

    #typescript

  • cypress-dark

    verified

    Several color themes for Cypress test runner.

    #theme

  • cypress-protobuf

    community

    Encode a fixture with Protocol Buffers.

    #encoding #protobuf

  • Knapsack Pro Cypress

    community

    Dynamic tests split across parallel CI nodes with Knapsack Pro Queue Mode to get faster CI builds. Note - this is 3rd party implementation, different from Cypress Cloud parallelization.

    #CI parallelisation #continuous-integration

  • cly

    community

    A prototype of generating quicker project scaffolding for Cypress.

    #cypress cli #prototype #CLI #scaffolding

  • cypress-watch-and-reload

    community

    Reloads Cypress when one of the watched files changes.

    #file-watcher

  • cypress-autostub

    community

    Alleviates the need to mantain brittle manual mocks by automating the recording and stubbing of requests.

    #mocking #stubbing #recording #fetch #xhr

  • cypress-plugin-livereload

    community

    Reloads Cypress using livereload.

    #livereload

  • cypress-select-tests

    community

    User space solution for grepping Cypress tests to run.

    #browserify

  • cypress-autorecord

    community

    Simplify API mocking by auto-recording/stubbing HTTP interactions and automating the process of updating/deleting mocks.

    #mock #recording #http #integration test

  • @cypress/fiddle

    community

    Quickly generates Cypress E2E tests from HTML and JS code.

    #prototype

  • npm-cy

    community

    This GitHub Action for npm enables arbitrary actions with the npm command-line client, including testing with cypress.io and publishing to a registry.

    #github #actions #npm

  • vscode-cy-helper

    community

    Visual Studio Code extension for cypress and cucumber preprocessor.

    #vscode #extension #intellisense

  • cypress-har-generator

    community

    Generate HTTP Archive (HAR) while running tests.

    #har #http-archive #http #websocket #recording #chrome

  • cypress-expect-n-assertions

    community

    Cypress helper that checks number of expected and actual assertions in the test.

    #test #assertion

  • cypress-audit

    community

    Run Lighthouse audit directly in your E2E test suites.

    #lighthouse

  • cypress-hmr-restarter

    community

    Restarts tests when receiving webpack-dev-server HMR updates.

    #webpack #webpack-dev-server #hmr

  • @bahmutov/cypress-extends

    community

    Cypress plugin that adds "extends" support to the configuration file.

    #config

  • cypress-browser-permissions

    community

    Controls permissions for desktop notifications, geolocation, and other browser APIs

    #permissions #notifications #geolocation #camera #microphone

  • cypress-repeat

    community

    Run Cypress multiple times in a row, great at finding test flake.

  • cypress-expect

    community

    Cypress CLI wrapper where you can specify the total number of expected tests.

    #cli

  • cypress-log-filter

    community

    Easily filter Cypress command logs based on different log levels

    #log #command #filter

  • cy-search

    community

    Search Cypress documentation from the terminal.

    #cli

  • cypress-tags

    community

    Use custom tags to slice up Cypress test runs.

    #test #tag #browserify

  • @swimlane/cy-mockapi

    community

    Easily mock your REST API in Cypress by putting responses in the fixtures directory tree.

    #mock #rest #api

  • cypress-duration-metrics

    community

    Measure duration of commands and different stages of cypress lifecycle. Log to terminal.

    #duration #timings #commands #performance #measurement #metrics #total

  • cypress-timings

    community

    A Cypress plugin for reporting individual command timings.

    #commands #performance

  • cypress-fail-fast

    community

    Enables fail fast in Cypress, skipping the rest of tests on first failure.

    #fail-fast #failure #skip #config

  • cypress-fail-on-console-error

    community

    Fail cypress test on console error.

    #console #error #fail

  • cypress-codegen

    community

    A Cypress plugin which automatically adds and enables IntelliSense for custom commands

    #commands #development #codegen

  • cypress-backoff

    community

    A Cypress plugin to apply different timeout strategies to retried tests

    #retries #backoff

  • cypress-fixture-faker

    community

    A Cypress plugin that enables faker functions in json fixture files.

    #fixture #faker

Custom Commands

Read the Custom Commands and Custom Query documentation to learn more.

  • cypress-testing-library

    verified

    🐅 Simple and complete custom Cypress commands and utilities that encourage good testing practices.

    #testing-library #dom-testing-library #react-testing-library

  • cypress-unfetch

    verified

    Track, test, and block code execution based on network state.

    #commands #routing #networking

  • cypress-wait-until

    verified

    Add the Cypress waiting power to virtually everything 🎉

    #commands #wait #wait-until #recursive-promise #check-async-value #check-value #open-source-saturday

  • cypress-plugin-steps

    community

    Helper utility for annotating your tests with steps. Adds cy.step() and cy.section() commands

    #step #section #readability

  • cypress-plugin-xhr-toggle

    community

    Hides and reveals XHR events in Cypress GUI

    #utility #UI #api #xhr

  • cypress-plugin-api

    community

    Cypress plugin for effective API testing. Imagine Postman, but in Cypress.

    #api

  • cy-view

    community

    Run tests on multiple URLs at various viewport sizes.

    #viewports

  • cypress-redux

    community

    Run assertions against Redux stores.

    #commands #redux

  • cypress-axe

    community

    Helps test your applications for accessibility issues using axe-core.

    #accessibility #a11y

  • cypress-drag-drop

    community

    Adds a cypress child command for drag'n'drop support.

    #dragndrop #drag #drop #commands

  • cypress-fill-command

    community

    A Cypress command for fill inputs.

    #commands

  • cypress-firebase

    community

    Custom commands for Firebase including Authentication and Database communication (both Real Time Database and Firestore).

    #firebase #database #commands

  • cypress-graphql

    community

    Custom commands to stub, spy, or test GraphQL operations.

    #graphql #mocking #networking #commands

  • cypress-graphql-mock-network

    community

    Custom commands to mock your GraphQL API at the network level. Using service-workers for complete isolation of the mock server.

    #graphql #mocking #networking #commands

  • cypress-graphql-mock

    community

    Adds commands for executing a mocked GraphQL server using only the client.

    #graphql

  • cy-mobile-commands

    community

    Mobile testing helper for Cypress.

    #mobile #swipe #touch #commands

  • cypress-pipe

    community

    Create custom commands using plain-old functions. Similar to `cy.then` but with retriability.

    #commands

  • cypress-downloadfile

    community

    A custom command to download different kinds of files and store them on your local machine

    #commands #downloading

  • cypress-plugin-stripe-elements

    community

    Simple commands that make it easy to target and fill in Stripe Elements input fields

    #stripe #commands #elements #inputs

  • cypressautomocker

    community

    Allow recording API results and replaying the APIs as a mock server.

    #routing #mock

  • cypress-commands

    community

    A collection of Cypress commands to extend and complement the defaults.

    #commands

  • cypress-recurse

    community

    A way to re-run Cypress commands until a predicate function returns true.

    #commands #wait #wait-until #recursive-promise #check-async-value #check-value

  • cypress-cy-select

    community

    data-cy shorthand notation for cypress get and find functions.

    #commands #shorthand

  • @cypress/skip-test

    community

    Simple commands to skip a test based on platform, browser or a url.

    #commands

  • Cypress-SignalR-Mock

    community

    Easy way to publish messages from and to your SignalR hubs in Cypress E2E tests.

    #commands #signalr #mock #websocket

  • cypress-websocket-testing

    community

    Test WebSocket connections with Cypress

    #commands #websocket

  • @bahmutov/cy-api

    community

    Cypress custom command "cy.api" for HTTP API testing with server logs.

    #api

  • cypress-localstorage-commands

    community

    Custom commands for localStorage. Allows preserving localStorage between tests.

    #commands #localstorage #persistence

  • @this-dot/cypress-indexeddb

    community

    Custom commands for indexedDb. Allows populating, modifying and asserting data stored in indexedDb.

    #commands #indexedDb

  • cypress-iframe

    community

    Custom commands for interacting with iframes.

    #commands #iframe

  • cypress-react-selector

    community

    cypress custom commands to locate react elements by component, props and state.

    #react #commands #locator

  • cypress-layout-inspector

    community

    A simple utility to provide layout testing functionality to Cypress via custom assertions.

    #testing #ui #dom #assertions

  • @swimlane/cy-dom-diff

    community

    cy-dom-diff allows matching chunks of DOM against HTML; including dynamic content.

    #dom #assertions

  • cypress-real-events

    community

    Fire native system events from Cypress like hover, swipe, etc.

    #commands

  • cypress-azure-keyvault

    community

    Cypress custom command to get keys from Azure Key Vaults.

    #testing #azure #keyvault #secret

  • cypress-rest-graphql

    community

    Add visual output and helper functions for performing REST and graphQL queries.

    #api #rest #graphQL

  • cypress-forced-colors

    community

    Cypress commands to enable and disable browser forced colors mode.

    #forced colors #high contrast #high contrast mode #contrast #testing

  • cy-verify-downloads

    community

    Cypress custom command to wait and verify that file was downloaded.

    #commands #assertions #wait #verify #download

  • cypress-if

    community

    Easy conditional if-else logic for your Cypress tests.

    #commands

  • cypress-mongodb

    community

    Plugin that allows interaction with MongoDB server using Cypress commands.

    #testing #commands #mongodb #mongo #database #db

  • cy-spok

    experimental

    Adds assertions from Spok library for easy schema and value validations.

    #assertions

  • cypress-plugin-tab

    experimental

    A Cypress plugin to add a tab command.

    #commands

  • cypress-plugin-multiple-click

    community

    Click multiple times in Cypress.

    #testing #commands #click

  • @datashard/snapshot

    community

    Adds Snapshot command. Adds value / object / DOM element snapshot testing support to Cypress test runner

    #snapshot #comparison #commands

  • cypress-plugin-dotenv

    community

    Load .env variables in Cypress.

    #testing #commands #.env #environment variables

Extending other testing frameworks

  • cyphell

    community

    Converts WDIO automation tests to Cypress.

    #wdio

  • cypress-capybara

    community

    Several Capybara finders re-implemented in Cypress to locate UI elements by their text and labels.

    #testing-library #capybara

  • cypress-jest-adapter

    community

    Add jest assertion style to Cypress expect command.

    #jest

  • PickleJS

    community

    An addition to the Cucumber plugin, featuring a collection of phrases you can use for common actions (ex: "I click on an <Element>", "I should see an <Element>").

    #cucumber #collection #actions #commands

  • Pact Cypress Adapter

    community

    Simple commands to generate Pact contracts from your existing Cypress tests, maintained by the Pactflow team.

    #pact #pactflow #contract testing #commands

Authentication

Take a look at our auth guides for Amazon Cognito, Amazon Cognito, Auth0, Amazon Cognito, Google, Okta Cognito, and Social Logins. Also checkout our Logging in recipes.

  • cypress-keycloak-commands

    verified

    Cypress commands for authenticate users with Keycloak Identity Provider.

    #authentication #login #keycloak #oauth #openid

  • cypress-ntlm-auth

    verified

    NTLM authentication support for Cypress.

    #authentication #ntlm

  • cypress-otp

    community

    Valid OTP token generation for Cypress.

    #authentication #otp #2fa #mfa

  • cypress-social-logins

    community

    Cypress authentication flows using social network providers.

    #authentication #login #social profiles #github #google

Framework tooling

  • Cypress Schematic

    official

    Adds Cypress to your Angular project via the Angular CLI. Adopted by Cypress; originally released as @briebug/cypress-schematic.

    #angular #cli

  • Vue CLI

    verified

    Vue CLI allows you to scaffold an application with Cypress E2E fully configured.

    #vue.js #vue #cli

  • cypress-on-rails

    community

    Rubygem for using cypress.io with Ruby on Rails applications.

    #ruby-rack #ruby-on-rails

  • Nx

    community

    Smart, Fast and Extensible Build System.

    #angular #react #cli #monorepo

  • Cypress Nuxt

    community

    Utilities for using Cypress with Nuxt.

    #vue.js #vue #nuxt #nuxt.js

  • Aurelia CLI

    community

    The Aurelia CLI is the official command line tool for Aurelia.

    #aurelia #cli

  • WordPress ReactJS Boilerplate

    community

    Complete WordPress Plugin Boilerplate including Cypress.io E2E tests.

    #wp #wordpress

  • Next Right Now - Next.js Boilerplate

    community

    Next.js boilerplate with Jest/Cypress and CI/CD pipeline built-in (monorepo, multi-tenants).

    #next.js #react #monorepo #multi-tenants

  • Elm Batteries Included

    community

    A project template to learn how Elm, Parcel, Cypress and Netlify work together.

    #elm #parcel #netlify

  • cypress-rails

    community

    Ruby gem to run Cypress against Rails apps, replacing Capybara in system tests.

    #ruby #rails

  • cypress-laravel

    community

    Add commands and hooks to test Laravel applications.

    #php #laravel

  • cypress-splitio

    community

    Stores your split.io toggles as environment variables. Helps to decide which e2e tests you need to run.

    #split.io #feature flags

  • Bison

    community

    A Full Stack Jamstack Template that uses Cypress and GitHub Actions for E2E testing.

    #next.js #react #graphql #prisma #vercel

Component Testing

Loading and mounting components from various frameworks.

  • Cypress Angular

    official

    Test Angular components using Cypress Test Runner. This package is bundled with the cypress package and does not need to be installed separately, unless a specific version is desired. See the Angular Component Testing Docs for mounting Angular components.

    #component #angular

  • Cypress React

    official

    Test React components using Cypress Test Runner. This package is bundled with the cypress package and does not need to be installed separately, unless a specific version is desired. See the React Component Testing Docs for mounting React components.

    #component #react

  • Cypress Svelte

    official

    Test Svelte components using Cypress Test Runner. This package is bundled with the cypress package and should not need to be installed separately. See the Svelte Component Testing Docs for mounting Svelte components.

    #component #svelte

  • Cypress Vue

    official

    Test Vue 3 components using Cypress Test Runner. This package is bundled with the cypress package and should not need to be installed separately. See the Vue Component Testing Docs for mounting Vue components.

    #component #vue #vue.js

  • Cypress Vue2

    official

    Test Vue 2 components using Cypress Test Runner. This package is bundled with the cypress package and should not need to be installed separately. See the Vue Component Testing Docs for mounting Vue components.

    #component #vue #vue.js

  • cypress-angular-unit-test

    experimental

    Test Angular component using Cypress Test Runner.

    #component #angular

  • cypress-angularjs-unit-test

    experimental

    Unit test Angularjs code using Cypress Test Runner.

    #component #angular.js

  • cypress-cycle-unit-test

    experimental

    Test Cycle.js components using Cypress Test Runner.

    #component #cycle.js

  • cypress-hyperapp-unit-test

    experimental

    Test Hyperapp components and applications using Cypress Test Runner.

    #component #hyperapp

  • cypress-svelte-unit-test

    experimental

    Test Svelte components using Cypress Test Runner.

    #component #svelte

  • cypress-ct-custom-devserver

    community

    Simplified API for creating custom dev servers for Cypress.

    #component #buildtool #devserver

  • cypress-devserver-esbuild

    community

    Build Cypress Component Tests using esbuild.

    #component #esbuild #devserver

Visual Testing

Visual testing is a great complement to functional testing.

  • SmartBear VisualTest

    verified

    Visual regression testing for Cypress tests with SmartBear VisualTest.

    #visual-ai #fullpage #screenshots #visual regression #screenshots comparison

  • Argos

    verified

    Automate visual testing in your CI.

    #devX #screenshots

  • Applitools

    verified

    Fast, easy and reliable visual UI testing with Cypress.

  • Percy

    verified

    Visual regression testing for Cypress tests with Percy.

    #screenshots #visual regression

  • Happo

    community

    Cross-platform, cross-browser screenshot testing for modern user interfaces.

    #screenshots #visual regression

  • cypress-plugin-snapshots

    community

    Plugin for snapshot tests in Cypress. Same API as Jest, but with graphical interface for reviewing and approving changes.

    #snapshot

  • Cypress Image Snapshot

    community

    Catch visual regressions and compare image diffs locally and in Cypress Cloud.

    #image-diff #snapshot

  • Cypress Visual Regression

    community

    Adds visual regression testing to Cypress.

    #image-diff #snapshot

  • Cypress Visual Regression with Resemble.JS

    community

    A module for adding visual regression testing to Cypress, based on Cypress Visual Regression plugin and Resemble.JS library. The main difference between 'Cypress Visual Regression' plugin and this one is that the present plugin mitigates the anti-aliasing problem. The problem appears when comparing the base and actual screenshots generated on different environments (e.g. Windows vs Linux).

    #image-diff #snapshot

  • cypress-blink-test

    community

    Module for adding visual regression testing to Cypress.

    #image-diff #snapshot

  • Visual Regression Tracker

    community

    Integration with open source service for visual testing and managing its results.

    #screenshots #image-diff #visual regression

  • Cypress Image Diff

    community

    Visual regression testing plugin maintained by DIT - UK Gov.

    #screenshots #visual regression #image-diff

  • Micoo

    community

    Cypress plugin for doing visual regression testing with Micoo services

    #visual regression testing #visual testing #screenshots comparison #testing service

  • Visual Regression Diff

    community

    Perform visual regression test with a nice GUI as help. 💅 Supports both E2E and Component Testings

    #screenshots #visual regression #visual testing #image-diff #image comparison #image snapshot

Reporting

  • cypress-failed-log

    community

    Saves the Cypress test command log as a JSON file if a test fails.

    #reporter

  • cypress-log-to-output

    community

    Plugin that prints all browser console logs to the terminal while running Cypress tests. Currently, only Chrome is supported.

    #logging

  • autoset-status-cypress-testrail-reporter

    community

    TestRail Reporter which auto-set status for specific TestRun for Cypress.

    #testrail #reporter #autoset #status

  • cypress-testrail-reporter

    community

    Custom reporter for publishing Cypress results to a TestRail test run.

    #testrail #reporter

  • cypress-teamcity-reporter

    community

    Custom reporter for Teamcity which makes it possible to display test results in real-time and add them on the Tests tab of the Build Results page.

    #teamcity #reporter

  • mochawesome-merge

    community

    Merges multiple mochawesome JSON reports.

    #reporter #mochawesome

  • cypress-slack-healthcheck

    community

    A simple tool which integrates Cypress with Slack to report failing tests.

    #reporter #slack #healthcheck

  • cypress-slack-reporter

    community

    Slack reporting tool. Uses mochawesome json reports, provides links to VCS Provider (github/bitbucket) and CircleCI logs.

    #reporter #mochawesome #slack

  • cypress-terminal-report

    community

    Logs cypress commands, route request data and browser console errors and warnings to terminal when tests fail on CI.

    #reporter #logs #terminal #CI #CLI

  • cypress-allure-plugin

    community

    Integrates Allure reporter with Cypress. Command logging and screenshot attachment out of the box.

    #reporter #allure

  • cypress-mochawesome-reporter

    community

    Zero config Mochawesome reporter for Cypress with screenshots.

    #reporter #mochawesome #screenshot

  • cypress-msteams-reporter

    community

    A reporting tool which sends a message to Microsoft Teams with information about the latest cypress test execution results.

    #reporter #ms-teams #allure-report

Email

  • cypress-mailosaur

    community

    Test email and SMS messages using Mailosaur.

    #email #sms #commands

  • cypress-maildev

    community

    A bunch of Cypress commands in order to test your messages (SMS and Emails) by using Maildev REST API.

    #email #sms #commands

  • cypress-mailslurp

    community

    Use test email accounts to send and receive emails in Cypress tests with MailSlurp.

    #email #mailslurp #test #commands

  • cypress-mailhog

    community

    A collection of useful Cypress commands for testing Emails utilizing the MailHog RestAPI. Comes with TypeScript support.

    #email #mailhog #test #commands

  • cypress-guerrillamail

    community

    Create and use a randomly-generated email address from Guerrilla Mail.

    #email #guerrillamail #test #commands

Legacy

  • Browserify

    official

    Watches and bundles your spec files via browserify.

    #browserify

  • cypress-xpath

    official

    Adds XPath command. This repo is also a good example of using custom commands to do retries, provide TypeScript definitions, etc.

    #xpath #commands

  • cypress-dotenv

    community

    Cypress plugin that enables compatibility with dotenv.

    #dotenv #env #environment #env var