Commands reference
Selected CLI guides for v0.29.6, published . Cloud features may behave differently today.
Use the help output from your installed release for the full list of options.
npx vizzly --helpnpx vizzly upload --helpRun tests and upload screenshots
Use run when your tests capture screenshots through a Vizzly integration. Use
upload when your CI job already writes screenshot files to a directory. Both
examples use the project’s cloud credentials.
npx vizzly run "npm test" --waitnpx vizzly upload ./screenshots --waitUse status with a build ID to look up a build you’ve already sent to Vizzly.
npx vizzly status build-idCompare locally
npx vizzly tdd run "npm test"See TDD mode for baseline setup.
Query builds and comparisons
Use a project slug to narrow the results. Add the organization slug when more than one organization has a project with the same slug.
npx vizzly builds --project web-app --org acme --jsonnpx vizzly comparisons --project web-app --org acme --jsonPreview hosting
Use preview to upload a built site for a visual build. See the options for pairing
the preview with the right build in your CI setup.
npx vizzly preview --help