# pwc

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

`pwc` allows providing [configuration](https://docs.currents.dev/resources/reporters/currents-playwright/configuration "mention") 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-sources](https://docs.currents.dev/resources/reporters/configuration#configuration-sources "mention").
{% 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 [#cibuildid](https://docs.currents.dev/resources/reporters/configuration#cibuildid "mention")

***

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

Your secret Record Key obtained from Currents. See [#recordkey](https://docs.currents.dev/resources/reporters/configuration#recordkey "mention").

***

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

The project ID for results reporting obtained from Currents. See [#projectid](https://docs.currents.dev/resources/reporters/configuration#projectid "mention").

***

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

Comma-separated tag(s) for recorded runs in Currents. See [#tag](https://docs.currents.dev/resources/reporters/configuration#tag "mention").

***

### **`--pwc-config <path>`**&#x20;

Path to currents config file `currents.config.[ts|js]`. See [#configuration-sources](https://docs.currents.dev/resources/reporters/configuration#configuration-sources "mention").

***

### **`--pwc-remove-title-tags`**&#x20;

Remove tags from test names in Currents, e.g. `Test name @smoke` becomes `Test name` in the dashboard (default: false). See [#removetitletags](https://docs.currents.dev/resources/reporters/configuration#removetitletags "mention").

***

### **`--pwc-disable-title-tags`**&#x20;

Disable parsing tags from test title, e.g. `Test name @smoke` would **not** have tag  `smoke` in the dashboard (default: false).  See [#disabletitletags](https://docs.currents.dev/resources/reporters/configuration#disabletitletags "mention").

***

### **`--pwc-disable-test-tags`**&#x20;

Prevent reporting tags defined in the test title or by test annotations (default: false).  See [#disabletesttags](https://docs.currents.dev/resources/reporters/configuration#disabletesttags "mention").

***

### **`--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](https://docs.currents.dev/resources/reporters/configuration#cancelafterfailures "mention").

***

### **`--pwc-debug [boolean | "remote" | "full"]`**

Enable collecting debug logs for the reporter (default: false).&#x20;

* `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](https://docs.currents.dev/guides/troubleshooting-playwright "mention").

***

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

File path for run summary output in JSON format. See [#outputfile](https://docs.currents.dev/resources/reporters/configuration#outputfile "mention").

***

### **`--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](https://docs.currents.dev/resources/reporters/configuration#coverage.projects "mention").

***

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

Coverage reports directory path. See [#coverage.dir](https://docs.currents.dev/resources/reporters/configuration#coverage.dir "mention").&#x20;

***

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

Reporter console output. See [#consoleoutput](https://docs.currents.dev/resources/reporters/configuration#consoleoutput "mention").

***

### **`-V, --version`**&#x20;

Show package version

***

### **`-h, --help`**&#x20;

Show `pwc` help