Skip to content
Vizzly Docs

Welcome to Vizzly

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.

Coding agents can inspect cloud builds through the CLI’s API schema. Developers can read local TDD results with the same CLI.

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. Humans review the meaningful diffs, comments, and preview links.
  4. Approved changes become reusable review history.
  5. Agents and scripts fetch that history through the CLI when they need it.

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 too. If a screenshot fails to upload, Vizzly reports an incomplete visual build while letting your tests finish. Troubleshooting explains what to check.

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