varitykit doctor
Validate your development environment and identify any issues.
varitykit doctor [OPTIONS]What It Checks
Section titled “What It Checks”The doctor command runs 8 checks across 4 categories:
Required Tools
Section titled “Required Tools”| Check | Requirement |
|---|---|
| Node.js | >= 16.0.0 |
| npm | Any version |
| git | Any version |
System Resources
Section titled “System Resources”| Check | Requirement |
|---|---|
| Disk Space | 2GB free |
| Memory | 3GB available |
Project Configuration
Section titled “Project Configuration”| Check | Requirement |
|---|---|
varity.config.json | Present (warns if missing, not required for all deploy paths) |
.env file | Present (optional, warns if absent) |
Network
Section titled “Network”| Check | Requirement |
|---|---|
| Internet | Reachable |
Example Output
Section titled “Example Output”$ varitykit doctor
╭──────────────────────────────────────╮│ Varity Environment Check ││ Validating your development setup... │╰──────────────────────────────────────╯
Environment Check Results╭────────────────────────┬────────────────────────┬──────────────┬─────────────────────────╮│ Category │ Check │ Status │ Details │├────────────────────────┼────────────────────────┼──────────────┼─────────────────────────┤│ Required Tools │ node │ ✓ PASS │ v22.0.0 (Required: 16+) ││ Required Tools │ npm │ ✓ PASS │ 10.9.2 ││ Required Tools │ git │ ✓ PASS │ 2.43.0 ││ System │ Disk Space │ ✓ PASS │ 50GB available ││ System │ Memory │ ✓ PASS │ 8GB available ││ Project │ varity.config.json │ ⚠ WARN │ Not found (optional) ││ Project │ .env File │ ⚠ WARN │ Optional ││ Network │ Internet │ ✓ PASS │ Connected │╰────────────────────────┴────────────────────────┴──────────────┴─────────────────────────╯
Total: 8 checks (6 pass, 2 warn)
╭───────────────────────────────────────────────────────────────────────────╮│ Environment is ready. Run varitykit app deploy to deploy your app. │╰───────────────────────────────────────────────────────────────────────────╯Options
Section titled “Options”| Option | Description |
|---|---|
--fix | Attempt to auto-fix common issues |
--full | Run full diagnostics including all infrastructure checks |
Exit Codes
Section titled “Exit Codes”| Code | Meaning |
|---|---|
| 0 | All checks passed |
| 1 | Some checks failed |
| 2 | Critical failure (cannot proceed) |
Fixing Common Issues
Section titled “Fixing Common Issues”Missing Node.js
Section titled “Missing Node.js”# macOSbrew install node
# Ubuntucurl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -sudo apt install -y nodejs
# Windows# Download from nodejs.orgLow Memory Warning
Section titled “Low Memory Warning”If the Memory check reports a warning (requires 3GB available), you can safely continue. The warning means builds may be slower on this machine, but deployments still work.
On WSL, run wsl --shutdown and reopen to reclaim memory from the host OS if needed.
Verbose Output
Section titled “Verbose Output”For more detailed diagnostics:
varitykit doctor --fullThis runs all infrastructure checks in addition to the standard environment checks.
Next Steps
Section titled “Next Steps”- Deploy your app - Go to production
- Log in - Connect your developer account
Related Resources
Section titled “Related Resources”- CLI Installation - Install the CLI
- Troubleshooting - Fix common issues
- Environment Variables - Required configuration