Skip to content

varitykit app deploy command

Varity TeamCore Contributors

Deploy your application to Varity’s secure infrastructure.

Terminal window
varitykit app deploy [OPTIONS]

Deploy static websites and single-page applications:

Terminal window
varitykit app deploy

Best for:

  • Marketing websites
  • Documentation sites
  • Single-page applications
  • Landing pages

Features:

  • Global CDN distribution
  • Permanent deployment URLs
  • Automatic SSL
  • The CLI does not show a price or ask for confirmation before it deploys. Check the current price first in Pricing and Costs

Deploy full-stack applications with compute resources:

Terminal window
varitykit app deploy --hosting dynamic

Best for:

  • APIs and backends
  • Server-side rendering
  • Database applications
  • Full-stack apps

Features:

  • Container hosting
  • Persistent storage
  • Up to a fixed monthly maximum per app, prorated by running time. An unchanged profile does not cost more as traffic grows
OptionDefaultDescription
--hostingautoHosting type: auto, static, or dynamic
--path.Project directory
--nameNoneCustom app name. Static apps live at https://varity.app/<name>/; dynamic apps live at https://<name>.varity.app/
--repo-urlNoneGitHub repo URL to build from. Auto-detected from .git/config; required for source deploys, since nothing is uploaded from your machine
--templateNoneDeploy a certified template by id (varitykit app templates). Mutually exclusive with --repo-url and --image
--env KEY=VALUENoneSet an environment variable on the deployment (repeatable)
--serviceNoneAttach an auto-wired service: postgres, redis, ollama, mongodb, mysql, or minio (repeatable)
--volume-size / --volume-pathNonePersistent volume in GB and its absolute mount path (both required together)
--command / --arg / --health-pathNoneAdvanced runtime overrides for image and Dockerfile deploys
--dockerfile-path / --docker-context-pathNoneAdvanced build overrides for repo deploys
--memory-mb / --cpu-units / --storage-mbNoneAdvanced reserved-resource overrides for image and prebuilt deploys
--imageNoneDeploy a prebuilt OCI image instead of building from source
--image-registryNoneRegistry host for a private --image
--image-usernameNoneUsername for a private --image
--image-passwordNonePassword or secret value for a private --image
--port80Container listen port for an --image deploy only
--dry-runfalsePreview the deployment without shipping (not compatible with --image or --template)
  1. Push your project to GitHub

    Varity builds from the repository in the cloud, so the code you want live must be pushed.

  2. Deploy from the checkout

    Terminal window
    varitykit app deploy

    Outside a Git checkout, pass --repo-url https://github.com/you/my-app, --image <ref>, or --template <id>.

  3. View your live app

    Deploying via Varity…
    Run: 3f2a9c1e-7b4d-4e8a-9c21-5d6e7f8a9b0c
    ✓ Live: https://varity.app/your-app/
    Run: 3f2a9c1e-7b4d-4e8a-9c21-5d6e7f8a9b0c
    Final status: live
    Continue: varitykit app status 3f2a9c1e-7b4d-4e8a-9c21-5d6e7f8a9b0c

    The command waits until the app is live. A dynamic app can take a few minutes, and the CLI prints no progress while it waits.

The CLI automatically detects your framework:

FrameworkDetectionBuild Command
Next.jsnext.config.*npm run build
React (Vite)vite.config.*npm run build
React (CRA)react-scriptsnpm run build
Vuevue.config.*npm run build
Custompackage.jsonnpm run build

Storage and service credentials are auto-provided by Varity. No manual credential setup is required. See Managed Credentials.

View all deployments:

Terminal window
varitykit app list

Output:

The table has the columns ID, Name, Status, Runtime, URL, Outcome, and Updated. In a narrow terminal (80 columns) only ID and Name fit, so widen the terminal or use JSON output.

Pass the global --json flag (varitykit --json app list) for machine-readable output.

Get detailed information about a specific deployment:

Terminal window
varitykit app info your-app

Remove a deployment:

Terminal window
varitykit app delete my-app --yes
  1. Verify your build works locally:

    Terminal window
    npm run build
  2. Check for missing dependencies:

    Terminal window
    npm install
  1. Verify network connectivity:

    Terminal window
    varitykit doctor
  2. Check your internet connection and try again