Next-gen browser and mobile automation test framework for Node.js.

Homepage | Developer Guide | API Reference | Contribute | Changelog | Roadmap

WebdriverIO is a test automation framework, for e2e as well as unit and component testing in the browser, that allows you to run tests based on the WebDriver and WebDriver BiDi as well as Appium automation technology. It provides support for your favorite BDD/TDD test framework and will run your tests locally or in the cloud using Sauce Labs, BrowserStack, TestingBot or LambdaTest.

:woman_technologist: :man_technologist: Contributing

Do you like WebdriverIO and want to help make it better? Awesome! Have a look into our Contributor Documentation to get started and find out what contributions can be and how to make them.

Getting started with GitHub Codespaces

To get started, create a codespace for this repository by clicking this 👇

A codespace will open in a web-based version of Visual Studio Code. The dev container is fully configured with the software needed for this project.

Note: Dev containers are an open spec that is supported by GitHub Codespaces and other tools.

Getting started with Gitpod

You can also just click on:

to get a ready-to-use development environment for you to start working on this code base.

If you're looking for issues to help out with, check out the issues labeled "good first pick". You can also reach out to our Matrix Channel if you have questions on where to start contributing.

:office: WebdriverIO for Enterprise

Available as part of the Tidelift Subscription.

The maintainers of WebdriverIO and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open-source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

:package: Packages

This repository contains some of the core packages of the WebdriverIO project. There are many wonderful curated resources the WebdriverIO community has put together.

Did you build a WebdriverIO service or reporter? That's awesome! Please add it to our configuration wizard and docs (e.g. like in this example commit) as well as to our awesome-webdriverio list. Thank you! 🙏 ❤️

Core

• webdriver - A Node.js bindings implementation for the W3C WebDriver and Mobile JSONWire Protocol
• webdriverio - Next-gen browser and mobile automation test framework for Node.js
• @wdio/cli - A WebdriverIO testrunner command line interface

Helper

• @wdio/config - A helper utility to parse and validate WebdriverIO options
• @wdio/logger - A helper utility for logging WebdriverIO packages
• @wdio/protocols - Utility package providing information about automation protocols
• @wdio/repl - A WDIO helper utility to provide a repl interface for WebdriverIO
• @wdio/reporter - A WebdriverIO utility to help report all events
• @wdio/runner - A WebdriverIO service that runs tests in arbitrary environments
• @wdio/utils - A WDIO helper utility to provide several utility functions used across the project
• @wdio/globals - A WDIO helper utility for importing global variables directly

Reporter

• @wdio/allure-reporter - A WebdriverIO reporter plugin to create Allure Test Reports
• @wdio/concise-reporter - A WebdriverIO reporter plugin to create concise test reports
• @wdio/dot-reporter - A WebdriverIO plugin to report in dot style
• @wdio/junit-reporter - A WebdriverIO reporter that creates test results in XML format
• @wdio/spec-reporter - A WebdriverIO plugin to report in spec style
• @wdio/sumologic-reporter - A WebdriverIO reporter that sends test results to Sumologic for data analyses

Services

• @wdio/appium-service - A WebdriverIO service to start & stop Appium Server
• @wdio/browserstack-service - A WebdriverIO service that can be used to use BrowserStack Test Observability which is a reporting, debugging, and test suite quality tracking tool for any test running anywhere. The service also helps for a better integration with the BrowserStack grid if you're running tests on the grid.
• @wdio/lighthouse-service - A WebdriverIO service that integrates Google Lighthouse commands to use it for automate tests
• @wdio/firefox-profile-service - A WebdriverIO service that lets you define your Firefox profile in your wdio.conf.js
• @wdio/sauce-service - A WebdriverIO service that provides a better integration into Sauce Labs
• @wdio/shared-store-service - A WebdriverIO service to exchange data across processes
• @wdio/testingbot-service - A WebdriverIO service that provides a better integration into TestingBot

Runner

• @wdio/local-runner - A WebdriverIO runner to run tests locally
• @wdio/browser-runner - A WebdriverIO runner to run unit or component tests in the browser

Framework Adapters

• @wdio/cucumber-framework - Adapter for Cucumber testing framework
• @wdio/jasmine-framework - Adapter for Jasmine testing framework
• @wdio/mocha-framework - Adapter for Mocha testing framework.

Others

• eslint-plugin-wdio - Eslint rules for WebdriverIO
• @wdio/smoke-test-reporter - A WebdriverIO utility to smoke test reporters for internal testing purposes
• @wdio/smoke-test-service - A WebdriverIO utility to smoke test services for internal testing purposes
• @wdio/webdriver-mock-service - A WebdriverIO service to stub all endpoints for internal testing purposes

Infrastructure Packages

These packages are not released to NPM and used to work on this codebase.

• @wdio/compiler - Esbuild script to compile the source code all of all packages
• @wdio/lerna-patch - This sub-package is being used to patch Lerna to not run pnpm install after it prepared all packages for release

:handshake: Project Governance

This project is maintained by awesome people following a common set of rules and treating each other with respect and appreciation.

:man_cook: :woman_cook: Backers

Become a backer and show your support for our open-source project.

:money_with_wings: Sponsors

Does your company use WebdriverIO? Ask your manager or marketing team if your company would be interested in supporting our project. Support will allow the maintainers to dedicate more time to maintenance and new features for everyone. Also, your company's logo will show on GitHub - who doesn't want a little extra exposure? Here's the info.

💎 Premium Sponsor

We are immensely grateful to our exclusive Premium Sponsor for their invaluable support in the development of this project:

🥇 Gold Sponsor

🥈 Silver Sponsor

🥉 Bronze Sponsor

:page_facing_up: License

MIT

:beginner: Badge

Show the world you're using webdriver.io →

GitHub markup

[![tested with webdriver.io](https://img.shields.io/badge/tested%20with-webdriver.io-%23ea5906)](https://webdriver.io/)

HTML

<a href="https://webdriver.io/">
    <img alt="WebdriverIO" src="https://img.shields.io/badge/tested%20with-webdriver.io-%23ea5906">
</a>

:clap: Supporters