selenium-webdriver/README.md

The official WebDriver JavaScript bindings from the Selenium project

# selenium-webdriver

JavaScript language bindings for [Selenium WebDriver](https://www.selenium.dev).
Selenium automates browsers for testing and web-based task automation.

Requires Node.js >= 20.

## Installation

```bash
npm install selenium-webdriver
```

## Quick Start

```javascript
const { Builder, Browser } = require('selenium-webdriver')

;(async function example() {
  let driver = await new Builder().forBrowser(Browser.CHROME).build()
  try {
    await driver.get('https://www.selenium.dev')
    console.log(await driver.getTitle())
  } finally {
    await driver.quit()
  }
})()
```

Selenium Manager automatically handles browser driver installation — no manual driver setup required.

## Configuring the Builder

The `Builder` sets default options for all browsers in a single chain; options
for non-selected browsers are dropped at `build()` time. The target browser can
be swapped at runtime via the `SELENIUM_BROWSER` environment variable.

```javascript
const { Builder, Browser } = require('selenium-webdriver')
const chrome = require('selenium-webdriver/chrome')
const firefox = require('selenium-webdriver/firefox')

let driver = new Builder()
  .forBrowser(Browser.FIREFOX)
  .setChromeOptions(new chrome.Options())
  .setFirefoxOptions(new firefox.Options())
  .build()
```

## Running Against a Remote Server

To run scripts against a [Selenium Grid](https://www.selenium.dev/documentation/grid/)
or standalone server, point the Builder at the server URL, or set
`SELENIUM_REMOTE_URL`:

```javascript
let driver = new Builder().forBrowser(Browser.CHROME).usingServer('http://localhost:4444').build()
```

```bash
SELENIUM_REMOTE_URL="http://localhost:4444" node script.js
```

## Node Support Policy

Each `selenium-webdriver` release targets the latest _semver-minor_ of Node's
[LTS and Current releases](https://github.com/nodejs/release#release-schedule).

| Level         | Guarantee                                                                 |
| :------------ | :------------------------------------------------------------------------ |
| _supported_   | API compatible without runtime flags; bugs investigated and fixed.        |
| _best effort_ | Bugs investigated as time permits; API compatibility only where required. |
| _unsupported_ | Bug reports closed as will-not-fix; API compatibility not guaranteed.     |

Versions older than the active LTS, unstable release branches (e.g. `v.Next`),
and _semver-major_ Node releases outside the LTS / Current pair are _unsupported_.

## Documentation

- [Getting Started](https://www.selenium.dev/documentation/webdriver/getting_started/)
- [JavaScript API Docs](https://www.selenium.dev/selenium/docs/api/javascript/)
- [Selenium Manager](https://www.selenium.dev/documentation/selenium_manager/)
- [Selenium Grid](https://www.selenium.dev/documentation/grid/)

## Support

- [Selenium Chat](https://www.selenium.dev/support/#ChatRoom)
- [GitHub Issues](https://github.com/SeleniumHQ/selenium/issues)

## Contributing

Contributions are welcome via [GitHub](https://github.com/SeleniumHQ/selenium/) pull requests.
See the [source code](https://github.com/SeleniumHQ/selenium/tree/trunk/javascript/selenium-webdriver) for this binding.

## Links

- [npm](https://www.npmjs.com/package/selenium-webdriver)
- [Documentation](https://www.selenium.dev/documentation/?tab=javascript)

## License

Licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).