{
  "doc": {
    "id": "app/run-tests/continuous-integration/circleci",
    "title": "Run Cypress tests in CircleCI: 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/run-tests/continuous-integration/circleci.md",
    "version": "066c46e056f0f322a0670d2d3aa4e6adaebfe717",
    "updated_at": "2026-09-10T13:30:12.426Z",
    "headings": [
      {
        "id": "app/run-tests/continuous-integration/circleci#run-cypress-in-circleci",
        "text": "Run Cypress in CircleCI",
        "level": 1
      },
      {
        "id": "app/run-tests/continuous-integration/circleci#basic-setup",
        "text": "Basic Setup",
        "level": 2
      },
      {
        "id": "app/run-tests/continuous-integration/circleci#parallelization",
        "text": "Parallelization",
        "level": 2
      },
      {
        "id": "app/run-tests/continuous-integration/circleci#additional-examples",
        "text": "Additional Examples",
        "level": 2
      },
      {
        "id": "app/run-tests/continuous-integration/circleci#component-testing-example",
        "text": "Component Testing Example",
        "level": 3
      },
      {
        "id": "app/run-tests/continuous-integration/circleci#yarn-example",
        "text": "Yarn Example",
        "level": 3
      },
      {
        "id": "app/run-tests/continuous-integration/circleci#chrome-example",
        "text": "Chrome Example",
        "level": 3
      }
    ]
  },
  "chunks": [
    {
      "id": "app/run-tests/continuous-integration/circleci#basic-setup",
      "doc_id": "app/run-tests/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.1\norbs:\n  # \"cypress-io/cypress@6\" installs the latest published\n  # version \"s.x.y\" of the orb. We recommend you then use\n  # the strict explicit version \"cypress-io/cypress@6.x.y\"\n  # to lock the version and prevent unexpected CI changes\n  cypress: cypress-io/cypress@6\nworkflows:\n  build:\n    jobs:\n      - cypress/run: # \"run\" job comes from \"cypress\" orb\n          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/run-tests/continuous-integration/circleci.json",
      "token_estimate": 164
    },
    {
      "id": "app/run-tests/continuous-integration/circleci#parallelization",
      "doc_id": "app/run-tests/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.1\norbs:\n  cypress: cypress-io/cypress@6\nworkflows:\n  build:\n    jobs:\n      - cypress/run:\n          start-command: 'npm run start'\n          cypress-command: 'npx cypress run --parallel --record --group all tests'\n          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/run-tests/continuous-integration/circleci.json",
      "token_estimate": 172
    },
    {
      "id": "app/run-tests/continuous-integration/circleci#additional-examples",
      "doc_id": "app/run-tests/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.1\norbs:\n  cypress: cypress-io/cypress@6\nworkflows:\n  test:\n    jobs:\n      - cypress/run:\n          cypress-command: 'npx cypress run --component'\n```\n\n### Yarn Example\n\n.circleci/config.yml\n\n```\nversion: 2.1\norbs:\n  cypress: cypress-io/cypress@6\nworkflows:\n  test:\n    jobs:\n      - cypress/run:\n          package-manager: 'yarn'\n          start-command: 'yarn start'\n```\n\n### Chrome Example\n\nThe `install-browsers` flag installs Chrome, Chrome for Testing, Edge, Firefox and the geckodriver. Use it together with the `--browser` flag in your `cypress-command` to run your tests in an installed browser.\n\n.circleci/config.yml\n\n```\nversion: 2.1\norbs:\n  cypress: cypress-io/cypress@6\nworkflows:\n  test:\n    jobs:\n      - cypress/run:\n          install-browsers: true\n          start-command: 'npm run start'\n          cypress-command: 'npx cypress run --browser chrome'\n```\n",
      "section": "app",
      "anchors": [
        "additional-examples"
      ],
      "path": "/llm/json/chunked/app/run-tests/continuous-integration/circleci.json",
      "token_estimate": 140
    },
    {
      "id": "app/run-tests/continuous-integration/circleci#chrome-example",
      "doc_id": "app/run-tests/continuous-integration/circleci",
      "heading": "Chrome Example",
      "heading_level": 3,
      "content_markdown": "### Chrome Example\n\nThe `install-browsers` flag installs Chrome, Chrome for Testing, Edge, Firefox and the geckodriver. Use it together with the `--browser` flag in your `cypress-command` to run your tests in an installed browser.\n\n.circleci/config.yml\n\n```\nversion: 2.1\norbs:\n  cypress: cypress-io/cypress@6\nworkflows:\n  test:\n    jobs:\n      - cypress/run:\n          install-browsers: true\n          start-command: 'npm run start'\n          cypress-command: 'npx cypress run --browser chrome'\n```\n",
      "section": "app",
      "anchors": [
        "chrome-example"
      ],
      "path": "/llm/json/chunked/app/run-tests/continuous-integration/circleci.json",
      "token_estimate": 79
    }
  ]
}