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
  • Cypress preprocessor for extracting tests from Markdown files.

    #markdown
  • Cypress preprocessor for bundling JavaScript via rollup.

    #rollup
  • Bundle Cypress specs using esbuild.

    #esbuild
  • cypress-vite

    community

    Cypress preproccessor for running specs using vite.

    #vite
  • Cytorus

    deprecated

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

    #gherkin #cucumber
  • Reruns Cypress tests when the back end server restarts.

    #file-watcher
  • Runs linting via ESLint on your spec files as they are loaded and display errors in the console.

    #eslint
  • Rollup

    deprecated

    Watches and bundles your spec files via Rollup.

    #rollup
  • Uses evanw/esbuild to bundle your specs.

    #esbuild

Development Tools

  • Docker

    official

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

    #docker #continuous-integration
  • ESLint plugin that sets globals for writing tests in Cypress.

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

    #continuous-integration #circleci
  • 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
  • Plugin to save code coverage collected during Cypress tests.

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

    #recording #chrome #automation #devtools
  • Official Cypress extension for Chrome DevTools that allows you to export Cypress tests directly from the Recorder panel.

    #recording #chrome #extension #devtools
  • Filter tests using its title or tags.

    #grep
  • TypeScript

    official

    Official TypeScript definitions for the Cypress API.

    #typescript
  • Alternative themes for the Cypress Test Runner.

    #theme #dark #light #colorblind
  • Cypress plugin to announce spec result and time in Cypress Test Runner.

    #auditory #ui #results #duration
  • A companion Cypress plugin for `cy-grep` that re-runs the last failed test(s).

    #grep #ui #failure #results
  • cly

    community

    A prototype of generating quicker project scaffolding for Cypress.

    #cypress cli #prototype #CLI #scaffolding
  • Reloads Cypress when one of the watched files changes.

    #file-watcher
  • Visual Studio Code extension for cypress and cucumber preprocessor.

    #vscode #extension #intellisense
  • Generate HTTP Archive (HAR) while running tests.

    #har #http-archive #http #websocket #recording #chrome
  • 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
  • Restarts tests when receiving webpack-dev-server HMR updates.

    #webpack #webpack-dev-server #hmr
  • Controls permissions for desktop notifications, geolocation, and other browser APIs

    #permissions #notifications #geolocation #camera #microphone
  • Run Cypress multiple times in a row, great at finding test flake.

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

    #cli
  • 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
  • Easily mock your REST API in Cypress by putting responses in the fixtures directory tree.

    #mock #rest #api
  • Measure duration of commands and different stages of cypress lifecycle. Log to terminal.

    #duration #timings #commands #performance #measurement #metrics #total
  • A Cypress plugin for reporting individual command timings.

    #commands #performance
  • Enables fail fast in Cypress, skipping the rest of tests on first failure.

    #fail-fast #failure #skip #config
  • Fail cypress test on console error.

    #console #error #fail
  • Fail cypress test on network error.

    #network #error #fail
  • A Cypress plugin which automatically adds and enables IntelliSense for custom commands

    #commands #development #codegen
  • A Cypress plugin to apply different timeout strategies to retried tests

    #retries #backoff
  • A Cypress plugin that enables faker functions in json fixture files.

    #fixture #faker
  • cypress-solid

    community

    A Cypress plugin to help you test applications using the Solid Protocol.

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

    #coverage
  • cypress-dark

    deprecated

    Several color themes for Cypress test runner.

    #theme
  • Encode a fixture with Protocol Buffers.

    #encoding #protobuf
  • 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
  • Alleviates the need to mantain brittle manual mocks by automating the recording and stubbing of requests.

    #mocking #stubbing #recording #fetch #xhr
  • User space solution for grepping Cypress tests to run.

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

    #mock #recording #http #integration test
  • @cypress/fiddle

    deprecated

    Quickly generates Cypress E2E tests from HTML and JS code.

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

    #config
  • Browserify

    deprecated

    Watches and bundles your spec files via browserify.

    #browserify

