Skip to content

ccjs doctor

Comprehensive environment health check for your CodeceptJS project.

Usage

bash
ccjs doctor

Flags

FlagShortDescription
--config <path>-cPath to codecept configuration file

What It Checks

CheckWhat It Validates
Node.js versionRequires Node.js ≥ 22
CodeceptJSModule is installed and accessible
Config filecodecept.conf.{ts,js,mjs,cjs} exists
Test directoryConfigured test directory is present
Output directoryScreenshot/report output directory exists
PlatformDisplays OS and architecture info

Example Output

text
┌───┬──────────────────┬─────────────────────┐
│   │ Check            │ Status              │
├───┼──────────────────┼─────────────────────┤
│ ✓ │ Node.js version  │ v22.0.0             │
│ ✓ │ CodeceptJS       │ v3.7.5              │
│ ✓ │ Config file      │ codecept.conf.ts    │
│ ✓ │ Test directory   │ ./tests             │
│ ✓ │ Output directory │ ./output            │
│ ✓ │ Platform         │ darwin arm64        │
└───┴──────────────────┴─────────────────────┘
  ✔ All checks passed!

When to Use

  • After ccjs init — verify everything was scaffolded correctly
  • In CI pipelines — as a pre-flight check before running tests
  • When debugging — quickly identify missing dependencies or misconfigurations
  • After upgrading — confirm compatibility after Node.js or CodeceptJS updates

TIP

Run ccjs doctor as the first step whenever tests aren't working as expected.

Released under the MIT License. Built with ❤️ on top of CodeceptJS.