Log In and Link Your Project with the Vizzly CLI

Managing API tokens across projects gets tedious. The CLI lets you log in with your Vizzly account, then link each checkout to the project it uploads to.

This guide was updated for CLI 0.36.0. The current command is vizzly project link.

Log In and Link a Project

Install the CLI, then log in:

npm install -g @vizzly-testing/cli
vizzly login

Your browser opens for authentication. Logging in identifies your account. Linking gives this checkout a credential for uploading to the project you choose.

cd /path/to/your-app
vizzly project link your-org/your-project

You can also run vizzly project link without a selector to choose a project interactively. Then run tests that already capture screenshots through a Vizzly integration or vizzlyScreenshot():

vizzly run "npm test" --wait

--wait waits for cloud processing and exits with code 1 when visual changes need review. The command prints the build information you can use to inspect those changes.

Work Across Projects

Link each checkout to its own project:

cd ~/work/marketing-site
vizzly project link your-org/marketing

cd ~/work/admin-app
vizzly project link your-org/admin

To check your login and the current checkout’s configuration:

vizzly whoami
vizzly config

Both support --json for scripts. Use vizzly doctor if setup is not working as expected.

Use a project token in CI

Use a project token from your CI secret store as VIZZLY_TOKEN:

vizzly run "npm test" --wait

Your CI environment supplies the token, so each job can upload without an interactive login or project-link step. Keep the token out of source control.

Local TDD Needs No Account

You can still compare screenshots locally without linking a cloud project:

vizzly tdd run "npm test" --no-open
vizzly context build current --source local --json

The run saves screenshots, diffs, and an HTML report. For a background dashboard, use vizzly tdd start --open and run your screenshot tests while it is active.

See the authentication guide for more setup details, or the CLI features for the local-to-cloud workflow.