Skip to content
Latest

Authentication

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

Sign in locally

Terminal window
npx vizzly login
npx vizzly whoami

Open the browser authorization page and complete sign-in. Run whoami to check the session. Use vizzly logout to clear the saved login.

The login command keeps checking while browser approval is pending. Press Enter to check sooner.

Choose the CLI permissions in your browser. Use vizzly login --no-browser to print the authorization URL on a machine without a browser, or vizzly login --help to see how to request specific scopes.

Choose a cloud upload destination

Sign in, then link an upload project. Replace acme/web-app with the organization and project slugs.

Terminal window
npx vizzly project link acme/web-app

Run project status to check the effective destination for the next upload. Browsing another project with builds --project leaves the upload destination in place.

Terminal window
npx vizzly project status

The project selection is saved in this checkout's config. Upload commands use the matching credential from user storage. Repeat project link when migrating a checkout linked with an older CLI.

A scoped user login with build-write permission can upload to the checkout's selected project. Explicit project tokens still take precedence. If a token belongs to a different project, the CLI reports the destination mismatch before uploading.

CI and automation

Store a project token in your CI secret settings. Pass it to the job as VIZZLY_TOKEN.

Terminal window
npx vizzly run "npm test" --wait

You can pass a token explicitly with --token when a single command needs a different credential. Keep actual tokens out of committed config and scripts. The project token can authenticate CI without a browser session.

Check access

Terminal window
npx vizzly orgs
npx vizzly projects --org acme

If account commands fail, check whoami and sign in again if the session expired. If an upload fails, check which project owns the token and confirm the CI job receives it.

Cloud query commands that accept --auth can choose user or token explicitly. Use the command's help to check availability.

Where credentials live

The login uses Keychain when available on macOS and file-backed storage on other systems. Use VIZZLY_AUTH_STORAGE=file or keychain to select storage explicitly.

Linked project secrets use Keychain when it is available, with file storage as a fallback. VIZZLY_DISABLE_KEYCHAIN=true opts out of Keychain for project secrets.

Set VIZZLY_HOME to put file-backed CLI state in a separate directory. This is useful for an isolated CI environment or a second account.

See uploading screenshots for options that control the build.