Skip to content
v0.34.0

Doctor command

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

Check the local environment

Terminal window
npx vizzly doctor

Run this from the project directory. Check the Node version, configuration and screenshot server port reported by the command. If configuration fails to load, fix that first and rerun the check.

Include API connectivity

Terminal window
npx vizzly doctor --api

Use the API check when local diagnostics pass and cloud operations fail. Doctor also checks API access when a project token is configured. Check the token and API URL used by this environment.

Read diagnostics in CI

Terminal window
npx vizzly doctor --json

The JSON response includes passed, the diagnostic results, and a timestamp. Check the exit code and passed before proceeding with a CI job.

Doctor checks the Node major version. Compare node --version with the exact requirement on the installation page when checking the minimum supported minor version.

See configuration for project settings and authentication for account and token setup.