{"id":22400125,"url":"https://github.com/currents-dev/cli","last_synced_at":"2025-07-31T14:32:30.564Z","repository":{"id":57104968,"uuid":"365424565","full_name":"currents-dev/cli","owner":"currents-dev","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-25T09:10:07.000Z","size":1575,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-30T14:45:15.864Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/currents-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2021-05-08T05:12:13.000Z","updated_at":"2024-11-25T09:10:54.000Z","dependencies_parsed_at":"2024-06-19T19:07:24.425Z","dependency_job_id":"cfe1333e-da8c-4a9d-9b40-24c999fd9031","html_url":"https://github.com/currents-dev/cli","commit_stats":{"total_commits":66,"total_committers":3,"mean_commits":22.0,"dds":"0.10606060606060608","last_synced_commit":"edff8dd806549096d00979dcbad56f119db21458"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/currents-dev%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/currents-dev%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/currents-dev%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/currents-dev%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/currents-dev","download_url":"https://codeload.github.com/currents-dev/cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228257755,"owners_count":17892652,"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-12-05T08:11:28.575Z","updated_at":"2024-12-05T08:11:29.527Z","avatar_url":"https://github.com/currents-dev.png","language":"TypeScript","readme":"# @currents/cli\n\n\u003cp align=\"center\"\u003e\nIntegrate Cypress with \u003ca href=\"https://currents.dev/?utm_source=currents_cli\"\u003eCurrents\u003c/a\u003e - a drop-in replacement for Cypress Cloud\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"830\" src=\"https://user-images.githubusercontent.com/1637928/213367982-78987b7a-411a-4d2e-9486-ca204847022e.png\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://currents.dev?utm_source=currents_cli\"\u003eCurrents\u003c/a\u003e | \u003ca href=\"./CHANGELOG.md\"\u003eChangelog\u003c/a\u003e | \u003ca href=\"https://currents.dev/readme/guides/cypress-compatibility\"\u003eCompatibility\u003c/a\u003e |\n\u003ca href=\"https://currents.dev/readme/guides/currents-cli\"\u003eDocumentation\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n**Dec 2023 Update**\n\nIf you are seeing `Error: certificate has expired`, please upgrade to version 4.0.4+.\n\n**March 2023 Update**\n\n⭐️ Cypress 12.6.0+ users, please use https://github.com/currents-dev/cypress-cloud if you are seeing `Cypress does not support recording test results to this third party service` error ⭐️\n\n---\n\n## CLI Usage\n\nUse Currents as an orchestration and recording service. The command passes down all the CLI flags to cypress and executes cypress behind the scenes.\n\n```sh\nnpm install @currents/cli cypress\nnpx currents run --parallel --record --key XXXXXX --ci-build-id build-001\n```\n\n## API\n\n### `run`\n\nRun Cypress via its [Module API](https://docs.cypress.io/guides/guides/module-api)\n\n```ts\nrun(config: CypressCommandLine.CypressRunOptions): Promise\u003cCypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult\u003e\n```\n\nExample:\n\n```ts\nimport { run } from \"@currents/cli\";\n\nconst cypressOptions: Partial\u003cCypressCommandLine.CypressRunOptions\u003e = {\n  browser: \"chrome\",\n  parallel: true,\n  record: true,\n  key: \"Currents key from https://app.currents.dev\",\n  tag: \"smoke\",\n};\nconst results = await run(cypressOptions);\n```\n\n### `spawn`\n\nSpawn Cypress as a child process and inherit all the flags and environment variables. It invokes `process.exit` with the child process' exit code at the end of its execution.\n\n```ts\nspawn(): Promise\u003cvoid\u003e\n```\n\nExample:\n\n```ts\nimport { spawn } from \"@currents/cli\";\n\nawait spawn();\n```\n\n## Breaking Changes\n\n### Version 4+\n\nVersion 4+ doesn't modify the local installation of Cypress. The following complimentary binaries were deprecated:\n\n- `currents-prepare` script is deprecated. Use `run` or `spawn` API instead.\n- `currents-reset` script is deprecated, use `run` or `spawn` API instead.\n- `patch` API is deprecated. Use `run` or `spawn` instead.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurrents-dev%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcurrents-dev%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurrents-dev%2Fcli/lists"}