TestMu 2025 - The Largest Virtual Software Testing Conference is Back | 50,000+ Attendees

How to use cypress.cli.parseRunArguments method in Cypress

Best JavaScript code snippet using cypress

cypress_spec.js

Source:cypress_spec.js

...156  context('cli', function () {157    describe('.parseRunArguments', function () {158      it('parses CLI cypress run arguments', async () => {159        const args = 'cypress run --browser chrome --spec my/test/spec.js'.split(' ')160        const options = await cypress.cli.parseRunArguments(args)161        expect(options).to.deep.equal({162          browser: 'chrome',163          spec: 'my/test/spec.js',164        })165      })166      it('parses CLI cypress run shorthand arguments', async () => {167        const args = 'cypress run -b firefox -p 5005 --headed --quiet'.split(' ')168        const options = await cypress.cli.parseRunArguments(args)169        expect(options).to.deep.equal({170          browser: 'firefox',171          port: 5005,172          headed: true,173          quiet: true,174        })175      })176      it('coerces --record and --dev', async () => {177        const args = 'cypress run --record false --dev true'.split(' ')178        const options = await cypress.cli.parseRunArguments(args)179        expect(options).to.deep.equal({180          record: false,181          dev: true,182        })183      })184      it('coerces --config-file false to boolean', async () => {185        const args = 'cypress run --config-file false'.split(' ')186        const options = await cypress.cli.parseRunArguments(args)187        expect(options).to.deep.equal({188          configFile: false,189        })190      })191      it('coerces --config-file cypress.json to string', async () => {192        const args = 'cypress run --config-file cypress.json'.split(' ')193        const options = await cypress.cli.parseRunArguments(args)194        expect(options).to.deep.equal({195          configFile: 'cypress.json',196        })197      })198      it('parses config file false', async () => {199        const args = 'cypress run --config-file false'.split(' ')200        const options = await cypress.cli.parseRunArguments(args)201        expect(options).to.deep.equal({202          configFile: false,203        })204      })205      it('parses config', async () => {206        const args = 'cypress run --config baseUrl=localhost,video=true'.split(' ')207        const options = await cypress.cli.parseRunArguments(args)208        // we don't need to convert the config into an object209        // since the logic inside cypress.run handles that210        expect(options).to.deep.equal({211          config: 'baseUrl=localhost,video=true',212        })213      })214      it('parses env', async () => {215        const args = 'cypress run --env MY_NUMBER=42,MY_FLAG=true'.split(' ')216        const options = await cypress.cli.parseRunArguments(args)217        // we don't need to convert the environment into an object218        // since the logic inside cypress.run handles that219        expect(options).to.deep.equal({220          env: 'MY_NUMBER=42,MY_FLAG=true',221        })222      })223    })224  })...

cypress-runner-run-tests.js

Source:cypress-runner-run-tests.js

...19  }20  if (cliArgs[1] !== "run") {21    cliArgs.splice(1, 0, "run");22  }23  return await cypress.cli.parseRunArguments(cliArgs);24};25const getSourceFolder = folder => {26  return `./frontend/test/metabase/scenarios/${folder}/**/*.cy.spec.js`;27};28const getReporterConfig = isCI => {29  return isCI30    ? {31        reporter: "junit",32        "reporter-options": "mochaFile=cypress/results/results-[hash].xml",33      }34    : null;35};36const runCypress = async (baseUrl, exitFunction) => {37  const defaultConfig = {...

cypress.js

Source:cypress.js

...48     * Parses CLI arguments into an object that you can pass to "cypress.run"49     * @example50     *  const cypress = require('cypress')51     *  const cli = ['cypress', 'run', '--browser', 'firefox']52     *  const options = await cypress.cli.parseRunArguments(cli)53     *  // options is {browser: 'firefox'}54     *  await cypress.run(options)55     * @see https://on.cypress.io/module-api56     */57    parseRunArguments(args) {58      return cli.parseRunCommand(args);59    }60  }61};...

index.js

Source:index.js

...15    return args16        .map(arg => arg.replace(/\[uuid]/g, uuidv4()))17}18async function worker({spec, args}) {19    const runOptions = await cypress.cli.parseRunArguments([20        'cypress',21        'run',22        '--spec',23        spec,24        ...preprocessArgs(args)25    ]);26    console.log(runOptions);27    await cypress.run(runOptions);28}29async function run(specs, concurrency = 1, args) {30    console.log('found specs:');31    console.log(specs);32    const q = fastq(worker, concurrency);33    for (const spec of specs) {...

run-me.js

Source:run-me.js

1// runs Cypress end-to-end tests using Cypress Node module API2// https://on.cypress.io/module-api3/* eslint-disable no-console */4const cypress = require('cypress')5cypress.cli.parseRunArguments(process.argv.slice(2))6.then((runOptions) => {7  console.log('Parsed cypress run options:')8  console.log(runOptions)9  return runOptions10})11.then(cypress.run)12.then((results) => {13  if (results.failures) {14    // means really bad error, could not run tests15    console.error('Failed to run Cypress')16    console.error(results.message)17    process.exit(1)18  }19  console.log('Cypress run results: %d total tests, %d passed, %d failed',...

run.js

Source:run.js

1const cypress = require("cypress");2const args = process.argv.slice(2);3const options = ["cypress", "run", ...args]; // saves passing 'cypress run' on the command line4cypress.cli5    .parseRunArguments(options)6    .then((runOptions) => {7        console.log("runOptions", runOptions);8        cypress9            .run(runOptions)10            .then(() => {11                process.exit(0); // control the exit code12            })13            .catch((error) => {14                console.error(error);15            });16    })17    .catch((error) => {18        console.error(error);...

cy-run.js

Source:cy-run.js

1const cypress = require('cypress')2const args = process.argv.slice(2);3const options = ['cypress', 'run', ...args]; // saves passing 'cypress run' on the command line4cypress.cli.parseRunArguments(options).then(runOptions => {5  console.log('runOptions', runOptions)6  cypress.run(runOptions).then(() => {7    process.exit(0);   // control the exit code 8  }).catch(error => {9    console.error(error);10  })11}).catch(error => {12  console.error(error)...

Using AI Code Generation

1const cypress = require('cypress')2const args = cypress.cli.parseRunArguments(['--env', 'foo=bar'])3cypress.run(args)4  .then((results) => {5    console.log(results)6  })7  .catch((err) => {8    console.error(err)9  })10"scripts": {11}12{ totalFailed: 0,13   { animationDistanceThreshold: 5,14     component: {},15     env: { foo: 'bar', baz: 'qux' },

Using AI Code Generation

1const cypress = require('cypress');2const args = cypress.cli.parseRunArguments(['--browser', 'chrome']);3cypress.run(args);4"scripts": {5}6const cypress = require('cypress');7const args = cypress.cli.parseRunArguments(['--browser', 'chrome', '--headless']);8cypress.run(args);9"scripts": {10}

Using AI Code Generation

1const cypress = require('cypress');2cypress.run(args);3cypress.run(args).then((results) => {4  console.log(results);5});6cypress.run(args).then((results) => {7  console.log(results);8  process.exit(results.totalFailed);9});10cypress.run(args).then((results) => {11  console.log(results);12  process.exit(results.totalFailed);13}).catch((err) => {14  console.error(err);15  process.exit(1);16});17cypress.run(args).then((results) => {18  console.log(results);19  process.exit(results.totalFailed);20}).catch((err) => {21  console.error(err);22  process.exit(1);23});24cypress.run(args).then((results) => {25  console.log(results);26  process.exit(results.totalFailed);27}).catch((err) => {28  console.error(err);29  process.exit(1);30});31cypress.run(args).then((results) => {32  console.log(results);33  process.exit(results.totalFailed);34}).catch((err) => {35  console.error(err);36  process.exit(1);37});38cypress.run(args).then((results) => {39  console.log(results);40  process.exit(results.totalFailed);41}).catch((err) => {42  console.error(err);43  process.exit(1);44});45cypress.run(args).then((results) => {46  console.log(results);47  process.exit(results.totalFailed);48}).catch((err) => {49  console.error(err);50  process.exit(1);51});52cypress.run(args).then((results) => {53  console.log(results);54  process.exit(results.totalFailed);55}).catch((err) => {56  console.error(err);57  process.exit(1

Using AI Code Generation

1const cypress = require('cypress')2const args = cypress.cli.parseRunArguments(['--spec', 'cypress/integration/test.spec.js'])3console.log(args)4describe('Test', () => {5  it('Test', () => {6  })7})8I've also tried using cy.get() with a

Using AI Code Generation

1const cypress = require('cypress');2const args = process.argv.slice(2);3cypress.cli.parseRunArguments(args).then(options => {4  console.log(options);5});6{ _: [],7   { key1: 'value1',8     key3: 'value3' },9  group: undefined }

Using AI Code Generation

1const cypress = require('cypress');2const browserName = cypress.cli.parseRunArguments(process.argv).browser;3console.log('browserName: ', browserName);4{5  "env": {6  }7}8{9  "scripts": {10  }11}12describe('Test', () => {13  it('should get the browser name', () => {14    cy.get('h1').should('contain', 'Kitchen Sink');15  });16});

Cypress Tutorial

Cypress is a renowned Javascript-based open-source, easy-to-use end-to-end testing framework primarily used for testing web applications. Cypress is a relatively new player in the automation testing space and has been gaining much traction lately, as evidenced by the number of Forks (2.7K) and Stars (42.1K) for the project. LambdaTest’s Cypress Tutorial covers step-by-step guides that will help you learn from the basics till you run automation tests on LambdaTest.

Chapters:

What is Cypress? -
Why Cypress? - Learn why Cypress might be a good choice for testing your web applications.
Features of Cypress Testing - Learn about features that make Cypress a powerful and flexible tool for testing web applications.
Cypress Drawbacks - Although Cypress has many strengths, it has a few limitations that you should be aware of.
Cypress Architecture - Learn more about Cypress architecture and how it is designed to be run directly in the browser, i.e., it does not have any additional servers.
Browsers Supported by Cypress - Cypress is built on top of the Electron browser, supporting all modern web browsers. Learn browsers that support Cypress.
Selenium vs Cypress: A Detailed Comparison - Compare and explore some key differences in terms of their design and features.
Cypress Learning: Best Practices - Take a deep dive into some of the best practices you should use to avoid anti-patterns in your automation tests.
How To Run Cypress Tests on LambdaTest? - Set up a LambdaTest account, and now you are all set to learn how to run Cypress tests.

Certification

You can elevate your expertise with end-to-end testing using the Cypress automation framework and stay one step ahead in your career by earning a Cypress certification. Check out our Cypress 101 Certification.