pwc
pwc command-line executable documentation
pwc
is a lightweight command-line executable that runs Playwright with a few pre-configured options.
pwc
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 [options] [playwright arguments and flags]
🎭 Run Playwright tests on CI using https://currents.dev
----------------------------------------------------
📖 Documentation: https://docs.currents.dev
🤙 Support: [email protected]
----------------------------------------------------
Examples
Run all tests in the current directory:
pwc --key --project-id --ci-build-id
Run only tests filtered by the tag @smoke
:
pwc --key --project-id --ci-build-id --grep smoke
Run playwright tests and add tags "tagA", "tagB"
to the recorded run:
pwc --key --project-id --ci-build-id --tag tagA --tag tagB
Set playwright
arguments and flags:
pwc --key --project-id --ci-build-id -- --workers 2 --timeout 10000 --shard 1/2
Options
--ci-build-id
--ci-build-id
The unique identifier for a run. See ciBuildId *
-k, --key
-k, --key
Your secret Record Key obtained from Currents. See recordKey *.
-p, --project-id
-p, --project-id
The project ID for results reporting obtained from Currents. See projectId *.
-t, --tag
-t, --tag
Comma-separated tag(s) for recorded runs in Currents. See tag.
--pwc-config <path>
--pwc-config <path>
Path to currents config file currents.config.[ts|js]
. See Configuration Sources.
--pwc-remove-title-tags
--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
--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>
--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"]
--pwc-debug [boolean | "remote" | "full"]
Enable collecting debug logs for the reporter (default: false).
true
will print the debug logs to stdoutremote
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>
--pwc-output-file <path>
File path for run summary output in JSON format. See outputFile.
--pwc-coverage <project-name>
--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>
--pwc-coverage-dir <path>
Coverage reports directory path. See coverage.dir.
-V, --version
-V, --version
Show package version
-h, --help
-h, --help
Show pwc
help
Last updated
Was this helpful?