{"id":13470843,"url":"https://github.com/browserstack/browserstack-cypress-cli","last_synced_at":"2025-05-16T07:05:30.977Z","repository":{"id":36962297,"uuid":"242935045","full_name":"browserstack/browserstack-cypress-cli","owner":"browserstack","description":"NPM package for the customers to run Cypress on Browserstack Infra","archived":false,"fork":false,"pushed_at":"2025-05-06T11:37:48.000Z","size":2170,"stargazers_count":53,"open_issues_count":49,"forks_count":39,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-05-06T12:50:49.345Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/browserstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-02-25T07:15:10.000Z","updated_at":"2025-04-30T12:40:33.000Z","dependencies_parsed_at":"2024-01-21T09:48:12.480Z","dependency_job_id":"d6df5a4e-0fbd-4ca0-b1d0-33706ff2ffc4","html_url":"https://github.com/browserstack/browserstack-cypress-cli","commit_stats":{"total_commits":720,"total_committers":35,"mean_commits":"20.571428571428573","dds":0.7736111111111111,"last_synced_commit":"3179953197bd1425d2f0932696e5bb5f2fa38dae"},"previous_names":[],"tags_count":83,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbrowserstack-cypress-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbrowserstack-cypress-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbrowserstack-cypress-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbrowserstack-cypress-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/browserstack","download_url":"https://codeload.github.com/browserstack/browserstack-cypress-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485060,"owners_count":22078767,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T16:00:36.508Z","updated_at":"2025-05-16T07:05:25.966Z","avatar_url":"https://github.com/browserstack.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# BrowserStack Cypress CLI\n\n[![npm version](https://badge.fury.io/js/browserstack-cypress-cli.svg)](https://badge.fury.io/js/browserstack-cypress-cli)\n\n\u003e **Note**: Running Cypress tests on BrowserStack is now in public beta. Learn more [here](https://browserstack.com/automate/cypress)\n\u003e\n\u003e 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)\n\nThe `browserstack-cypress-cli` is BrowserStack's command-line interface (CLI) which\nallows you to run your Cypress tests on BrowserStack.\n\n-   [Quick Start](#quick-start)\n-   [Documentation](#documentation)\n-   [Getting Help](#getting-help)\n-   [License](#license)\n\n## Quick Start\n\nRunning 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.\n\n### Step 1: Install the CLI\n\nFirst, install the BrowserStack - Cypress CLI via `npm`:\n\n```bash\n# Install the BrowserStack Cypress CLI\n$ npm install -g browserstack-cypress-cli\n```\n\n### Step 2: Configure\n\nNext, 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.\n\n```bash\n# Create a sample configuration file for configurations and capabilities\n$ browserstack-cypress init\n```\n\nFill 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.\n\nMake sure you also specify the `npm` packages that your tests need to run using the `npm_dependencies` option in `run_settings`.\n\n### Step 3: Run your tests\n\nAfter you specify the required run settings, you can run your tests on BrowserStack:\n\n```bash\n$ browserstack-cypress run\n```\n\nAfter the tests are successfully submitted, you can access the test results on the [BrowserStack Automate dashboard](https://automate.browserstack.com/dashboard/v2)\n\nTo 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)\n\n## Documentation\n\nHere are a few important links to get you started and help you  successfully integrate the CLI into your CI/CD pipelines.\n\n-   [List of supported browsers \u0026 OS](https://browserstack.com/list-of-browsers-and-platforms?product=cypress_testing)\n-   [Tutorial with the Kitchen Sink sample app](https://browserstack.com/docs/automate/cypress#sample-tutorial)\n-   [Run Tests in Localhost / Dev / Staging Environments](https://browserstack.com/docs/automate/cypress#run-tests-in-dev-environments)\n-   [Run Tests in Parallel](https://browserstack.com/docs/automate/cypress#run-tests-in-parallel)\n-   [Run Tests in CI/CD](https://browserstack.com/docs/automate/cypress#run-tests-in-cicd)\n-   [CLI Reference](https://browserstack.com/docs/automate/cypress#cli-reference)\n\n## Getting Help\n\nIf you need any help, want to share feedback or report issues while running the tests, reach out to us on support@browserstack.com.\n\n## License\n\nThis project is released under MIT License. Please refer the\n[LICENSE.md](LICENSE.md) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fbrowserstack-cypress-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrowserstack%2Fbrowserstack-cypress-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fbrowserstack-cypress-cli/lists"}