# @dotcom-tool-kit/cypress > Tool Kit plugin to run [Cypress](https://www.cypress.io) Latest version **6.1.0** (published 2026-03-17) · ISC license · 0 weekly downloads ## Install ```sh npm install @dotcom-tool-kit/cypress pnpm add @dotcom-tool-kit/cypress yarn add @dotcom-tool-kit/cypress bun add @dotcom-tool-kit/cypress ``` ## Health **Score 45/100 (D)** — status: stable. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. ## Facts | | | |---|---| | Version | 6.1.0 | | Published | 2026-03-17 | | First published | 2022-12-09 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Node | >=20.x | | Dependencies | 6 | | Unpacked size | 11.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | FT.com Platforms Team | | Maintainers | quarterto, the-ft, robertboulton | ## Links - npm: https://www.npmjs.com/package/@dotcom-tool-kit/cypress - Repository: https://github.com/financial-times/dotcom-tool-kit - Homepage: https://github.com/financial-times/dotcom-tool-kit/tree/main/plugins/cypress - Issues: https://github.com/financial-times/dotcom-tool-kit/issues - npm.io page: https://npm.io/package/@dotcom-tool-kit/cypress ## Dependencies (6) - [zod](https://npm.io/package/zod.md) ^3.24.4 - [@dotcom-tool-kit/base](https://npm.io/package/@dotcom-tool-kit/base.md) ^2.1.0 - [@dotcom-tool-kit/state](https://npm.io/package/@dotcom-tool-kit/state.md) ^5.0.0 - [@dotcom-tool-kit/logger](https://npm.io/package/@dotcom-tool-kit/logger.md) ^5.0.0 - [@dotcom-tool-kit/doppler](https://npm.io/package/@dotcom-tool-kit/doppler.md) ^3.0.0 - [@dotcom-tool-kit/package-json-hook](https://npm.io/package/@dotcom-tool-kit/package-json-hook.md) ^6.0.1 ## Recent versions - 6.1.0 (latest) — 2026-03-17 - 6.1.0-beta.1 (prerelease) — 2026-03-17 - 6.0.1 — 2026-01-15 - 6.0.1-beta.14 — 2026-01-15 - 6.0.1-beta.13 — 2026-01-15 - 6.0.1-beta.12 — 2026-01-15 - 6.0.1-beta.11 — 2026-01-14 - 6.0.1-beta.10 — 2026-01-13 - 6.0.1-beta.9 — 2026-01-13 - 6.0.1-beta.8 — 2026-01-13 - 6.0.1-beta.7 — 2026-01-13 - 6.0.1-beta.6 — 2026-01-13 - 6.0.1-beta.5 — 2026-01-12 - 6.0.1-beta.4 — 2026-01-12 - 6.0.1-beta.3 — 2026-01-12 - … 47 more at https://npm.io/package/@dotcom-tool-kit/cypress/versions ## README # @dotcom-tool-kit/cypress Tool Kit plugin to run [Cypress](https://www.cypress.io) ## Installation & usage With Tool Kit [already set up](https://github.com/financial-times/dotcom-tool-kit#installing-and-using-tool-kit), install this plugin as a dev dependency: ```sh npm install --save-dev @dotcom-tool-kit/cypress ``` And add it to your repo's `.toolkitrc.yml`: ```yml plugins: - '@dotcom-tool-kit/cypress' ``` ### Testing with Cypress locally > [!IMPORTANT] > Please check this documentation and make sure it's up to date with the way the Cypress plugin works now. For local development, by default the `CypressLocal` task runs on the `e2e:local` command. This command is also defined within the `cypress` plugin and will install itself into your `package.json` config as the script `e2e-local`. Therefore, to run Cypress on a local instance of your project you just need to call `npm run e2e-local`. Note that, by default, this task does __not__ run your application for you, so if that's controlled by Tool Kit it's recommended you add its task to the `e2e:local` command too. For example, your config could look like: ```yml plugins: - '@dotcom-tool-kit/cypress' - '@dotcom-tool-kit/node' command: 'e2e:local': - Node - Cypress ``` ### Testing with Cypress on CI The `CypressCI` task runs on the `test:review` and `test:staging` commands by default. These will run your Cypress end-to-end tests against the currently deployed review or staging app respectively. ### Running on another command You can also configure Cypress to run on any other command; for example, if you want to run it with `npm run test` via the `npm` plugin, you can manually configure Cypress to run on `npm`'s `test:local` command: ```yml plugins: - '@dotcom-tool-kit/cypress' - '@dotcom-tool-kit/node' - '@dotcom-tool-kit/npm' command: 'test:local': - Node - Cypress ``` ## Tasks ### `Cypress` Run Cypress end-to-end tests #### Task options | Property | Description | Type | | :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------- | | `url` | URL to run Cypress against. If running in an environment such as a review or staging app build that has Tool Kit state with a URL for an app to run against, that will override this option. | `string` | | `openMode` | Determines whether Cypress tests will run in [Open Mode](https://docs.cypress.io/app/core-concepts/open-mode). | `boolean` | _All properties are optional._ --- _Source: https://npm.io/package/@dotcom-tool-kit/cypress · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._