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.
npx vizzly config --jsonnpx vizzly config comparison.thresholdThe first command shows the effective settings. The second reads one value.
Settings
| Setting | What it controls |
|---|---|
server.port | Port of the local screenshot server |
server.timeout | Server timeout in milliseconds |
build.name | Label for the build |
build.environment | Environment recorded with the build |
build.branch, build.commit, build.message | Git metadata attached to the build |
upload.batchSize | Screenshots sent per batch |
upload.screenshotsDir | Default directory for integrations that read this setting |
upload.timeout | Build-processing wait in milliseconds |
comparison.threshold | Tolerance for color differences, in Delta E |
comparison.minClusterSize | Minimum 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
signaturePropertieslists custom property names used for baseline matching.pluginslists CLI plugin packages to load.parallelIdgroups test shards into one build.baselineBuildIdandbaselineComparisonIdselect cloud baselines for TDD.apiUrlselects an API server. Prefer a CI secret over savingapiKeyin config.eager,wait, andallowNoTokenset 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_TOKENsupplies the project token for CI.VIZZLY_BUILD_NAMEchanges the build label without editing config.VIZZLY_PARALLEL_IDgroups parallel shards.VIZZLY_API_URLchanges the API server.VIZZLY_HOMEchanges where the CLI stores user state.VIZZLY_LOG_LEVELsets the diagnostic output level.VIZZLY_BRANCH,VIZZLY_COMMIT_SHA, andVIZZLY_COMMIT_MESSAGEoverride 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.