The definitive source of the best
JavaScript libraries, frameworks, and plugins.

  • ×


    UI automated testing framework based on node.js and selenium webdriver
    Filed under 

    • 🔾85%Overall
    • 10,408
    • 3.1 days
    • 🕩1032
    • 👥15


    Homepage | Getting Started | Developer Guide | API Reference | About

    Automated end-to-end testing framework powered by Node.js and using W3C Webdriver (formerly Selenium).

    Nightwatch is a complete and integrated solution for end-to-end testing of web applications and websites, and also for Node.js unit and integration testing.

    npm Build Status Coverage Status npm package Join the chat at Twitter Follow

    Changelog | Mailing List | nightwatch.js tag on StackOverflow

    Nightwatch v1.4

    We're delighted to announce the release of Nightwatch v1.4. Please see the upgrade guide if you are upgrading from a pre v1.0 version.

    Up & Running in 2 Minutes:

    1. Install Nightwatch from NPM

    $ npm install nightwatch --save-dev

    2. Install Browser Drivers:

    Geckodriver (Firefox):

    Geckodriver is the WebDriver service used to drive the Mozilla Firefox Browser.

    $ npm install geckodriver --save-dev

    Chromedriver is the WebDriver service used to drive the Google Chrome Browser.

    $ npm install chromedriver --save-dev

    or install everything with one line:

    $ npm i nightwatch geckodriver chromedriver --save-dev

    3. Run a Demo Test:

    Nightwatch comes with an examples folder containing a few sample tests.

    Below will run a basic test which opens the search engine, searches for the term "nightwatch", and verifies if the term first result is the Nightwatch.js website.

    $ ./node_modules/.bin/nightwatch node_modules/nightwatch/examples/tests/ecosia.js

    Windows users might need to run node node_modules/.bin/nightwatch.

    Manually Download Browser Drivers

    Nightwatch uses a WebDriver compatible server to control the browser. WebDriver is a W3C specification and industry standard which provides a platform and HTTP protocol to interact with a browser.

    Nightwatch includes support for automatically managing the following services:


    Starting with version 75, Chromedriver has W3C Webdriver protocol enabled by default. If you'd like to stick to the JSONWire for now adjust the chromeOptions:

    desiredCapabilities : {
      browserName : 'chrome',
      chromeOptions: {
        w3c: false


    Selenium Standalone Server

    It's important to note that, while the Selenium Server was required with older Nightwatch versions (v0.9 and prior), starting with version 1.0 Selenium is no longer necessary.

    Specific WebDriver setup guides can be found on the Docs website. Legacy Selenium drivers setup guides along with debugging instructions can be found on the Wiki.


    Example tests are included in the examples folder which demonstrate the usage of several Nightwatch features.

    You can also check out the nightwatch-website-tests repo for example tests against the website.

    Nightwatch unit tests

    The tests for Nightwatch are written using Mocha.

    1. Clone the project

    $ git clone
    $ cd nightwatch
    $ npm install

    2. Run tests

    To run the complete test suite:

    $ npm test

    To check test coverage, run the command:

    $ npm run mocha-coverage

    and then open the generated coverage/index.html file in your browser.

    Support Nightwatch

    Nightwatch is built by @pineviewlabs - an independent software consultancy based in Oslo, Norway, with help from our contributors.

    Please consider supporting Nightwatch by becoming a backer or sponsor on the OpenCollective platform.

    Show All