{ "doc": { "id": "app/continuous-integration/circleci", "title": "Run Cypress tests in CircleCI: A Step-by-Step Guide", "description": "Set up CircleCI to run Cypress tests with the Cypress Orb, cache dependencies and build artifacts, and parallelize Cypress tests.", "section": "app", "source_path": "/llm/markdown/app/continuous-integration/circleci.md", "version": "24a73f8a97175663aaffd3b016289fb2a523a4ea", "updated_at": "2026-05-14T20:17:33.301Z", "headings": [ { "id": "app/continuous-integration/circleci#run-cypress-in-circleci", "text": "Run Cypress in CircleCI", "level": 1 }, { "id": "app/continuous-integration/circleci#what-youll-learn", "text": "What you'll learn", "level": 5 }, { "id": "app/continuous-integration/circleci#basic-setup", "text": "Basic Setup", "level": 2 }, { "id": "app/continuous-integration/circleci#parallelization", "text": "Parallelization", "level": 2 }, { "id": "app/continuous-integration/circleci#additional-examples", "text": "Additional Examples", "level": 2 }, { "id": "app/continuous-integration/circleci#component-testing-example", "text": "Component Testing Example", "level": 3 }, { "id": "app/continuous-integration/circleci#yarn-example", "text": "Yarn Example", "level": 3 }, { "id": "app/continuous-integration/circleci#chrome-example", "text": "Chrome Example", "level": 3 } ] }, "chunks": [ { "id": "app/continuous-integration/circleci#what-youll-learn", "doc_id": "app/continuous-integration/circleci", "heading": "What you'll learn", "heading_level": 5, "content_markdown": "##### What you'll learn\n\n* How to set up CircleCI to run Cypress tests with the Cypress Orb\n* How to cache dependencies and build artifacts\n* How to parallelize Cypress tests with CircleCI\n\nThe [Cypress CircleCI Orb](https://circleci.com/developer/orbs/orb/cypress-io/cypress) is the _official_ CircleCI Orb of Cypress. Although you don't need to use the orb to run your tests in CircleCI, the benefit of using the orb is that it allows you to easily install, cache and run Cypress tests in CircleCI with less effort. The orb abstracts common steps necessary for running your tests in CircleCI in order to make your life as a developer better!\n", "section": "app", "anchors": [ "what-youll-learn" ], "path": "/llm/json/chunked/app/continuous-integration/circleci.json", "token_estimate": 140 }, { "id": "app/continuous-integration/circleci#basic-setup", "doc_id": "app/continuous-integration/circleci", "heading": "Basic Setup", "heading_level": 2, "content_markdown": "## Basic Setup\n\nThe [Cypress CircleCI Orb](https://github.com/cypress-io/circleci-orb) is a piece of configuration set in your `.circleci/config.yml` file to correctly install, cache and run Cypress with very little effort.\n\nFor the Orb Quick Start Guide and usage cases, view the CircleCI [Cypress orb documentation](https://circleci.com/developer/orbs/orb/cypress-io/cypress).\n\nA typical project can have:\n\n.circleci/config.yml\n\n```\nversion: 2.1orbs: # \"cypress-io/cypress@6\" installs the latest published # version \"s.x.y\" of the orb. We recommend you then use # the strict explicit version \"cypress-io/cypress@6.x.y\" # to lock the version and prevent unexpected CI changes cypress: cypress-io/cypress@6workflows: build: jobs: - cypress/run: # \"run\" job comes from \"cypress\" orb start-command: 'npm run start'\n```\n\nThat's it! Your repo's dependencies will be installed and cached and your Cypress tests will run in CircleCI\n", "section": "app", "anchors": [ "basic-setup" ], "path": "/llm/json/chunked/app/continuous-integration/circleci.json", "token_estimate": 161 }, { "id": "app/continuous-integration/circleci#parallelization", "doc_id": "app/continuous-integration/circleci", "heading": "Parallelization", "heading_level": 2, "content_markdown": "## Parallelization\n\nA more complex project that needs to install dependencies, start a server, and run tests across 4 CI machines [in parallel](/llm/markdown/cloud/features/smart-orchestration/parallelization.md) may have:\n\n.circleci/config.yml\n\n```\nversion: 2.1orbs: cypress: cypress-io/cypress@6workflows: build: jobs: - cypress/run: start-command: 'npm run start' cypress-command: 'npx cypress run --parallel --record --group all tests' parallelism: 4\n```\n\nUsing the orb brings simplicity and static checks of parameters to CircleCI configuration.\n\nYou can find additional examples at [our orb examples page](https://github.com/cypress-io/circleci-orb/blob/master/src/examples).\n\nThe Cypress [Real World App (RWA)](https://github.com/cypress-io/cypress-realworld-app) uses the Circle CI [Cypress Orb](https://github.com/cypress-io/circleci-orb), Codecov Orb, and Windows Orb to test over 300 test cases in parallel across 25 machines, multiple browsers, multiple device sizes, and multiple operating systems with full code-coverage reporting and [Cypress Cloud recording](https://cloud.cypress.io/projects/7s5okt).\n\nCheck out the full [RWA Circle CI configuration](https://github.com/cypress-io/cypress-realworld-app/blob/develop/.circleci/config.yml).\n", "section": "app", "anchors": [ "parallelization" ], "path": "/llm/json/chunked/app/continuous-integration/circleci.json", "token_estimate": 169 }, { "id": "app/continuous-integration/circleci#additional-examples", "doc_id": "app/continuous-integration/circleci", "heading": "Additional Examples", "heading_level": 2, "content_markdown": "## Additional Examples\n\n### Component Testing Example\n\n.circleci/config.yml\n\n```\nversion: 2.1orbs: cypress: cypress-io/cypress@6workflows: test: jobs: - cypress/run: cypress-command: 'npx cypress run --component'\n```\n\n### Yarn Example\n\n.circleci/config.yml\n\n```\nversion: 2.1orbs: cypress: cypress-io/cypress@6workflows: test: jobs: - cypress/run: package-manager: 'yarn' start-command: 'yarn start'\n```\n\n### Chrome Example\n\nCypress uses Electron by default to run your tests. The `install-browsers` flag is used to install Chrome, Chrome for Testing, Edge, Firefox and the geckodriver to run your tests. This is only needed if you are passing the `--browser` flag in your `cypress-command`.\n\n.circleci/config.yml\n\n```\nversion: 2.1orbs: cypress: cypress-io/cypress@6workflows: test: jobs: - cypress/run: install-browsers: true start-command: 'npm run start' cypress-command: 'npx cypress run --browser chrome'\n```\n", "section": "app", "anchors": [ "additional-examples" ], "path": "/llm/json/chunked/app/continuous-integration/circleci.json", "token_estimate": 148 }, { "id": "app/continuous-integration/circleci#chrome-example", "doc_id": "app/continuous-integration/circleci", "heading": "Chrome Example", "heading_level": 3, "content_markdown": "### Chrome Example\n\nCypress uses Electron by default to run your tests. The `install-browsers` flag is used to install Chrome, Chrome for Testing, Edge, Firefox and the geckodriver to run your tests. This is only needed if you are passing the `--browser` flag in your `cypress-command`.\n\n.circleci/config.yml\n\n```\nversion: 2.1orbs: cypress: cypress-io/cypress@6workflows: test: jobs: - cypress/run: install-browsers: true start-command: 'npm run start' cypress-command: 'npx cypress run --browser chrome'\n```\n", "section": "app", "anchors": [ "chrome-example" ], "path": "/llm/json/chunked/app/continuous-integration/circleci.json", "token_estimate": 92 } ] }