\n
\n\n## Quickstart\n\n```js\n// playwright-extra is a drop-in replacement for playwright,\n// it augments the installed playwright with plugin functionality\nconst { chromium } = require('playwright-extra')\n\n// Load the stealth plugin and use defaults (all tricks to hide playwright usage)\n// Note: playwright-extra is compatible with most puppeteer-extra plugins\nconst stealth = require('puppeteer-extra-plugin-stealth')()\n\n// Add the plugin to playwright (any number of plugins can be added)\nchromium.use(stealth)\n\n// That's it, the rest is playwright usage as normal 😊\nchromium.launch({ headless: true }).then(async browser => {\n const page = await browser.newPage()\n\n console.log('Testing the stealth plugin..')\n await page.goto('https://bot.sannysoft.com', { waitUntil: 'networkidle' })\n await page.screenshot({ path: 'stealth.png', fullPage: true })\n\n console.log('All done, check the screenshot. ✨')\n await browser.close()\n})\n```\n\nThe above example uses the compatible [`stealth`](/packages/puppeteer-extra-plugin-stealth) plugin from puppeteer-extra, that plugin needs to be installed as well:\n\n```bash\nyarn add puppeteer-extra-plugin-stealth\n# - or -\nnpm install puppeteer-extra-plugin-stealth\n```\n\nIf you'd like to see debug output just run your script like so:\n\n```bash\n# macOS/Linux (Bash)\nDEBUG=playwright-extra*,puppeteer-extra* node myscript.js\n\n# Windows (Powershell)\n$env:DEBUG='playwright-extra*,puppeteer-extra*';node myscript.js\n```\n\n### More examples\n\nChangelog
\n\n> Please check the `announcements` channel in our [discord server](https://extra.community) until we've automated readme updates. :)\n\n- **v4.3**\n - Rerelease due to versioning issues with previous beta packages\n- **v3.3**\n - Initial public release\n\n
\n\n`playwright-extra` and most plugins are written in TS, so you get perfect type support out of the box. :)\n\n```ts\n// playwright-extra is a drop-in replacement for playwright,\n// it augments the installed playwright with plugin functionality\nimport { chromium } from 'playwright-extra'\n\n// Load the stealth plugin and use defaults (all tricks to hide playwright usage)\n// Note: playwright-extra is compatible with most puppeteer-extra plugins\nimport StealthPlugin from 'puppeteer-extra-plugin-stealth'\n\n// Add the plugin to playwright (any number of plugins can be added)\nchromium.use(StealthPlugin())\n\n// ...(the rest of the quickstart code example is the same)\nchromium.launch({ headless: true }).then(async browser => {\n const page = await browser.newPage()\n\n console.log('Testing the stealth plugin..')\n await page.goto('https://bot.sannysoft.com', { waitUntil: 'networkidle' })\n await page.screenshot({ path: 'stealth.png', fullPage: true })\n\n console.log('All done, check the screenshot. ✨')\n await browser.close()\n})\n```\n\nNew to Typescript? Here it is in 30 seconds or less 😄:\n\n```bash\n# Optional: If you don't have yarn yet\nnpm i --global yarn\n\n# Optional: Create new package.json if it's a new project\nyarn init -y\n\n# Add basic typescript dependencies\nyarn add --dev typescript @types/node esbuild esbuild-register\n\n# Bootstrap a tsconfig.json\nyarn tsc --init --target ES2020 --lib ES2020 --module commonjs --rootDir src --outDir dist\n\n# Add dependencies used in the quick start example\nyarn add playwright playwright-extra puppeteer-extra-plugin-stealth\n\n# Create source folder for the .ts files\nmkdir src\n\n# Now place the example code above in `src/index.ts`\n\n# Run the typescript code without the need of compiling it first\nnode -r esbuild-register src/index.ts\n\n# You can now add Typescript to your CV 🎉\n```\n\n
\nTypeScript & ESM usage
\n\n`playwright-extra` and most plugins are written in TS, so you get perfect type support out of the box. :)\n\n```ts\n// playwright-extra is a drop-in replacement for playwright,\n// it augments the installed playwright with plugin functionality\nimport { chromium } from 'playwright-extra'\n\n// Load the stealth plugin and use defaults (all tricks to hide playwright usage)\n// Note: playwright-extra is compatible with most puppeteer-extra plugins\nimport StealthPlugin from 'puppeteer-extra-plugin-stealth'\n\n// Add the plugin to playwright (any number of plugins can be added)\nchromium.use(StealthPlugin())\n\n// ...(the rest of the quickstart code example is the same)\nchromium.launch({ headless: true }).then(async browser => {\n const page = await browser.newPage()\n\n console.log('Testing the stealth plugin..')\n await page.goto('https://bot.sannysoft.com', { waitUntil: 'networkidle' })\n await page.screenshot({ path: 'stealth.png', fullPage: true })\n\n console.log('All done, check the screenshot. ✨')\n await browser.close()\n})\n```\n\nNew to Typescript? Here it is in 30 seconds or less 😄:\n\n```bash\n# Optional: If you don't have yarn yet\nnpm i --global yarn\n\n# Optional: Create new package.json if it's a new project\nyarn init -y\n\n# Add basic typescript dependencies\nyarn add --dev typescript @types/node esbuild esbuild-register\n\n# Bootstrap a tsconfig.json\nyarn tsc --init --target ES2020 --lib ES2020 --module commonjs --rootDir src --outDir dist\n\n# Add dependencies used in the quick start example\nyarn add playwright playwright-extra puppeteer-extra-plugin-stealth\n\n# Create source folder for the .ts files\nmkdir src\n\n# Now place the example code above in `src/index.ts`\n\n# Run the typescript code without the need of compiling it first\nnode -r esbuild-register src/index.ts\n\n# You can now add Typescript to your CV 🎉\n```\n\n
\n
\n\n```ts\n// Any browser supported by playwright can be used with plugins\nimport { chromium, firefox, webkit } from 'playwright-extra'\n\nchromium.use(plugin)\nfirefox.use(plugin)\nwebkit.use(plugin)\n```\n\n
\nUsing different browsers
\n\n```ts\n// Any browser supported by playwright can be used with plugins\nimport { chromium, firefox, webkit } from 'playwright-extra'\n\nchromium.use(plugin)\nfirefox.use(plugin)\nwebkit.use(plugin)\n```\n\n
\n
\n\nNode.js imports are cached, therefore the default `chromium`, `firefox`, `webkit` export from `playwright-extra` will always return the same playwright instance.\n\n```ts\n// Use `addExtra` to create a fresh and independent instance\nimport playwright from 'playwright'\nimport { addExtra } from 'playwright-extra'\n\nconst chromium1 = addExtra(playwright.chromium)\nconst chromium2 = addExtra(playwright.chromium)\n\nchromium1.use(onePlugin)\nchromium2.use(anotherPlugin)\n// chromium1 and chromium2 are independent\n```\n\n
\n\n---\n\n## Plugins\n\nWe're currently in the process of making the existing [puppeteer-extra](/packages/puppeteer-extra) plugins compatible with playwright-extra, the following plugins have been successfully tested already:\n\n### 🔥 [`puppeteer-extra-plugin-stealth`](/packages/puppeteer-extra-plugin-stealth)\n\n- Applies various evasion techniques to make detection of an automated browser harder\n- Compatible with Puppeteer & Playwright and chromium based browsers\n\nMultiple instances with different plugins
\n\nNode.js imports are cached, therefore the default `chromium`, `firefox`, `webkit` export from `playwright-extra` will always return the same playwright instance.\n\n```ts\n// Use `addExtra` to create a fresh and independent instance\nimport playwright from 'playwright'\nimport { addExtra } from 'playwright-extra'\n\nconst chromium1 = addExtra(playwright.chromium)\nconst chromium2 = addExtra(playwright.chromium)\n\nchromium1.use(onePlugin)\nchromium2.use(anotherPlugin)\n// chromium1 and chromium2 are independent\n```\n\n
\n
\n\n### 🏴 [`puppeteer-extra-plugin-recaptcha`](/packages/puppeteer-extra-plugin-recaptcha)\n\n- Solves reCAPTCHAs and hCaptchas automatically, using a single line of code: `page.solveRecaptchas()`\n- Compatible with Puppeteer & Playwright and all browsers (chromium, firefox, webkit)\nExample: Using stealth in Playwright with custom options
\n\n```js\n// The stealth plugin is optimized for chromium based browsers currently\nimport { chromium } from 'playwright-extra'\n\nimport StealthPlugin from 'puppeteer-extra-plugin-stealth'\nchromium.use(StealthPlugin())\n\n// New way to overwrite the default options of stealth evasion plugins\n// https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-stealth/evasions\nchromium.plugins.setDependencyDefaults('stealth/evasions/webgl.vendor', {\n vendor: 'Bob',\n renderer: 'Alice'\n})\n\n// That's it, the rest is playwright usage as normal 😊\nchromium.launch({ headless: true }).then(async browser => {\n const page = await browser.newPage()\n\n console.log('Testing the webgl spoofing feature of the stealth plugin..')\n await page.goto('https://webglreport.com', { waitUntil: 'networkidle' })\n await page.screenshot({ path: 'webgl.png', fullPage: true })\n\n console.log('All done, check the screenshot. ✨')\n await browser.close()\n})\n```\n\n\n
\n\n### 🆕 [`plugin-proxy-router`](/packages/plugin-proxy-router)\n\n- Use multiple proxies dynamically with flexible per-host routing and more\n- Compatible with Puppeteer & Playwright and all browsers (chromium, firefox, webkit)\n\n**Notes**\n\n- If you're in need of adblocking use [this package](https://www.npmjs.com/package/@cliqz/adblocker-playwright) or [block resources natively](https://github.com/berstend/puppeteer-extra/wiki/Block-resources-without-request-interception)\n- We're focussing on compatiblity with existing plugins at the moment, more documentation on how to write your own playwright-extra plugins will follow\n\n---\n\n## Contributors\n\n\n