Skip to content

CLI

CommandDescription
dungbeetle initWrite a starter dungbeetle.config.json.
dungbeetle updateCapture targets and write/update local baselines.
dungbeetle testCompare current output against local baselines; non-zero exit on diffs.
dungbeetle ciRun comparisons with CI-friendly JSON/HTML output.
dungbeetle flakeCapture repeatedly and report run-to-run divergence.
dungbeetle doctorCheck config, targets, baseline paths, and browser setup.
dungbeetle pushUpload a run report to a Dungbeetle cloud server.
dungbeetle push-baselinesUpload local baselines to a cloud server, versioned.
dungbeetle anonCapture and share a snapshot on a cloud server, no account needed.

Run any command with --help for its full flag list. The commands split into the local snapshot workflow (initupdatetestci, plus flake and doctor) and cloud uploads (push, push-baselines, anon).

Common flags

Most commands take --config <path> and --cwd <path>. The report-producing commands (test / ci / update) take --json <path> and --html <path>, and test / ci take --with-snapshots to carry candidate snapshots for cloud promotion.

Use --target <name...> with update, test, or ci to work with one or more named capture targets instead of the full suite.

Report statuses

  • updated — baseline was written in update mode.
  • passed — current snapshot matches the baseline.
  • failed — current snapshot differs from the baseline.
  • missing — no baseline exists for the target.
  • error — capture or comparison failed unexpectedly.

Source-available: CLI under FSL-1.1-ALv2, cloud server under BUSL-1.1. See Licensing.