Skip to content
Vizzly Docs

Vizzly documentation

Vizzly compares screenshots with approved baselines and keeps review decisions with each build. Use it to catch UI changes in local tests and pull requests.

Use the CLI to read local results or query cloud builds from scripts and coding agents.

You can:

  • capture screenshots during test runs
  • upload screenshots that already exist on disk
  • review changes with your team in Vizzly Cloud
  • iterate locally with TDD mode and a live dashboard
  • inspect cloud build data from scripts and coding agents

The basic flow

  1. Capture or upload screenshots.
  2. Vizzly matches them to reviewed baselines.
  3. Review the changed screenshots and approve or reject them.
  4. Keep those decisions with the build.
  5. Read the results later from the app, CLI, or an agent.

Start where you are

You already have screenshots

Terminal window
npx vizzly upload ./screenshots --wait

You want Vizzly to wrap your tests

Terminal window
npx vizzly run "npm test" --wait

Check the final upload summary for missing screenshots. See troubleshooting if an upload failed.

You want fast local feedback

Terminal window
npx vizzly tdd start --open

You want to inspect results from a script or agent

For cloud data, discover the available requests:

Terminal window
npx vizzly api schema --json
npx vizzly api schema sdk.listBuilds --json

For local TDD results, read the current build:

Terminal window
npx vizzly context build current --source local --json

See API schema and requests for the full workflow.

Where to go next