Installation

Via Installer

Creating a new project via create-codeceptjs installer (opens new window) is the simplest way to start

Install CodeceptJS + Playwright into current directory

npx create-codeceptjs .

Install CodeceptJS + Puppeteer into current directory

npx create-codeceptjs . --puppeteer

Install CodeceptJS + webdriverio into current directory

npx create-codeceptjs . --webdriverio

Install CodeceptJS + webdriverio into e2e-tests directory:

npx create-codeceptjs e2e-tests --webdriverio

Local

Use NPM install CodeceptJS:

npm install --save-dev codeceptjs

and started as

./node_modules/.bin/codeceptjs

To use it with WebDriver install webdriverio package:

npm install webdriverio --save-dev

To use it with Protractor install protractor package:

npm install protractor --save-dev

To use it with Nightmare install nightmare and nightmare-upload packages:

npm install nightmare --save-dev

To use it with Puppeteer install puppeteer package:

npm install puppeteer --save-dev

WebDriver

WebDriver based helpers like WebDriver, Protractor, Selenium WebDriver will require Selenium Server (opens new window) or PhantomJS (opens new window) installed. They will also require ChromeDriver or GeckoDriver to run corresponding browsers.

We recommend to install them manually or use NPM packages:

• Selenium Standalone (opens new window) to install and run Selenium, ChromeDriver, Firefox Driver with one package.
• Phantomjs (opens new window): to install and execute Phantomjs

or use Docker (opens new window) for headless browser testing.

Launch Selenium with Chrome browser inside a Docker container:

docker run --net=host selenium/standalone-chrome