Skip to content
Latest

SDK overview

A Vizzly client sends screenshots from your tests to the CLI. The CLI handles local comparisons or cloud uploads.

Start with Quick start if you haven’t captured a screenshot yet. Run vizzly init locally to create shared config, then follow the guide for your client. Init doesn’t choose or install one.

The main paths

JavaScript client

For Node.js test runners, use the client included in @vizzly-testing/cli.

Terminal window
npm install -D @vizzly-testing/cli
import { vizzlyScreenshot } from '@vizzly-testing/cli/client';

Framework-specific packages

Choose the guide for your test setup:

Local mode vs cloud mode

Local development

Terminal window
npx vizzly tdd start

Your tests post screenshots to the local server. Comparisons stay local in .vizzly/.

CI and team review

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

vizzly run starts a capture server, runs your test command, and uploads screenshots for team review. Your capture code stays the same.

When a capture is uploaded

In cloud mode, the local server queues screenshots for upload. A successful capture response means the local server accepted it; the cloud upload can still fail afterward. Check the CLI’s final summary for uploaded, reused, and failed screenshots.

vizzly run reports upload failures without failing passing tests. See upload failures for the build status and exit-code behavior. All cloud captures follow the same image and name requirements.

What to use by default

Use @vizzly-testing/cli/client for Node.js tests. If your language needs a custom client, follow Build your own Vizzly SDK.

Next steps