Skip to content
Vizzly Docs

Doctor Command

vizzly doctor is the fastest way to check whether your local setup is sane.

Terminal window
vizzly doctor

Add --api when you also want to verify API connectivity:

Terminal window
vizzly doctor --api

What it checks

  • your Node.js version
  • your effective API URL
  • your comparison threshold
  • your configured server port

If --api is set, or VIZZLY_TOKEN is already present, it also makes a lightweight API request to confirm auth and connectivity.

Important note about Node versions

The CLI package declares Node.js 22+, and doctor validates Node 22+ too.

JSON output

Use --json in scripts:

Terminal window
vizzly doctor --json

The response includes passed, diagnostics, and a timestamp.

When to use it

Run doctor when:

  • a new machine or CI job is not behaving the way you expect
  • auth looks broken
  • you want to confirm config values before debugging a deeper issue

Next steps