deplo.ai/docs

Setup Guide

Everything needed to go from a fresh machine to a live deployment with the deplo CLI — install, authenticate, connect Vercel and Render, deploy. Five minutes if your accounts already exist.

Prerequisites#

  • Node.js 20+ and npm — node --version should print v20 or higher.
  • git — the CLI identifies your project from its origin remote.
  • A GitHub account with a repository that has a GitHub remote.
  • A free Vercel account (frontend hosting) and a free Render account (backend hosting). deplo.ai deploys into accounts you own.

  1. Install the CLI

    Install globally to get the deplo command, or skip installation entirely and prefix every command with npx @deplo.ai/cli:

    bash
    npm i -g @deplo.ai/cli

  2. Verify the installation

    bash
    deplo --help

    You should see the command list and the tagline “Deploy full-stack apps into your own Vercel + Render accounts.” deplo --version prints 0.1.0.

  3. Sign in

    bash
    deplo login

    This opens your browser to an authorization page; click Authorize and return to the terminal. On a machine without a browser (SSH, containers), use deplo login --token and paste a token created at deplo.in → Settings → CLI tokens. Details in Authentication.

    expected output
    → opening https://www.deplo.in/cli-auth?port=52814&state=9f2c…&host=mbp.local
  (no browser? run `deplo login --token` and paste one instead)
✓ signed in patrickdev · token saved to /Users/patrick/.config/deplo/config.json

  4. Connect Vercel and Render

    Check what is connected, then connect whatever is missing:

    bash
    deplo whoami
deplo connect vercel
deplo connect render

    connect vercel opens a one-click OAuth authorization in the browser. connect render asks for a Render Personal API key (starts with rnd_) in a masked prompt — create one at Render → Account Settings → API Keys.

    Tip
    You can skip this step. If a provider is missing when you run deplo interactively, the CLI asks “Vercel isn't connected yet. Connect now?” and runs the connection inline.

  5. Deploy

    From inside any cloned repository with a GitHub remote:

    bash
    cd my-app
deplo

    The CLI detects the repo from your git remote, confirms, then follows the live deployment log. If the deployment needs environment variables, you are prompted for each one (input is masked) and the deployment resumes automatically. It ends with your production URLs and ● Deployed in 2:41 — or, on failure, a pointer to the full log and AI diagnosis. See the Command Reference for the full output.

Updating#

npx @deplo.ai/cli always runs the latest published version. A global install is updated explicitly:

bash
npm i -g @deplo.ai/cli@latest

Uninstalling#

bash
npm uninstall -g @deplo.ai/cli
rm -rf ~/.config/deplo

Removing ~/.config/deplo deletes the stored token from the machine, but the token itself remains valid server-side — revoke it at deplo.in → Settings → CLI tokens. Your projects, deployments, and provider connections live on the platform and are untouched by uninstalling the CLI.