Skip to content
v0.32.0

Configuration

Full CLI reference for v0.32.0, published . Cloud features may behave differently today.

Project config

Run npx vizzly init to create config. Commit shared values in vizzly.config.js and use flags for changes that only apply to one run.

export default {
build: { environment: 'test' },
upload: { batchSize: 20 },
comparison: { threshold: 2, minClusterSize: 2 },
};

Use --config ./vizzly.ci.js to select a different config file. You can also put the settings in the vizzly property of package.json.

Terminal window
npx vizzly config --json
npx vizzly config comparison.threshold

The first command shows the effective settings. The second reads one value.

Settings

SettingWhat it controls
server.portPort of the local screenshot server
server.timeoutServer timeout in milliseconds
build.nameLabel for the build
build.environmentEnvironment recorded with the build
build.branch, build.commit, build.messageGit metadata attached to the build
upload.batchSizeScreenshots sent per batch
upload.screenshotsDirDefault directory for integrations that read this setting
upload.timeoutBuild-processing wait in milliseconds
comparison.thresholdTolerance for color differences, in Delta E
comparison.minClusterSizeMinimum group of changed pixels to count in a comparison

The upload command takes the screenshot directory on the command line. Comparison settings can change which differences are reported. Check a representative local run before changing them for a whole project.

This release loads comparison defaults of 2 for threshold and minimum cluster size. Set the values deliberately when your project needs different comparison behavior.

Other project options

  • signatureProperties lists custom property names used for baseline matching.
  • plugins lists CLI plugin packages to load.
  • parallelId groups test shards into one build.
  • baselineBuildId and baselineComparisonId select cloud baselines for TDD.
  • apiUrl selects an API server. Prefer a CI secret over saving apiKey in config.
  • eager, wait, and allowNoToken set run behavior.

Use tdd start --open to open the live dashboard, or tdd run --no-open to leave a one-off report closed.

Environment and flags

  • VIZZLY_TOKEN supplies the project token for CI.
  • VIZZLY_BUILD_NAME changes the build label without editing config.
  • VIZZLY_PARALLEL_ID groups parallel shards.
  • VIZZLY_API_URL changes the API server.
  • VIZZLY_HOME changes where the CLI stores user state.
  • VIZZLY_LOG_LEVEL sets the diagnostic output level.
  • VIZZLY_BRANCH, VIZZLY_COMMIT_SHA, and VIZZLY_COMMIT_MESSAGE override Git metadata in CI.

For an option with all four sources, the CLI uses command flags, then environment variables, then project config, then built-in defaults.

See authentication for credential selection and TDD mode for local runs.