How Coding Agents Can Inspect Vizzly Results

Coding agents can change a screen quickly. The tricky part is knowing what the team already approved.

Vizzly keeps screenshots, baselines, diffs, and review decisions with each build. The CLI schema shows agents how to look that information up through the API.

Start with the schema

List the supported API operations, then inspect one:

vizzly api schema --json
vizzly api schema sdk.listBuilds --json

The operation details show the method, version header, request fields, and response. Use those details to make a request:

vizzly api /api/sdk/builds \
  --header 'Vizzly-API-Version: 2026-09-12' --json

Use the schema to find the matching operation when you need a particular build, screenshot, comparison, or review detail. It stays current with the API.

Look at the images

A screenshot or diff is easier to understand when you can open the image. If an API operation returns image bytes, save them with --output:

vizzly api /api/sdk/context/comparisons/<comparison-id>/images/diff \
  --header 'Vizzly-API-Version: 2026-09-12' \
  --output diff.png

Then compare the current screenshot with its baseline and diff. Check the screenshot metadata too. The viewport, browser, theme, and other properties can explain why a page shifted.

Read local TDD results

Local tests save screenshots and diffs under .vizzly/. Read them with the context command:

vizzly context build current --source local --json

That command does not need cloud authentication. Use the API schema for cloud requests.

Keep review decisions with your team

Agents can inspect changes and explain what they find. Review actions can approve, reject, or comment on a change, so check the operation details and run one only when the task calls for it.

For interactive use, install repo guidance with:

vizzly init --agent-guidance

This installs the Vizzly skill and adds a short section to AGENTS.md. The setup option remains available.

The context build --agent and context comparison --agent options are deprecated in CLI 0.37.x and will be removed in 0.38.0. Use vizzly api schema for cloud requests. For local TDD results, use vizzly context ... --json.

CLI API guide