Quick Start Guide

Deploy your static site or SPA to Uplify.dev in under 5 minutes.

Prerequisites

Node.js 16+ or Python 3.8+
A static site or SPA ready to deploy
Uplify.dev account (created automatically on first deploy)

Step 1: Install the CLI

Using npm:

npm install -g @uplify/cli

Using pip:

pip install uplify-cli

Step 2: Login

Authenticate with Uplify.dev using device code flow:

$ uplify login

✓ Visit https://uplify.dev/device
✓ Enter code: ABC-123
✓ Authenticated as user@example.com

Step 3: Initialize Your Project

Navigate to your site's directory and initialize:

$ cd my-static-site
$ uplify init

✓ Project name: my-awesome-site
✓ Build directory: ./dist (or press Enter for current directory)
✓ SPA mode? (y/N): y

Project initialized!

Step 4: Deploy!

$ uplify deploy

Scanning files...
✓ Found 42 files (2.3 MB)
✓ 3 files need upload (only changed files)
Uploading...
✓ Uploaded in 1.2s

Deploy successful!
Preview: https://my-awesome-site-abc123.preview.uplify.dev
Alias:   https://my-awesome-site.uplify.dev

Step 5: Manage Aliases

Point a production alias to your deploy:

$ uplify alias set production <deploy-id>

✓ Alias 'production' now points to deploy abc123
✓ Live at: https://production.uplify.dev

Configuration File

Create a uplify.json in your project root:

{
  "name": "my-awesome-site",
  "buildDir": "./dist",
  "spa": true,
  "notFoundPage": "/404.html",
  "redirects": [
    {
      "source": "/old-page",
      "destination": "/new-page",
      "permanent": true
    }
  ],
  "headers": [
    {
      "source": "/(.*)",
      "headers": [
        {
          "key": "X-Frame-Options",
          "value": "DENY"
        }
      ]
    }
  ]
}

SPA (Single Page App) Support

For SPAs like React, Vue, or Angular apps:

Set "spa": true in your config
All unknown routes will serve /index.html
Provide a custom /404.html for not-found pages

Rollback

Instantly rollback to any previous deploy:

$ uplify list
$ uplify alias set production <previous-deploy-id>

✓ Rolled back in 0.3s!

API Tokens

For CI/CD, create an API token:

Visit Dashboard → API Tokens
Click "Create Token"
Copy the token (shown only once)
Set as environment variable: UPLIFY_TOKEN

# In your CI/CD pipeline
$ export UPLIFY_TOKEN=your-token-here
$ uplify deploy

Common Commands

uplify login	Authenticate with Uplify.dev
uplify init	Initialize a new project
uplify deploy	Deploy your site
uplify list	List all deploys
uplify alias set NAME ID	Point alias to deploy
uplify alias list	List all aliases

Need Help?

Check out our full documentation or contact support@uplify.dev