![\"playwright-bdd\"](\"./docs/logo.svg\"){kind=logo}
\n \n\n \n\n 🚀 Getting Started \n 📚 Documentation \n ▶️ Example \n 📝 Changelog\n
\n\n## Why BDD in the Era of AI?\n\n[Behavior-Driven Development (BDD)](https://cucumber.io/docs/bdd/) describes requirements through `Given / When / Then` steps, giving AI agents a clear, executable target. These steps are easy to read and refine during planning. They set practical constraints for generated code. They run as tests and stay aligned with the implementation over time, unlike plain markdown specs that tend to grow into walls of text.\n\nTry the [playwright-bdd skill](https://vitalets.github.io/playwright-bdd/#/getting-started/agent-skill) to bring the agentic BDD workflow into your project.\n\n## Why Playwright Runner?\n\nPlaywright can be used as a [browser automation library](https://playwright.dev/docs/library) with any test runner, such as CucumberJS or Vitest. However, it is most powerful when used with the **Playwright test runner**. Playwright-BDD converts BDD scenarios into native Playwright tests, so you get all Playwright runner features out of the box:\n\n- Automatic browser setup and cleanup\n- Auto-waiting for page elements\n- Auto-capture of screenshots, videos, and traces\n- Parallel execution and sharding\n- Built-in reports and visual comparison testing\n- Playwright fixtures\n- [...and more](https://playwright.dev/docs/library#key-differences)\n\n## How It Works\n\n![](\"https://raw.githubusercontent.com/vitalets/playwright-bdd/refs/heads/main/docs/_media/schema.png\"/)
\n\n## Extras\nPlaywright-BDD has several unique features:\n\n- 🔥 Advanced tagging [by path](https://vitalets.github.io/playwright-bdd/#/writing-features/tags-from-path) and [special tags](https://vitalets.github.io/playwright-bdd/#/writing-features/special-tags)\n- 🎩 [Step decorators](https://vitalets.github.io/playwright-bdd/#/writing-steps/decorators) for class methods \n- 🎯 [Scoped step definitions](https://vitalets.github.io/playwright-bdd/#/writing-steps/scoped) \n- ✨ [Exporting steps](https://vitalets.github.io/playwright-bdd/#/writing-features/chatgpt) for AI \n- ♻️ [Re-usable step functions](https://vitalets.github.io/playwright-bdd/#/writing-steps/reusing-step-fn) \n\n## Documentation\nCheck out the [documentation website](https://vitalets.github.io/playwright-bdd/#/).\n\n## Demos\n\n- Check out [`examples`](/examples) folder\n- Clone the fully working repo: [playwright-bdd-example](https://github.com/vitalets/playwright-bdd-example)\n\n## Playwright Versions Support\n\n`playwright-bdd` supports all **non-deprecated** versions of Playwright. To check which Playwright versions are currently deprecated, run:\n```bash\nnpm show @playwright/test@1 deprecated\n```\n\n## Changelog\nCheck out the latest changes in the [CHANGELOG.md](https://github.com/vitalets/playwright-bdd/blob/main/CHANGELOG.md).\n\n## 💖 Sponsors\n\nGreat thanks to the **amazing people and companies** already supporting Playwright-BDD! Your help keeps the project alive and growing:\n\n\n \n ![\"Currents\"](\"./docs/_media/sponsors/currents.svg\")
\n \n
\n\n ![\"TestMu](\"./docs/_media/sponsors/testmu-ai-white.svg\")
\n
\n\n![\"User](\"https://github.com/alescinskis.png\")
![\"User](\"https://github.com/alexhvastovich.png\")
![\"User](\"https://github.com/FrancescoBorzi.png\")
\n\n