@vizzly-testing/cli

Vizzly CLI

Visual regression testing from your terminal

<p align="center" <img src="./docs/assets/vizzly-mascot-inspector.png" alt="Vizzly bear inspecting a screenshot" width="220" / </p

Vizzly is a visual testing and regression platform for teams that ship UI. It captures screenshots from your real tests, compares them to approved baselines, and gives you useful review data: meaningful diffs, comments, approvals, build status, and preview links.

This package is the CLI and local SDK surface. Use it to run local visual TDD, upload screenshots from CI, generate static reports, and fetch machine-readable build or diff data for scripts, automation, and coding agents.

Quick Start

You need Node.js 22+.

pnpm install -g @vizzly-testing/cli

vizzly init

For agent-friendly repos, install the Vizzly skill and add a short project AGENTS.md note:

vizzly init --agent-guidance

Use vizzly init --agent-skill to install only the local skill, or vizzly init --skip-agent-skill when you want config without the agent prompt.

Start Local TDD

Start the TDD server, run your tests, and open the dashboard at the URL the command prints. Add --open when you want Vizzly to open the dashboard for you. If the default port is busy, Vizzly picks the next available port; use the printed --port value with vizzly tdd status or vizzly tdd stop.

vizzly tdd start --open
pnpm test -- --watch

The dashboard shows screenshots, baselines, and diffs as they arrive. Accept or reject changes right from the UI.

For a one-off local check, wrap the test command with tdd run:

vizzly tdd run "pnpm test" --no-open
vizzly context build current --source local --agent

That run writes review data under .vizzly/ and prints a context command you can use for follow-up inspection. If screenshots were captured, Vizzly also generates .vizzly/report/index.html; omit --no-open when you want that report opened automatically.