{"id":20932392,"url":"https://github.com/testingbot/testingbot-cypress-cli","last_synced_at":"2026-01-02T20:49:50.137Z","repository":{"id":41892738,"uuid":"286048726","full_name":"testingbot/testingbot-cypress-cli","owner":"testingbot","description":"Run Cypress tests on TestingBot's Cloud Grid","archived":false,"fork":false,"pushed_at":"2024-09-12T06:18:27.000Z","size":805,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-22T00:04:22.277Z","etag":null,"topics":["automated-testing","cypress","cypress-tests"],"latest_commit_sha":null,"homepage":"https://testingbot.com","language":"TypeScript","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/testingbot.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-08T13:30:11.000Z","updated_at":"2024-08-13T11:48:59.000Z","dependencies_parsed_at":"2023-01-27T04:15:42.493Z","dependency_job_id":"2774ffeb-dc52-43fe-a84a-a2706db80e88","html_url":"https://github.com/testingbot/testingbot-cypress-cli","commit_stats":{"total_commits":59,"total_committers":4,"mean_commits":14.75,"dds":"0.27118644067796616","last_synced_commit":"d7ec9673f8ca60d0a5abe18b869c904943eebd07"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Ftestingbot-cypress-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Ftestingbot-cypress-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Ftestingbot-cypress-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Ftestingbot-cypress-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/testingbot","download_url":"https://codeload.github.com/testingbot/testingbot-cypress-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254020902,"owners_count":22000805,"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":["automated-testing","cypress","cypress-tests"],"created_at":"2024-11-18T21:48:26.998Z","updated_at":"2026-01-02T20:49:50.090Z","avatar_url":"https://github.com/testingbot.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TestingBot Cypress CLI\n[![npm version](https://badge.fury.io/js/testingbot-cypress-cli.svg)](https://badge.fury.io/js/testingbot-cypress-cli)\n\nThe `testingbot-cypress-cli` is command-line interface (CLI) which\nallows you to run Cypress tests on TestingBot. TestingBot provides a \nlarge grid of browsers and devices to run both manual and automated tests.\n\n-   [Quick Start](#quick-start)\n-   [Documentation](#documentation)\n-   [Getting Help](#getting-help)\n-   [License](#license)\n\n## Quick Start\nTo get started, simply install the CLI and configure it to use your Cypress project:\n\n### Install the CLI\n\nYou can easily install the CLI via `npm` or `yarn`:\n\n```bash\n$ npm install -g testingbot-cypress-cli\n```\n\nTo use the CLI in combination with [TestingBot Tunnel](https://testingbot.com/support/other/tunnel), you will need to have JDK8 (or higher) installed.\nTestingBot Tunnel is used to connect TestingBot's browser grid with your local computer or network.\n\n### Configure\n\nOnce the CLI is installed, you'll need to point it to a configuration file.\nThe configuration file will point the CLI to the Cypress project and will supply\nthe TestingBot credentials.\n\nTo set up a new configuration file (`testingbot.json`), simply run this command:\n\n```bash\n$ testingbot-cypress init\n```\n\nThis will create a `testingbot.json` file. Please add the `key` and `secret` you obtained from the TestingBot member dashboard in this file.\n\nNext, please supply `cypress_proj_dir` with is the path to the folder that contains the Cypress configuration file.\nAs an example, you can use the [Cypress Kitchen Sink Example](https://github.com/cypress-io/cypress-example-kitchensink).\n\n### Run tests\n\nNow you're ready to start running your Cypress tests on TestingBot.\nTo start the tests, please run:\n```bash\n$ testingbot-cypress run\n```\n\nOnce you've started this command, the tests will start to appear in the [TestingBot Dashboard](https://testingbot.com/members).\n\n## Documentation\n\nPlease see the [TestingBot Cypress Documentation](https://testingbot.com/support/cypress) for more documentation on how to use this CLI.\n\n### Environment variables\n\nIf you prefer to keep your TestingBot credentials in environment variables, you can use `TESTINGBOT_KEY` and `TESTINGBOT_SECRET` environment variables.\n\nIf you are running this CLI in a CI/CD like Jenkins or TeamCity, you can set the\nenvironment variable `TESTINGBOT_CI=1`. The CLI will output the `TestingBotSessionID`, in combination\nwith a TestingBot CI plugin you will be able to view the test's details from inside your CI.\n\n## Getting Help\n\nIf you need help, please reach out to us via info@testingbot.com or the public TestingBot Slack: https://testingbot.com/support\n\n## License\n\nThis project is released under MIT License. Please see the\n[LICENSE.md](LICENSE.md) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestingbot%2Ftestingbot-cypress-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftestingbot%2Ftestingbot-cypress-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestingbot%2Ftestingbot-cypress-cli/lists"}