Deploy CLI

Welcome to the Deploy CLI! This is your command-line toolkit for managing, building, and running your Deploy server and sites with ease. Inspired by the spirit of the old internet, our CLI makes it simple for anyone to get started hosting and customizing their own web playground.

Getting Started

Install dependencies at the project root:

git clone https://github.com/keithk/deploy.git
cd deploy
bun install

Running CLI Commands

All CLI commands are run from the project root using Bun:

bun packages/cli/src/index.ts <command> [options]

Or, if you have a global install:

deploy <command> [options]

Available Commands

list                     List all available sites and their commands
run <site> <command>     Run a command for a specific site
init [directory]         Initialize a new project
setup [local|production] Set up the project for local development or production
site create <name>       Create a new site
site list                List all sites
start                    Start the server
dev                      Start the server in development mode
action run [action-id]   Run actions
caddyfile update         Update Caddyfile
processes list           List all processes
processes watch          Real-time monitoring dashboard
help                     Show this help message

Options:
  --port, -p               Set the port for the web server (default: 3000)
  --root, -r               Set the root directory for sites (default: ./sites)

Easy Server Setup

To set up your local development environment with HTTPS and subdomain routing, just run:

bun run setup:macos

This will:

• Install Caddy and dnsmasq if needed
• Configure subdomains like blog.dev.flexi to work locally
• Set up HTTPS for your local sites

For production, use:

bun run setup:production

This will walk you through deploying to your own domain (like keith.is).

Building and Customizing Sites

The CLI is your gateway to building and customizing your own sites! Just add a folder to /sites, configure it, and use the CLI to build, run, or list your creations. Whether you’re making a static site, a dynamic app, or something totally unique, you’re in control.

The Spirit of the Old Internet

Deploy is about making it easy and fun to carve out your own corner of the web. Hack, remix, and share—just like the early days. See /sites for examples and inspiration!

For more advanced usage, see the main project README or the docs.