Skip to content
Varity Docs

CLI Installation

Varity Team Core Contributors Updated March 2026

Get the VarityKit CLI installed on your system.

Install with pip

Section titled “Install with pip”
Terminal window
pip install varitykit

Verify Installation

Section titled “Verify Installation”
Terminal window
varitykit --version

You should see the current version number, for example:

varitykit 1.2.0

Run Diagnostics

Section titled “Run Diagnostics”

Check that your environment is properly configured:

Terminal window
varitykit doctor

You should see a table of checks with a ✓ All checks passed! message at the end.

Requirements

Section titled “Requirements”

Required

Section titled “Required”
RequirementMinimumRecommended
Python3.83.11+
Node.js18.020.0+
npm/pnpm/yarnAnyLatest

Optional

Section titled “Optional”
RequirementNeeded For
GitVersion control

Environment Setup

Section titled “Environment Setup”

  1. Create a .env file (optional) in your project root:

    .env.local
    # Your Varity App ID (from developer portal)
    NEXT_PUBLIC_VARITY_APP_ID=your-app-id

    All deployment credentials (storage, authentication, hosting) are managed automatically by the Varity credential proxy. See Managed Credentials.

  2. Verify your setup:

    Terminal window
    varitykit doctor

Shell Completions

Section titled “Shell Completions”

Enable tab completion for your shell:

Terminal window
# Auto-detect shell and install
varitykit completions --install


# Or specify a shell
varitykit completions --shell bash --install

Run varitykit completions to see manual installation instructions for your shell.

Troubleshooting

Section titled “Troubleshooting”

”command not found: varitykit”

Section titled “”command not found: varitykit””

The CLI is not in your PATH. Try:

Terminal window
# Option 1: Use python -m
python -m varitykit --version


# Option 2: Add to PATH
export PATH="$HOME/.local/bin:$PATH"

“ModuleNotFoundError”

Section titled ““ModuleNotFoundError””

Python dependencies are missing:

Terminal window
pip install --upgrade varitykit

“Docker not found”

Section titled ““Docker not found””

Docker is optional and used for advanced local development:

Terminal window
# macOS
brew install --cask docker


# Ubuntu
sudo apt install docker.io


# Windows
# Download from docker.com

Permission denied

Section titled “Permission denied”

On Linux/macOS, you may need to run:

Terminal window
pip install --user varitykit

Or use a virtual environment:

Terminal window
python -m venv .venv
source .venv/bin/activate
pip install varitykit

Updating

Section titled “Updating”

Update to the latest version:

Terminal window
pip install --upgrade varitykit

Uninstalling

Section titled “Uninstalling”

Remove the CLI:

Terminal window
pip uninstall varitykit

Next Steps

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