Proxy for using W3C WebDriver-compatible clients to interact with Gecko-based browsers.

This program provides the HTTP API described by the WebDriver protocol to communicate with Gecko browsers, such as Firefox. It translates calls into the Marionette automation protocol by acting as a proxy between the local- and remote ends.

You can consult the change log for a record of all notable changes to the program. Releases are made available on GitHub on supported platforms.

Marionette and geckodriver are not yet feature complete. This means that they do not yet offer full conformance with the WebDriver standard or complete compatibility with Selenium. You can track the implementation status of the latest Firefox Nightly on MDN. We also keep track of known Marionette, Selenium, and specification problems in our issue tracker.

Support is best in Firefox 48 and onwards, although generally the more recent the Firefox version, the better the experience as they have more bug fixes and features. We strongly advise using the latest Firefox Nightly with geckodriver, and want to make it clear that Firefox 47 and earlier is explicitly not supported. Since Windows XP support in Firefox will be dropped with Firefox 53, we do not support this platform.

geckodriver supports a number of WebDriver capabilities:

geckodriver also supports a capability named moz:firefoxOptions which takes Firefox-specific options. This must be a dictionary and may contain any of the following fields:

To select a specific Firefox binary and run it with a specific command-line flag, set a preference, and enable verbose logging:

{
	"moz:firefoxOptions": {
		"binary": "/usr/local/firefox/bin/firefox",
		"args": ["--no-remote"],
		"prefs": {
			"dom.ipc.processCount": 8
		},
		"log": {
			"level": "trace"
		}
	}
}

Usage steps are documented on MDN, but the gist of it is this:

% geckodriver -b /usr/bin/firefox

Or if you’re on Mac:

% geckodriver -b /Applications/FirefoxNightly.app/Contents/MacOS/firefox-bin

You may also see all flags and options available in geckodriver by viewing the help message:

% geckodriver -h
geckodriver 0.11.1
WebDriver implementation for Firefox.

USAGE:
    geckodriver [FLAGS] [OPTIONS]

FLAGS:
        --connect-existing    Connect to an existing Firefox instance
    -h, --help                Prints help information
    -v                        Log level verbosity (-v for debug and -vv for
                              trace level)
    -V, --version             Prints version and copying information

OPTIONS:
    -b, --binary <BINARY>           Path to the Firefox binary
        --log <LEVEL>
            Set Gecko log level [values: fatal, error, warn, info, config,
            debug, trace]
        --marionette-port <PORT>
            Port to use to connect to Gecko (default: random free port)
        --host <HOST>
            Host ip to use for WebDriver server (default: 127.0.0.1)
    -p, --port <PORT>
            Port to use for WebDriver server (default: 4444)

geckodriver is written in Rust and you need the Rust toolchain to compile it.

To build the project for release, ensure you do a compilation with optimisations:

% cargo build --release

Or if you want a non-optimised binary for debugging:

% cargo build