Skip to content

VarityKit CLI Overview

Varity Team Core Contributors Updated March 2026

VarityKit is a Python-based CLI that helps you build, test, and deploy applications. If you have used tools like the Vercel CLI, Netlify CLI, or Firebase CLI, you will feel right at home.

Initialize Projects

Scaffold new projects from starter templates with pre-configured auth and deployment.

Deploy Applications

Deploy static sites or dynamic apps with one command.

Manage Templates

Create, test, validate, and publish templates to the marketplace.

Validate Setup

Run diagnostics to ensure your development environment is ready.

CommandDescription
varitykit loginLog in with your deploy key from the developer portal
varitykit doctorValidate your development environment
varitykit initCreate a new project from a template
varitykit devStart development servers (API + frontend)
varitykit bootstrapInstall project dependencies and set up environment
varitykit completionsSet up shell completions (bash, zsh, fish)
CommandDescription
varitykit auth loginLog in with your deploy key
varitykit auth logoutRemove saved credentials
varitykit auth statusShow current login status
CommandDescription
varitykit app deployDeploy your application
varitykit app listList all deployments
varitykit app infoShow deployment details
varitykit app statusShow deployment status
varitykit app rollbackRollback to a previous deployment
CommandDescription
varitykit template createCreate a new template with AI assistance
varitykit template testRun automated tests for a template
varitykit template previewPreview a template in the browser
varitykit template validateValidate template quality (code, tests, a11y, security)
varitykit template listList available templates
varitykit template infoShow detailed template information
CommandDescription
varitykit marketplace publishPublish a template to the marketplace
varitykit marketplace searchSearch for templates
varitykit marketplace installInstall a template from the marketplace
varitykit marketplace statsView your marketplace statistics
varitykit marketplace unpublishRemove a template from the marketplace
varitykit marketplace updateUpdate a published template
CommandDescription
varitykit domains listList all domains you own on varity.app
CommandDescription
varitykit migrate s3Migrate data from AWS S3 to Varity
varitykit migrate gcsMigrate data from Google Cloud Storage to Varity
varitykit migrate statusCheck migration job status
varitykit migrate verifyVerify migration integrity
Terminal window
# Install the CLI
pip install varitykit
# Check your environment
varitykit doctor
# Log in with your developer portal deploy key
varitykit login
# Create a new project
varitykit init my-app
# Deploy (static sites)
varitykit app deploy
# Deploy (dynamic apps)
varitykit app deploy --hosting dynamic

All commands support these global options:

Terminal window
varitykit [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the CLI version
-v, --verbose Enable verbose output
--debug Enable debug output
--json Output in JSON format
--help Show help message
  • Python: 3.8 or higher
  • Node.js: 18+ (for building JavaScript projects)

Deploy static websites and single-page applications:

Terminal window
varitykit app deploy
  • Best for: Marketing sites, documentation, SPAs
  • Cost: Free (sponsored by Varity)
  • Speed: Global CDN distribution

Deploy full-stack applications with backend:

Terminal window
varitykit app deploy --hosting dynamic
  • Best for: APIs, databases, server-side rendering
  • Cost: Pay for compute resources
  • Features: Containers, scaling, persistence
FrameworkStaticDynamic
Next.js 13+YesYes
React (Vite)YesYes
React (CRA)YesYes
Vue 3+YesYes
Node.jsNoYes
PythonNoYes

Start development servers (API + frontend) with hot-reload:

Terminal window
varitykit dev [OPTIONS]
OptionDefaultDescription
--projectmarketingFrontend project to run
--api-onlyfalseRun only the API server
--frontend-onlyfalseRun only the frontend
--port3001API server port

Install project dependencies and set up the environment:

Terminal window
varitykit bootstrap [OPTIONS]
OptionDescription
--skip-npmSkip npm install
--skip-pipSkip pip install
--skip-dockerSkip Docker setup

Set up shell completions for the CLI:

Terminal window
varitykit completions [OPTIONS]
OptionDescription
--shellShell type: bash, zsh, or fish (auto-detected if omitted)
--installInstall completions to your shell config file