Repolode
codeceptjs

codeceptjs/CodeceptJS

A JavaScript end-to-end testing framework that lets you write browser and mobile tests as readable, user-level steps across multiple engines.

Stars
4,252
Forks
756
Open issues
189
Last commit
16 hours ago

What is it?

CodeceptJS is an end-to-end testing framework for Node.js. Tests are written as scenarios of simple steps, such as amOnPage, fillField and see, that read from a user's perspective. The framework hides the differences between browser automation APIs, so the same test syntax can run on Playwright, Puppeteer, WebDriver (via webdriverio), and several lightweight headless browsers.

For mobile testing, CodeceptJS provides helpers for Appium and Detox, with Detox aimed at grey-box testing of React Native apps. Tests run on Mocha, support TypeScript, and include CLI generators for tests and page objects. An interactive shell lets you pause a test and try commands against the live browser.

The project also includes built-in AI features for assisting and healing failing tests, parallel test execution, and an HTML reporter. It is a successor to Codeception, the PHP testing framework.

Key features

  • 01Writes tests as user-level steps that run across Playwright, Puppeteer, WebDriver and other engines.
  • 02Supports mobile testing through Appium and Detox helpers.
  • 03Provides an interactive shell to pause tests and try commands in a live browser.
  • 04Runs tests in parallel with dynamic test pooling.
  • 05Includes AI features to assist and heal failing tests, plus a built-in HTML reporter.
  • 06Offers CLI generators for tests and page objects, with TypeScript support.

Use cases

  • Writing acceptance tests for a web application that should run on several browser engines.
  • Building readable E2E suites that non-engineers can follow.
  • Testing React Native apps with grey-box Detox tests.
  • Migrating functional tests from Codeception or similar frameworks to Node.js.

Quick start

  1. 1

    Install CodeceptJS from npm

    npm i codeceptjs --save
  2. 2

    Initialize the test environment in your test directory and choose helpers

    npx codeceptjs init
  3. 3

    Generate your first test

    npx codeceptjs generate:test
  4. 4

    Run the tests

    npx codeceptjs run

Things to know

  • Requires Node.js 22.12.0 or later for version 4.2.
  • Mobile testing via Appium is only shown with Android in the build status.

In collections

Topics

FAQ

What is CodeceptJS?
A JavaScript end-to-end testing framework that lets you write browser and mobile tests as readable, user-level steps across multiple engines. CodeceptJS is an end-to-end testing framework for Node.js. Tests are written as scenarios of simple steps, such as amOnPage, fillField and see, that read from a user's perspective. The framework hides the differences between browser automation APIs, so the same test syntax can run on Playwright, Puppeteer, WebDriver (via webdriverio), and several lightweight headless browsers.
Is CodeceptJS free to use? What license does it have?
CodeceptJS is open source under the MIT license. Check the license terms before using it in commercial products.
Is CodeceptJS still maintained?
Actively maintained. The last commit to CodeceptJS was on Nov 6, 2026.
What can I use CodeceptJS for?
Writing acceptance tests for a web application that should run on several browser engines. Building readable E2E suites that non-engineers can follow. Testing React Native apps with grey-box Detox tests. Migrating functional tests from Codeception or similar frameworks to Node.js.
How do I install CodeceptJS?
Install CodeceptJS from npm: npm i codeceptjs --save Initialize the test environment in your test directory and choose helpers: npx codeceptjs init Generate your first test: npx codeceptjs generate:test Run the tests: npx codeceptjs run
Where can I get CodeceptJS?
The source code and installation instructions are on GitHub: https://github.com/codeceptjs/CodeceptJS

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects