![](\"https://static.currents.dev/currents-playwright-banner-gh.png\")
\n\n \n
\nDocumentation | Currents\n\n
\n\n- Saves [traces, videos, screenshots and console output to a cloud](https://currents.dev/playwright#debug-failures-smash-flaky-tests)\n- Fetches [git information and associated with CI builds](https://currents.dev/playwright#collecting-and-reviewing-playwright-executions)\n- Integrates with your workflow - [Slack, GitHub or GitLabPR comments and status checks](https://currents.dev/playwright#integrations)\n- Flakiness, failure rate, duration and much more [reports](https://currents.dev/playwright#analytics-to-drive-your-testing-strategy)\n- Powerful [history and trends browser](https://currents.dev/playwright#tests-executions-history) on test or spec level\n- Common errors tracker\n- [Monitoring test health with automated reporting](https://currents.dev/playwright#monitoring-test-suite-performance)\n- Up to 40% faster CI Playwright tests with [Orchestration for Playwright](https://currents.dev/posts/playwright-reporter-1.0.0#orchestration-for-playwright) - better than native Playwright sharding\n- [Streaming Playwright test progress](https://currents.dev/posts/playwright-reporter-1.0.0#step-level-reporting) to cloud dashboard for each individual step for crash-resilient reporting\n- REST API and HTTP Webhooks\n\n---\n\n## Requirements\n\n- NodeJS 14.0.0+\n- Playwright 1.22.2+\n\n## Install\n\n```sh\nnpm install @currents/playwright\n```\n\n## Enable traces, screenshots and videos\n\n```js\nuse: {\n // ...\n trace: \"on\",\n video: \"on\",\n screenshot: \"on\",\n}\n```\n\n## Usage\n\nChoose the preferred launch method:\n\n- executing a `pwc` CLI command - it runs playwright with a predefined configuration\n- add `@currents/playwright` reporter to Playwright configuration file\n\n### `pwc` CLI\n\nWe need to pass three parameters to run `pwc`:\n\n- our [record key](https://docs.currents.dev/guides/record-key)\n- the project ID, which is created when you create a project in the Current dashboard\n- the [CI build ID](https://docs.currents.dev/guides/ci-build-id)\n\nThe command passes down all the other CLI flags to the Playwright test runner as-is. We can pass these as command line arguments, as environment variables, or a mixture of both.\n\n```sh\npwc --project-id PROJECT_ID --key RECORD_KEY --ci-build-id hello-currents --tag tagA,tagB\n```\n\n### `@currents/playwright` reporter\n\nAlternatively, you can manually add the reporter to playwright configuration and keep using `playwright test` CLI command.\n\n```ts\nimport type { PlaywrightTestConfig } from \"@playwright/test\";\nimport { currentsReporter } from \"@currents/playwright\";\n\nconst currentsConfig = {\n ciBuildId: process.env.CURRENTS_CI_BUILD_ID,\n recordKey: process.env.CURRENTS_RECORD_KEY,\n projectId: process.env.CURRENTS_PROJECT_ID,\n tag: [\"runTagA\", \"runTagB\"],\n};\n\nconst config: PlaywrightTestConfig = {\n reporter: [currentsReporter(currentsConfig)],\n};\n\nexport default config;\n```\n\nYou can also provide configuration by setting environment variables before running `playwright` command\n\n```sh\nCURRENTS_RECORD_KEY=RECORD_KEY CURRENTS_PROJECT_ID=PROJECT_ID CURRENTS_CI_BUILD_ID=hello-currents CURRENTS_TAG=tagA,tagB npx playwright test\n```\n\n## Examples\n\nRun all tests in the current directory:\n\n`pwc --key