Installation

Requirements

• Node.js 22 or newer. The cloud server uses the built-in node:sqlite, which needs Node ≥ 22.5 (see the cloud server guide).
• No native build step and no external services for the CLI.

Some capture types have optional, opt-in dependencies:

• Web (Playwright driver) needs a Chromium browser — see Web snapshots. The default fetch driver needs nothing.
• Performance needs k6 installed and on PATH — see Performance baselines.

Install

npm install -g dungbeetle   # global `dungbeetle` binary

Or per-project:

npm install --save-dev dungbeetle && npx dungbeetle --help

Verify

dungbeetle --version
dungbeetle --help

Once you have a dungbeetle.config.json, run dungbeetle doctor to validate your config, paths, targets, and optional browser setup before capturing baselines.

Next

Head to the quick start to scaffold a config and capture your first baseline.