Currents Documentation
Currents.devGitHubChangelog
  • Getting Started
    • What is Currents?
    • Playwright
      • Playwright: Quick Start
      • Troubleshooting Playwright
    • Cypress
      • Your First Cypress Run
      • Integrating with Cypress
        • Compatibility
        • Alternative Cypress Binaries
      • Troubleshooting Cypress
    • Jest
      • Your First Jest Run
      • Detox + Jest
      • Troubleshooting Jest
    • Others
    • CI Setup
      • GitHub Actions
        • Cypress - GitHub Actions
        • Playwright - GitHub Actions
        • Jest - GitHub Actions
        • Node.js - GitHub Actions
        • Commit data for GitHub Actions
        • Custom Docker runners
        • Named Runners
      • GitLab
        • Cypress - GitLab CI/CD
        • Playwright - GitLab CI/CD
        • Custom Docker runners
      • Jenkins
        • Cypress - Jenkins
        • Playwright - Jenkins
      • CircleCI
        • Cypress - CircleCI
        • Playwright - CircleCI
      • Bitbucket
        • Cypress - Bitbucket Pipelines
      • Azure DevOps
        • Cypress - Azure DevOps
        • Playwright - Azure DevOps
      • AWS Code Build
        • Cypress - AWS Code Build
        • Playwright - AWS Code Build
      • NX
        • Playwright - NX
        • Cypress - NX
  • Guides
    • Record Key
    • CI Build ID
    • Reporting
      • Reporting Strategy
      • Reporting in CI
      • Step-Level Reporting
    • CI Optimization
      • Playwright Parallelization
      • Orchestration Setup
      • Fully Parallel Mode
      • Re-run Only Failed Tests
      • Cloud Spot Instances
      • Failing Fast
      • Load Balancing
    • Code Coverage
      • Code Coverage for Playwright
      • Code Coverage for Cypress
    • Currents Actions
      • Setup Currents Actions
      • Using Currents Actions
      • Reference
        • Conditions
        • Actions
    • Playwright Component Testing
    • Playwright Visual Testing
    • Playwright Annotations
    • Playwright Tags
    • MCP Server
  • Dashboard
    • Projects
      • Projects Summary view
      • Project Settings
      • Archive and Unarchive Projects
    • Runs
      • Run Status
      • Run Details
      • Commit Information
      • Tags
      • Run Timeouts
      • Canceling Runs
      • Deleting Runs
      • Run Progress
    • Tests
      • Spec File Status
      • Test Status
      • Flaky Tests
      • Test History
    • Test Suite Explorer
      • Test Explorer
        • Tests Performance
      • Spec Files Explorer
        • Spec Files Performance
      • Errors Explorer
  • Automated Reports
  • Insights and Analytics
  • Administration
    • Email Domain Based Access
    • SSO SAML2.0
      • SAML2.0 Configuration
      • SCIM User Provisioning
      • IdP-initiated Sessions
      • JumpCloud
        • JumpCloud User provisioning
      • Okta
        • Okta User provisioning
      • Troubleshooting SSO
    • Billing & Usage
  • Billing and Pricing
  • Resources
    • Reporters
      • cypress-cloud
        • Batched Orchestration
        • Migration to Cypress@13
      • @currents/cli
      • @currents/playwright
        • Configuration
        • pwc
        • pwc-p (orchestration)
        • Playwright Fixtures
      • @currents/jest
      • @currents/node-test-reporter
      • @currents/cmd
        • currents api
        • currents upload
        • currents cache
        • currents convert
      • Data Format Reference
    • Integrations
      • GitHub
        • GitHub App
        • GitHub OAuth
      • GitLab
      • Slack
      • Microsoft Teams
      • HTTP Webhooks
      • Bitbucket
    • API
      • Introduction
      • Authentication
      • API Keys
      • Errors
      • Pagination
      • API Resources
        • Instances
        • Runs
        • Projects
        • Spec Files
        • Test Signature
        • Test Results
    • Data Privacy
      • Access to Customer Data
      • Data Retention
      • Cloud Endpoints
    • Support
Powered by GitBook
On this page
  • Examples
  • Options
  • --ci-build-id
  • -k, --key
  • -p, --project-id
  • -t, --tag
  • --pwc-config <path>
  • --pwc-remove-title-tags
  • --pwc-disable-title-tags
  • --pwc-cancel-after-failures <number | false>
  • --pwc-debug [boolean | "remote" | "full"]
  • --pwc-output-file <path>
  • --pwc-coverage <project-name>
  • --pwc-coverage-dir <path>
  • -V, --version
  • -h, --help

Was this helpful?

  1. Resources
  2. Reporters
  3. @currents/playwright

pwc

pwc command-line executable documentation

PreviousConfigurationNextpwc-p (orchestration)

Last updated 1 day ago

Was this helpful?

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 .

> pwc [options] [playwright arguments and flags]

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

----------------------------------------------------
📖 Documentation: https://docs.currents.dev
🤙 Support:       support@currents.dev
----------------------------------------------------

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


-k, --key


-p, --project-id


-t, --tag


--pwc-config <path>


--pwc-remove-title-tags


--pwc-disable-title-tags


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


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


--pwc-coverage <project-name>


--pwc-coverage-dir <path>


-V, --version

Show package version


-h, --help

Show pwc help

The unique identifier for a run. See

Your secret Record Key obtained from Currents. See .

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

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

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

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

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

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

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

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 reports directory path. See .

Configuration Sources
ciBuildId *
recordKey *
projectId *
tag
Configuration Sources
removeTitleTags
disableTitleTags
cancelAfterFailures
outputFile
coverage.projects
coverage.dir