Custom Commands

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

  • Puppeteer

    official

    Utilize Puppeteer's browser API with one command within Cypress.

    #puppeteer #multi-tab
  • 🐅 Simple and complete custom Cypress commands and utilities that encourage good testing practices.

    #testing-library #dom-testing-library #react-testing-library
  • Add the Cypress waiting power to virtually everything 🎉

    #commands #wait #wait-until #recursive-promise #check-async-value #check-value #open-source-saturday
  • Helper utility for annotating your tests with steps. Adds cy.step() and cy.section() commands

    #step #section #readability
  • Hides and reveals XHR events in Cypress GUI

    #utility #UI #api #xhr
  • 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-axe

    community

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

    #accessibility #a11y
  • Adds a cypress child command for drag'n'drop support.

    #dragndrop #drag #drop #commands
  • A Cypress command for fill inputs.

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

    #firebase #database #commands
  • Custom commands to stub, spy, or test GraphQL operations.

    #graphql #mocking #networking #commands
  • 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
  • Mobile testing helper for Cypress.

    #mobile #swipe #touch #commands
  • A custom command to download different kinds of files and store them on your local machine

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

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

    #commands #wait #wait-until #recursive-promise #check-async-value #check-value
  • data-cy shorthand notation for cypress get and find functions.

    #commands #shorthand
  • Easy way to publish messages from and to your SignalR hubs in Cypress E2E tests.

    #commands #signalr #mock #websocket
  • Cypress custom command "cy.api" for HTTP API testing with server logs.

    #api
  • Custom commands for localStorage. Allows preserving localStorage between tests.

    #commands #localstorage #persistence
  • Custom commands for indexedDb. Allows populating, modifying and asserting data stored in indexedDb.

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

    #react #commands #locator
  • A simple utility to provide layout testing functionality to Cypress via custom assertions.

    #testing #ui #dom #assertions
  • cy-dom-diff allows matching chunks of DOM against HTML; including dynamic content.

    #dom #assertions
  • Fire native system events from Cypress like hover, swipe, etc.

    #commands
  • Cypress custom command to get keys from Azure Key Vaults.

    #testing #azure #keyvault #secret
  • 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
  • Plugin that allows interaction with MongoDB server using Cypress commands.

    #testing #commands #mongodb #mongo #database #db
  • cy-spok

    community

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

    #assertions
  • A Cypress plugin to add a tab command.

    #commands
  • Click multiple times in Cypress.

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

    #snapshot #comparison #commands
  • Load .env variables in Cypress.

    #testing #commands #.env #environment variables
  • Work with Cypress' Intercept multipart/form-data requests

    #testing #commands #intercept #form-data #request
  • cypress-unfetch

    deprecated

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

    #commands #routing #networking
  • cypress-redux

    deprecated

    Run assertions against Redux stores.

    #commands #redux
  • cypress-pipe

    deprecated

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

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

    #stripe #commands #elements #inputs
  • Simple commands to skip a test based on platform, browser or a url.

    #commands
  • Test WebSocket connections with Cypress

    #commands #websocket
  • cypress-iframe

    deprecated

    Custom commands for interacting with iframes.

    #commands #iframe
  • Add visual output and helper functions for performing REST and graphQL queries.

    #api #rest #graphQL
  • cypress-dotenv

    deprecated

    Cypress plugin that enables compatibility with dotenv.

    #dotenv #env #environment #env var
  • cypress-xpath

    deprecated

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

    #xpath #commands

Extending other testing frameworks

  • 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
  • Simple commands to generate Pact contracts from your existing Cypress tests, maintained by the Pactflow team.

    #pact #pactflow #contract testing #commands
  • Several Capybara finders re-implemented in Cypress to locate UI elements by their text and labels.

    #testing-library #capybara
  • Add jest assertion style to Cypress expect command.

    #jest

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.

  • NTLM authentication support for Cypress.

    #authentication #ntlm
  • Cypress authentication flows using social network providers.

    #authentication #login #social profiles #github #google
  • Cypress commands for authenticate users with Keycloak Identity Provider.

    #authentication #login #keycloak #oauth #openid
  • cypress-otp

    deprecated

    Valid OTP token generation for Cypress.

    #authentication #otp #2fa #mfa

Framework tooling

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

    #angular #cli
  • 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
  • Aurelia CLI

    community

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

    #aurelia #cli
  • Complete WordPress Plugin Boilerplate including Cypress.io E2E tests.

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

    #next.js #react #monorepo #multi-tenants
  • cypress-rails

    community

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

    #ruby #rails
  • Vue CLI

    deprecated

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

    #vue.js #vue #cli
  • A project template to learn how Elm, Parcel, Cypress and Netlify work together.

    #elm #parcel #netlify
  • cypress-laravel

    deprecated

    Add commands and hooks to test Laravel applications.

    #php #laravel
  • cypress-splitio

    deprecated

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

    #split.io #feature flags

