Skip to content
Varity Docs

varitykit doctor

Varity Team Core Contributors Updated March 2026

Validate your development environment and identify any issues.

Usage

Section titled “Usage”
Terminal window
varitykit doctor [OPTIONS]

What It Checks

Section titled “What It Checks”

The doctor command performs 8 checks across 4 categories:

System Requirements

Section titled “System Requirements”
CheckRequirement
Python version>= 3.8
Node.js version>= 18.0
npm versionAny
DockerRunning (optional)

Environment Variables

Section titled “Environment Variables”
VariableStatus
NEXT_PUBLIC_PRIVY_APP_IDAuto-provided (or set your own)
VARITY_API_KEYAuto-provided via credential proxy

Network Connectivity

Section titled “Network Connectivity”
  • Varity platform connection
  • Storage API access
  • Storage gateway access

Project Structure

Section titled “Project Structure”
  • package.json exists
  • Build script defined
  • Dependencies installed

Example Output

Section titled “Example Output”
$ varitykit doctor


╭──────────────────────────────────────╮
│ Varity Environment Check             │
│ Validating your development setup... │
╰──────────────────────────────────────╯


1/4 Checking required tools...
2/4 Checking system resources...
3/4 Checking project configuration...
4/4 Checking network connectivity...


                           Environment Check Results
╭────────────────────────┬────────────────────────┬──────────────┬─────────────╮
│ Category               │ Check                  │ Status       │ Details     │
├────────────────────────┼────────────────────────┼──────────────┼─────────────┤
│ Required Tools         │ node                   │ ✓ PASS       │ ...         │
│ Required Tools         │ npm                    │ ✓ PASS       │ ...         │
│ Required Tools         │ git                    │ ✓ PASS       │ ...         │
│ System                 │ Disk Space             │ ✓ PASS       │ ...         │
│ System                 │ Memory                 │ ✓ PASS       │ ...         │
│ Project                │ varity.config.json     │ ⚠ WARN       │ Run init    │
│ Project                │ .env File              │ ⚠ WARN       │ Optional    │
│ Network                │ Internet               │ ✓ PASS       │ Connected   │
╰────────────────────────┴────────────────────────┴──────────────┴─────────────╯


Total: 8 checks


╭─────────────────────────────────────────────────────────────────────────╮
│ ✓ All checks passed!                                                    │
│ Your environment is ready. Run varitykit app deploy to deploy your app. │
╰─────────────────────────────────────────────────────────────────────────╯

Options

Section titled “Options”
OptionDescription
--fixAttempt to auto-fix common issues
--fullRun full diagnostics including all infrastructure checks

Exit Codes

Section titled “Exit Codes”
CodeMeaning
0All checks passed
1Some checks failed
2Critical failure (cannot proceed)

Fixing Common Issues

Section titled “Fixing Common Issues”

Missing Node.js

Section titled “Missing Node.js”
Terminal window
# 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

Section titled “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:

.env.local
NEXT_PUBLIC_VARITY_APP_ID=your-app-id

Docker Not Running

Section titled “Docker Not Running”
Terminal window
# macOS/Windows
# Open Docker Desktop


# Linux
sudo systemctl start docker

Verbose Output

Section titled “Verbose Output”

For more detailed diagnostics:

Terminal window
varitykit doctor --full

This runs all infrastructure checks in addition to the standard environment checks.

Next Steps

Section titled “Next Steps”
Section titled “Related Resources”