# pwc

`pwc` is a lightweight command-line executable that runs Playwright with a few pre-configured options.

`pwc` allows providing [Configuration](/resources/reporters/currents-playwright/configuration.md) options via CLI flags. Additionally, is passes down CLI flags to the underlying `playwright` command.

{% hint style="success" %}
We recommended using `currents.config.ts` file. See [Configuration](/resources/reporters/currents-playwright/configuration.md#configuration-sources).
{% endhint %}

```bash
> 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`**

The unique identifier for a run. See [Configuration](/resources/reporters/currents-playwright/configuration.md#cibuildid)

***

### **`-k, --key`**

Your secret Record Key obtained from Currents. See [Configuration](/resources/reporters/currents-playwright/configuration.md#recordkey).

***

### **`-p, --project-id`**

The project ID for results reporting obtained from Currents. See [Configuration](/resources/reporters/currents-playwright/configuration.md#projectid).

***

### **`-t, --tag`**

Comma-separated tag(s) for recorded runs in Currents. See [Configuration](/resources/reporters/currents-playwright/configuration.md#tag).

***

### **`--pwc-config <path>`**

Path to currents config file `currents.config.[ts|js]`. See [Configuration](/resources/reporters/currents-playwright/configuration.md#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 [Configuration](/resources/reporters/currents-playwright/configuration.md#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 [Configuration](/resources/reporters/currents-playwright/configuration.md#disabletitletags).

***

### **`--pwc-disable-test-tags`**

Prevent reporting tags defined in the test title or by test annotations (default: false). See [Configuration](/resources/reporters/currents-playwright/configuration.md#disabletesttags).

***

### **`--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 [Configuration](/resources/reporters/currents-playwright/configuration.md#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](/guides/troubleshooting-playwright.md).

***

### **`--pwc-output-file <path>`**

File path for run summary output in JSON format. See [Configuration](/resources/reporters/currents-playwright/configuration.md#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 [/pages/EHsfSVxG1TmUz6UOD0WZ#coverage.projects](https://docs.currents.dev/resources/reporters/currents-playwright/pages/EHsfSVxG1TmUz6UOD0WZ#coverage.projects "mention").

***

### **`--pwc-coverage-dir <path>`**

Coverage reports directory path. See [/pages/EHsfSVxG1TmUz6UOD0WZ#coverage.dir](https://docs.currents.dev/resources/reporters/currents-playwright/pages/EHsfSVxG1TmUz6UOD0WZ#coverage.dir "mention").

***

### **`--pwc-console-output <preset>`**

Reporter console output. See [Configuration](/resources/reporters/currents-playwright/configuration.md#consoleoutput).

***

### **`-V, --version`**

Show package version

***

### **`-h, --help`**

Show `pwc` help


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.currents.dev/resources/reporters/currents-playwright/pwc.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.