Component Testing

Loading and mounting components from various frameworks.

  • 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
  • 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
  • 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
  • Test Angular component using Cypress Test Runner.

    #component #angular
  • Simplified API for creating custom dev servers for Cypress.

    #component #buildtool #devserver
  • Build Cypress Component Tests using esbuild.

    #component #esbuild #devserver
  • Build Cypress Component Tests using Rspack.

    #component #Rspack #dev-server
  • Cypress Nuxt

    deprecated

    Utilities for using Cypress with Nuxt.

    #vue.js #vue #nuxt #nuxt.js
  • Unit test Angularjs code using Cypress Test Runner.

    #component #angular.js
  • Test Cycle.js components using Cypress Test Runner.

    #component #cycle.js
  • Test Hyperapp components and applications using Cypress Test Runner.

    #component #hyperapp
  • Test Svelte components using Cypress Test Runner.

    #component #svelte

Visual Testing

Visual testing is a great complement to functional testing.

  • 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
  • Pixeleye

    community

    Open-source, multi-browser visual review and testing platform.

    #open-source #screenshots #visual regression #multi-browser
  • Happo

    community

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

    #screenshots #visual regression
  • Catch visual regressions and compare image diffs locally and in Cypress Cloud.

    #image-diff #snapshot
  • Adds visual regression testing to Cypress.

    #image-diff #snapshot
  • 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
  • Integration with open source service for visual testing and managing its results.

    #screenshots #image-diff #visual regression
  • Visual regression testing plugin maintained by DIT - UK Gov.

    #screenshots #visual regression #image-diff
  • 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
  • Micoo

    community

    Cypress plugin for doing visual regression testing with Micoo services

    #visual regression testing #visual testing #screenshots comparison #testing service
  • Plugin for snapshot tests in Cypress. Same API as Jest, but with graphical interface for reviewing and approving changes.

    #snapshot

Reporting

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

    #reporter
  • Logs to terminal and files mimicking cypress UI. Logs all cypress commands, request/response data and browser console logs.

    #reporter #logs #terminal #CI #CLI
  • TestRail Reporter which auto-set status for specific TestRun for Cypress.

    #testrail #reporter #autoset #status
  • Custom reporter for publishing Cypress results to a TestRail test run.

    #testrail #reporter
  • 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
  • Slack reporting tool. Uses mochawesome json reports, provides links to VCS Provider (github/bitbucket) and CircleCI logs.

    #reporter #mochawesome #slack
  • Merges multiple mochawesome JSON reports.

    #reporter #mochawesome
  • Zero config Mochawesome reporter for Cypress with screenshots.

    #reporter #mochawesome #screenshot
  • Allure reporter for Cypress. Creates rich HTML test reports with screenshots, steps and more.

    #reporter #allure #step #screenshot
  • A reporting tool which sends a message to Microsoft Teams with information about the latest cypress test execution results.

    #reporter #ms-teams #allure-report
  • Plugin that prints all browser console logs to the terminal while running Cypress tests. Currently, only Chrome is supported.

    #logging

Email

  • Test email and SMS messages using Mailosaur.

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

    #email #sms #commands
  • Use test email accounts to send and receive emails in Cypress tests with MailSlurp.

    #email #mailslurp #test #commands
  • A collection of useful Cypress commands for testing Emails utilizing the MailHog RestAPI. Comes with TypeScript support.

    #email #mailhog #test #commands
  • Create and use a randomly-generated email address from Guerrilla Mail.

    #email #guerrillamail #test #commands
  • Lightweight npm library designed to generate temporary email addresses for end-to-end testing with Cypress

    #cypress-temp-mail #email #temp-mail #test #commands
  • cymap

    community

    Access email from any email server by leveraging IMAP capabilities inside Cypress.

    #imap #email #test #commands

SMS

  • Generates temporary mobile numbers that shall be used for SMS verification (OTP,2FA)

    #cypress-temp-sms #sms #temp-number #otp #2fa #commands