Skip to content
Latest

Installation

Full CLI reference for v0.40.0, published . Cloud features may behave differently today.

Requirements

Use Node.js 22.18 or newer in the Node 22 line, or Node.js 24 and newer. The package declares ^22.18.0 || >=24.0.0.

Install and pin

Add Vizzly as a development dependency. Save the exact version so your local machine and CI job use the same CLI.

Terminal window
npm install --save-dev --save-exact @vizzly-testing/cli@0.40.0
npx vizzly --version

Commit the package manifest and lockfile. If the version output differs from this page, run the command from the project that installed the CLI.

Create project config

Terminal window
npx vizzly init

Init guides you through first-time setup. Use npx vizzly init --quick to create an editable config without the setup questions.

Pass --agent-guidance to install the Vizzly skill and add repository guidance, or --agent-skill to install only the skill.

Verify the setup

Terminal window
npx vizzly doctor

For local comparisons, follow TDD mode. For cloud uploads, set up authentication before sending screenshots.