pwc-p (orchestration)

Currents orchestration pwc-p command-line executable documentation

pwc-p is a command-line executable that implements Currents Orchestration for Playwright. See Playwright Parallelization and Orchestration Setup.

pwc-p allows providing Configuration options via CLI flags. Additionally, is passes down CLI flags to the underlying playwright command.

We recommended using currents.config.ts file. See Configuration Sources.

> pwc-p [options] [playwright arguments and flags]

✨ Orchestrate 🎭 Playwright tests on CI using https://currents.dev

----------------------------------------------------
📖 Documentation: https://docs.currents.dev
🤙 Support:       [email protected]
----------------------------------------------------

Examples

Orchestrate all tests in the current directory:

pwc-p --key --project-id --ci-build-id

Add additional playwright arguments and flags:

pwc-p --key --project-id --ci-build-id -- --workers 2 --timeout 10000

Options

--ci-build-id

The unique identifier for a run. See ciBuildId *

---

-k, --key

Your secret Record Key obtained from Currents. See recordKey *.

---

-p, --project-id

The project ID for results reporting obtained from Currents. See projectId *.

---

-t, --tag

Comma-separated tag(s) for recorded runs in Currents. See tag.

---

--pwc-config <path>

Path to currents config file currents.config.[ts|js]. See Configuration Sources.

---

--pwc-remove-title-tags

Remove tags from test names in Currents, e.g. Test name @smoke becomes Test name in the dashboard (default: false). See removeTitleTags.

---

--pwc-disable-title-tags

Disable parsing tags from test title, e.g. Test name @smoke would not have tag smoke in the dashboard (default: false). See disableTitleTags.

---

--pwc-cancel-after-failures <number | false>

Abort the cloud run after the specified number of failed tests detected. Overrides the default Currents Project settings. See cancelAfterFailures.

---

--pwc-debug [boolean | "remote" | "full"]

Enable collecting debug logs for the reporter (default: false).

• true will print the debug logs to stdout

• remote will upload the debug logs to Currents servers.

• full will print the logs to stdout and also upload to Currents.

Environment variable: CURRENTS_DEBUG=true | "remote" | "full" . See Troubleshooting Playwright.

---

--pwc-output-file <path>

File path for run summary output in JSON format. See outputFile.

---

--pwc-coverage <project-name>

List of projects to collect coverage for, e.g. --pwc-coverage chromium --pwc-coverage firefox. If no projects are specified, coverage will be collected for all projects. See coverage.projects.

---

--pwc-coverage-dir <path>

Coverage reports directory path. See coverage.dir.

---

--pwc-test-suite-file <path>

Path to the full test suite file for orchestration and reporting. See testSuiteFile.

---

--pwc-machine-id <string>

Unique identifier of the machine running the tests. Mostly used internally. If not provided, it will be generated automatically. See machineId.

---

--pwc-orchestration-id <string>

Unique identifier of the orchestration session this run belongs to. See orchestrationId .

---

--pwc-batch-size <auto|number>

Defines how many Playwright workers are available for orchestration. See orchestration.batchSize .

---

--pwc-reset-signal SIGUSR1 | SIGUSR2

Specify a process signal to listen for to trigger a reset of the current in progress tests. Only available on OS with POSIX signal support. See orchestration.resetSignal.

---

--pwc-skip-reporter-injection

Do not inject @currents/playwright . If set, you must add Currents reporter manually. See orchestration.skipReporterInjection

---

-V, --version

Show package version

---

-h, --help

Show help