@currents/cli
v4.0.5
Published
<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>
Downloads
85,527
Readme
@currents/cli
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 ⭐️
CLI Usage
Use Currents as an orchestration and recording service. The command passes down all the CLI flags to cypress and executes cypress behind the scenes.
npm install @currents/cli cypress
npx currents run --parallel --record --key XXXXXX --ci-build-id build-001
API
run
Run Cypress via its Module API
run(config: CypressCommandLine.CypressRunOptions): Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>
Example:
import { run } from "@currents/cli";
const cypressOptions: Partial<CypressCommandLine.CypressRunOptions> = {
browser: "chrome",
parallel: true,
record: true,
key: "Currents key from https://app.currents.dev",
tag: "smoke",
};
const results = await run(cypressOptions);
spawn
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.
spawn(): Promise<void>
Example:
import { spawn } from "@currents/cli";
await spawn();
Breaking Changes
Version 4+
Version 4+ doesn't modify the local installation of Cypress. The following complimentary binaries were deprecated:
currents-prepare
script is deprecated. Userun
orspawn
API instead.currents-reset
script is deprecated, userun
orspawn
API instead.patch
API is deprecated. Userun
orspawn
instead.