shipd
Documentation · v1.0

Ship in three commands.

Everything you need to go from a fresh repo to a live URL — without leaving your terminal.

Getting started

shipd is a single binary that bundles, deploys, and serves any modern web project. You'll need Node.js 18+ and a free shipd account.

  1. 1

    Install the CLI

    Pull down the shipd binary via npm.

  2. 2

    Authenticate

    Run shipd login to connect your account.

  3. 3

    Deploy

    From any project root, run shipd deploy.

Installation

Install globally with your preferred package manager.

install
$npm install -g shipd
✓ installed shipd@1.0.0 in 4.2s

Verify the install:

verify
$shipd --version
1.0.0

Your first deploy

Create a project, link it to shipd, and ship to a free subdomain with auto-provisioned SSL.

zsh
$shipd init my-app
✓ scaffolded ./my-app
$cd my-app && shipd deploy
→ bundling (1.2s)
→ uploading (0.8s)
✓ live at https://my-app.shipd.app

CLI reference

Every command follows the same pattern: shipd <command> [flags].

shipd login

Authenticate the CLI with your shipd account.

shipd init <name>

Scaffold a new project pre-wired for deployment.

shipd deploy

Build and deploy the current directory to production.

shipd preview

Create a preview deployment on a unique URL.

shipd env <add|rm|ls>

Manage environment variables for the linked project.

shipd logs --follow

Stream runtime logs from your deployment.

shipd rollback <id>

Atomically revert to any previous deployment.

shipd domains add <domain>

Attach a custom domain with automatic SSL.

Configuration

Drop a shipd.json at the root of your project to customize builds.

shipd.json
{
"framework": "vite",
"buildCommand": "npm run build",
"outputDir": "dist",
"regions": ["sfo", "fra"]
}

Ready to ship? Spin up your first project in under a minute.

Back to home