varitykit doctor

Varity Team Core Contributors Updated March 2026

Validate your development environment and identify any issues.

Usage

varitykit doctor [OPTIONS]

What It Checks

The doctor command performs 20+ checks:

System Requirements

Check	Requirement
Python version	>= 3.8
Node.js version	>= 18.0
npm version	Any
Docker	Running (optional)

Environment Variables

Variable	Status
`THIRDWEB_CLIENT_ID`	Auto-provided (or set your own)
`VARITY_API_KEY`	Auto-provided via credential proxy

Network Connectivity

Varity platform connection
Storage API access
Storage gateway access

Project Structure

package.json exists
Build script defined
Dependencies installed

Example Output

$ varitykit doctor

Checking system requirements...
  ✓ Python version: 3.11.0 (>= 3.8 required)
  ✓ Node.js version: 20.0.0 (>= 18 required)
  ✓ npm version: 10.0.0
  ✓ Docker: Running

Checking environment variables...
  ✓ Credentials: Auto-provided
  ✓ Deployment credentials: Managed by Varity

Checking network connectivity...
  ✓ Varity platform: Connected
  ✓ Storage API: Accessible
  ✓ Storage Gateway: Accessible

Checking project structure...
  ✓ package.json: Found
  ✓ Build script: npm run build
  ✓ Dependencies: Installed

Summary:
  ✓ 12 checks passed
  ✗ 0 checks failed

All checks passed! Your environment is ready.

Run with --verbose for more details.

Options

Option	Description
`--fix`	Attempt to auto-fix common issues
`--full`	Run full diagnostics including all infrastructure checks

Exit Codes

Code	Meaning
0	All checks passed
1	Some checks failed
2	Critical failure (cannot proceed)

Fixing Common Issues

Missing Node.js

# macOS
brew install node

# Ubuntu
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs

# Windows
# Download from nodejs.org

Missing Environment Variables

Storage, authentication, and deployment credentials are auto-provided by Varity’s credential proxy. No manual credential setup is required.

If you need to override the default app ID, create a .env.local file in your project root:

NEXT_PUBLIC_VARITY_APP_ID=your-app-id

Docker Not Running

# macOS/Windows
# Open Docker Desktop

# Linux
sudo systemctl start docker

JSON Output

For CI/CD integration:

varitykit doctor --json

Output:

{
  "passed": 10,
  "failed": 2,
  "checks": [
    {"name": "python_version", "status": "pass", "value": "3.11.0"},
    {"name": "node_version", "status": "pass", "value": "20.0.0"},
    {"name": "deploy_credentials", "status": "pass", "value": "managed"}
  ]
}

Next Steps

Initialize a project - Create a new project
Deploy your app - Go to production

CLI Installation - Install the CLI
Troubleshooting - Fix common issues
Environment Variables - Required configuration