VPS CLI

Deploy apps to your VPS.org server with a single command. No Docker required.

Install

pip install vps-cli

Quick Start

# 1. Login with your API token
vps login

# 2. In your project directory, link to a server
cd my-project/
vps link

# 3. Edit vps.yaml with your app config

# 4. Deploy
vps deploy

Configuration (vps.yaml)

Create a vps.yaml in your project root:

Python app:

name: my-app
type: python
version: "3.12"
build:
  - pip install -r requirements.txt
start: gunicorn app.wsgi:application --workers 3 --bind 127.0.0.1:8000
port: 8000
domain: myapp.example.com
git_repo: https://github.com/user/repo.git
git_branch: main

Node.js app:

name: my-api
type: node
version: "20"
build:
  - npm install
start: node server.js
port: 3000
domain: api.example.com
git_repo: https://github.com/user/repo.git
git_branch: main

Static site:

name: my-site
type: static
build:
  - npm run build
domain: example.com
git_repo: https://github.com/user/repo.git
git_branch: main

Commands

Environment Variables

# Set variables
vps env set DATABASE_URL=postgres://... SECRET_KEY=abc123

# List variables
vps env list

# Remove a variable
vps env rm SECRET_KEY

How It Works

1. You run vps deploy from your project directory
2. The CLI reads vps.yaml and sends the config to the VPS.org API
3. The platform SSHes into your VPS and:
   • Sets up the runtime (Python via pyenv, Node via nvm)
   • Clones/pulls your code from git
   • Runs build commands
   • Configures Supervisor (process manager)
   • Configures Nginx (reverse proxy + SSL)
   • Runs a health check

Requirements

• Python >= 3.9
• A VPS.org server with SSH access
• An API token from admin.vps.org

License

MIT