<p align="center"> Integrate Cypress with <a href="https://currents.dev/?utm_source=currents_cli">Currents</a> - a drop-in replacement for Cypress Cloud </p>
npm install @currents/cli
Integrate Cypress with Currents - a drop-in replacement for Cypress Cloud

Currents | Changelog | Compatibility |
Documentation
---
Dec 2023 Update
If you are seeing Error: certificate has expired, please upgrade to version 4.0.4+.
March 2023 Update
⭐️ 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 ⭐️
---
Use Currents as an orchestration and recording service. The command passes down all the CLI flags to cypress and executes cypress behind the scenes.
``sh`
npm install @currents/cli cypress
npx currents run --parallel --record --key XXXXXX --ci-build-id build-001
Run Cypress via its Module API
`ts`
run(config: CypressCommandLine.CypressRunOptions): Promise
Example:
`ts
import { run } from "@currents/cli";
const cypressOptions: Partial
browser: "chrome",
parallel: true,
record: true,
key: "Currents key from https://app.currents.dev",
tag: "smoke",
};
const results = await run(cypressOptions);
`
Spawn 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.
`ts`
spawn(): Promise
Example:
`ts
import { spawn } from "@currents/cli";
await spawn();
`
Version 4+ doesn't modify the local installation of Cypress. The following complimentary binaries were deprecated:
- currents-prepare script is deprecated. Use run or spawn API instead.currents-reset
- script is deprecated, use run or spawn API instead.patch
- API is deprecated. Use run or spawn` instead.