testgrid-cypress-cli v1.28.5

TestGrid Cypress CLI

Note: Running Cypress tests on TestGrid is now in public beta.

If you are looking for a getting started guide, and a more up-to date documentation, check out the TestGrid Cypress documentation

The testgrid-cypress-cli is TestGrid's command-line interface (CLI) which allows you to run your Cypress tests on TestGrid.

Quick Start

Running your first Cypress test suite on TestGrid is super easy - just install our CLI, configure the test run settings and start testing. Here’s a quick start guide to help you get started.

Step 1: Install the CLI

First, install the TestGrid - Cypress CLI via git:

# Install the TestGrid Cypress CLI
$ npm install -g testgrid-cypress-cli

Step 2: Configure

Next, set up your TestGrid credentials and configure the browsers that you want to run your tests on. Use the init command to generate a sample testgrid.json file, or alternatively create one from scratch.

# Create a sample configuration file for configurations and capabilities
$ testgrid-cypress init

Fill in the auth, browsers, run_settings values in the testgrid.json file to be able to run your tests.

Make sure you also specify the npm packages that your tests need to run using the npm_dependencies option in run_settings.

Step 3: Run your tests

After you specify the required run settings, you can run your tests on TestGrid:

$ testgrid-cypress run

After the tests are successfully submitted, you can access the test results on the TestGrid Automate dashboard

To learn more about the different options the CLI supports - like running tests in parallel, running tests on localhost URLs etc., refer to the TestGrid Cypress documentation

Getting Help

If you need any help, want to share feedback or report issues while running the tests, reach out to us on support@testgrid.io.

License

This project is released under MIT License. Please refer the LICENSE.md for more details.