@currents/cli

@currents/cli

Integrate Cypress with Currents - a drop-in replacement for Cypress Cloud

Currents | Changelog | Compatibility | Documentation

---

CLI Usage

Integrate Cypress with Currents Dashboard. The command passes down all the CLI flags to Cypress.

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.

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. 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.

Changelog

4.0.1 (2023-01-19)

Version 4+ is fully compatible with Cypress 12+ 🎉. It leaves the local installation of Cypress intact and uses the public Cypress APIs to enable the integration.

Breaking Changes

The following complimentary scripts from v3 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.
• limit node engine to 14.17+

Dependencies

• use cy2@4.0.6