https://github.com/browserstack/browserstack-cypress-cli
NPM package for the customers to run Cypress on Browserstack Infra
https://github.com/browserstack/browserstack-cypress-cli
Last synced: 11 months ago
JSON representation
NPM package for the customers to run Cypress on Browserstack Infra
- Host: GitHub
- URL: https://github.com/browserstack/browserstack-cypress-cli
- Owner: browserstack
- License: mit
- Created: 2020-02-25T07:15:10.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-05-06T11:37:48.000Z (11 months ago)
- Last Synced: 2025-05-06T12:50:49.345Z (11 months ago)
- Language: JavaScript
- Size: 2.07 MB
- Stars: 53
- Watchers: 20
- Forks: 39
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# BrowserStack Cypress CLI
[](https://badge.fury.io/js/browserstack-cypress-cli)
> **Note**: Running Cypress tests on BrowserStack is now in public beta. Learn more [here](https://browserstack.com/automate/cypress)
>
> If you are looking for a getting started guide, and a more up-to date documentation, check out the [BrowserStack Cypress documentation](https://browserstack.com/docs/automate/cypress)
The `browserstack-cypress-cli` is BrowserStack's command-line interface (CLI) which
allows you to run your Cypress tests on BrowserStack.
- [Quick Start](#quick-start)
- [Documentation](#documentation)
- [Getting Help](#getting-help)
- [License](#license)
## Quick Start
Running your first Cypress test suite on BrowserStack 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 BrowserStack - Cypress CLI via `npm`:
```bash
# Install the BrowserStack Cypress CLI
$ npm install -g browserstack-cypress-cli
```
### Step 2: Configure
Next, set up your BrowserStack credentials and configure the browsers that you want to run your tests on. Use the `init` command to generate a sample `browserstack.json` file, or alternatively create one from scratch.
```bash
# Create a sample configuration file for configurations and capabilities
$ browserstack-cypress init
```
Fill in the `auth`, `browsers`, `run_settings` values in the `browserstack.json` file to be able to run your tests. Refer to the [configuration options](https://browserstack.com/docs/automate/cypress#configure-test-run-settings) to learn more about all the options you can use in `browserstack.json` and the possible values that you can mention.
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 BrowserStack:
```bash
$ browserstack-cypress run
```
After the tests are successfully submitted, you can access the test results on the [BrowserStack Automate dashboard](https://automate.browserstack.com/dashboard/v2)
To learn more about the different options the CLI supports - like running tests in parallel, running tests on `localhost` URLs etc., refer to the [BrowserStack Cypress documentation](https://browserstack.com/docs/automate/cypress)
## Documentation
Here are a few important links to get you started and help you successfully integrate the CLI into your CI/CD pipelines.
- [List of supported browsers & OS](https://browserstack.com/list-of-browsers-and-platforms?product=cypress_testing)
- [Tutorial with the Kitchen Sink sample app](https://browserstack.com/docs/automate/cypress#sample-tutorial)
- [Run Tests in Localhost / Dev / Staging Environments](https://browserstack.com/docs/automate/cypress#run-tests-in-dev-environments)
- [Run Tests in Parallel](https://browserstack.com/docs/automate/cypress#run-tests-in-parallel)
- [Run Tests in CI/CD](https://browserstack.com/docs/automate/cypress#run-tests-in-cicd)
- [CLI Reference](https://browserstack.com/docs/automate/cypress#cli-reference)
## Getting Help
If you need any help, want to share feedback or report issues while running the tests, reach out to us on support@browserstack.com.
## License
This project is released under MIT License. Please refer the
[LICENSE.md](LICENSE.md) for more details.