Cypress run Command: A Step-by-Step Guide

What Is Cypress run Command?

The Cypress run command is a CLI utility used to execute all Cypress tests in a headless environment via the terminal. By default, it sequentially runs all test files located in the cypress/e2e/*.cy.js directory and displays a summary of the results, indicating which tests passed or failed.

To use the Cypress run command, ensure Cypress is installed locally in your project. Then, prefix the command with npx as shown below:

npx cypress run

This will execute all test cases found in the cypress/e2e/*.cy.js directory. The output will display a detailed report of the test execution, including individual test results and an overall summary.

New to Cypress? Check out this step-by-step Cypress tutorial.

Basic Flags Used With Cypress run Command

The Cypress run command comes with several CLI flags, such as --browser, --spec, --reporter, just to name a few, that allow you to customize how test cases are executed headlessly on the terminal when added with the cypress run command.

These flags enable you to extend the functionality of the Cypress run command by adding additional commands as flags to the end of the run command to perform more advanced operations via the terminal.

How to Run Cypress Tests in a Specific Browser?

You can clone the GitHub repository created for Cypress run command. It includes all code samples and configurations demonstrated throughout the guide.

By default, Cypress executes tests using the Electron browser when the cypress run command is invoked. However, you can specify a different browser using the --browser flag. Cypress will then run the tests in headless mode with the specified browser.

To use a specific browser, append the --browser flag followed by the browser name (e.g., Chrome, Firefox, Edge, etc.) to the command:

npx cypress run --browser chrome

Here, the above command will execute the test in headless mode using Chrome as shown below.

You can run the above command in headed mode using the --headed command or npx cypress open.

npx cypress run --headed --browser firefox

Make sure the chosen browser is installed on your local machine. You can verify the list of available browsers with the command below.

npx cypress info

How to Run a Specific or Multiple Cypress Test Files?

By default, when the cypress run command is executed, Cypress runs all test files located in the cypress/e2e/*.cy.js directory sequentially, regardless of whether you're only interested in running a single file. This approach can be inefficient and time-consuming in cases where targeted testing is needed.

To address this, Cypress provides the --spec flag, which allows you to specify the exact test file (including its path) that you want to execute. When used, Cypress will run only the specified file and skip the rest.

For example, let’s run a test file located at cypress/e2e/swiper-items.cy.js. First, ensure the file exists and contains your test code: cypress/e2e/*.cy.js directory.

npx cypress run --spec cypress/e2e/swiper-items.cy.js

Then, run the test using the following command:

describe('TestMu AI Playground - Product Carousel', () => {
        beforeEach(() => {
          cy.visit('https://ecommerce-playground.lambdatest.io/')
        })

        it('performs product carousel checks', () => {
          cy.get('.swiper-slide').then($items => {
            cy.log(`Number of swiper items: ${$items.length}`)
          })

          cy.get('.price-new').should('exist').each($price => {
            const text = $price.text()
            expect(text.trim()).to.not.be.empty
            expect(text).to.include('$')
          })

          cy.get('.swiper-slide img').should('be.visible').and($img => {
            const src = $img.attr('src')
            expect(src, 'Image src should exist').to.match(/^https?:///)
          })

          cy.get('h4.title .text-ellipsis-2').each($el => {
            const text = $el.text().trim()
            expect(text).to.not.be.empty
          })
        })
      })

This command will execute only the swiper-items.cy.js test file, reducing the time spent on executing all tests.

While this approach helps to target a specific test file, you can also target multiple files using a comma-separated list inside a double quote.

npx cypress run --spec "cypress/e2e/swiper-items.cy.js,cypress/e2e/home_carousel.cy.js"

Here we are running swiper-items.cy.js and home_carousel.cy.js test files. Cypress will execute both files and ignore others.

How to Generate Reports Using Cypress Custom Reporter?

When tests are executed via the terminal, for instance, using the cypress run command, the configured reporter captures the test results and formats them into reports, typically in HTML or JSON format.

Depending on the reporter you’re using, you might need to specify it with the --reporter flag, like so:

npx cypress run --reporter mocha-junit-reporter

Let’s use the cypress-mochawesome-reporter package. This reporter does not require the --reporter flag explicitly when it's set up via your Cypress configuration. It automatically generates the report on completion of test execution.

Step 1: To install cypress-mochawesome-reporter, run:

npm install --save-dev cypress-mochawesome-reporter

Step 2: Next, open your cypress.config.js file and configure the reporter as follows:

const { defineConfig } = require("cypress");

module.exports = defineConfig({
  reporter: 'cypress-mochawesome-reporter',
  reporterOptions: {
    charts: true,
    reportPageTitle: 'custom-title',
    embeddedScreenshots: true,
    inlineAssets: true,
  },
  e2e: {
    setupNodeEvents(on, config) {
      // implement node event listeners here
      require('cypress-mochawesome-reporter/plugin')(on);
    },
  },
});

Step 3: Next, navigate to cypress/support/e2e.js directory and import cypress-mochawesome-reporter plugin.

import 'cypress-mochawesome-reporter/register';

Step 4: Now, run the command below to automatically generate a Mochawesome report in the specified directory.

npx cypress run

Cypress will run all tests in the test directory, and as soon as all test execution is complete, Cypress will begin generating test reports using cypress-mochawesome-reporter.

Next, locate the generated report file at cypress/report/html/index.html, click on the file, and open it in your default browser. Your reports should look as shown below.

How to Run Cypress Tests in Parallel With TestMu AI?

Cloud-based testing platform like TestMu AI offers a scalable cloud that allows you to execute tests across multiple browsers in parallel. This approach significantly improves efficiency by enabling Cypress parallel testing, eliminating the need to run tests manually on each browser one at a time.

To begin, run the following command:

npm install -g lambdatest-cypress-cli

This installs the TestMu AI Cypress CLI globally. Once installed, initialize your project with:

lambdatest-cypress init --cv=14.3.2

This will create the necessary TestMu AI configuration files and folders, including the lambdatest-config.json file. Open this file and enter your TestMu AI credentials (username and password).

You can find more details in this documentation on Cypress testing with TestMu AI.

To run Cypress tests on multiple browsers, you can define a browsers array in the lambdatest-config.json file, specifying the desired browser name, operating system, and version for execution on the TestMu AI cloud environment.

{
    "lambdatest_auth": {
      "username": "username",
      "access_key": "accesskey"
   },
   "browsers": [
      {
         "browser": "Chrome",
         "platform": "Windows 10",
         "versions": [
            "latest"
         ]
      },
      {
         "browser": "Firefox",
         "platform": "Windows 10",
         "versions": [
            "latest"
         ]
      }

To run the tests, pass these parameters directly via the terminal using the --browser flag, as shown below:

lambdatest-cypress run --browsers "Windows 10:Chrome:latest,Windows 10:Firefox:latest"

Here are the Cypress test results that you can notice on the TestMu AI Web Automation dashboard.

Conclusion

Bringing all these aspects together, mastering the Cypress run command is essential for creating a robust and efficient test automation workflow. Understanding the basic flags ensures you can tailor test runs to your project’s needs, while controlling the browser environment allows for accurate cross browser testing. Selecting specific test files or suites enhances efficiency by targeting only the relevant scenarios, reducing unnecessary execution time.

Integrating custom reporters provides clear, actionable insights from each run, helping teams quickly identify issues and track progress. Finally, leveraging parallel execution with platforms like TestMu AI dramatically accelerates test cycles, making large-scale automation practical and scalable. By combining these techniques, you gain full command over your Cypress tests, ensuring they are fast, reliable, and fully aligned with real-world project requirements.

Citations

• Cypress Command Line: https://docs.cypress.io/app/references/command-line