CLI Reference

The burner CLI manages authentication, deploys, and preview lifecycle from your terminal.

Installation

npm install -g burner-cli

Global Options

Flag	Description
`--api-url <url>`	Override the API base URL
`--version`	Show CLI version
`--help`	Show help

burner login

Authenticate with burner.dev via GitHub OAuth.

burner login

Opens your browser to sign in with GitHub. After authorizing, the page displays an API key. Paste it into the terminal prompt. The key is stored at ~/.config/burner/config.json.

You can also skip the login flow by setting the BURNER_API_KEY environment variable.

burner deploy

Deploy a directory as an ephemeral preview.

burner deploy [dir] --command <cmd> [options]

Flag	Required	Default	Description
`[dir]`	No	`.`	Directory to deploy
`-c, --command <cmd>`	Yes	—	Command to start the server
`-p, --port <number>`	No	`3000`	Port your server listens on
`-e, --env <KEY=VALUE>`	No	—	Environment variable (repeatable)
`--ttl <minutes>`	No	`45`	Preview TTL in minutes (5–240)

Examples

# Vite React app
burner deploy . --command "npm run dev" --port 5173

# Next.js
burner deploy . --command "npm run dev"

# Express with env vars
burner deploy ./api --command "node server.js" --port 8080 \
  -e DATABASE_URL=postgres://... -e NODE_ENV=production

# Short TTL for quick test
burner deploy . --command "npm start" --ttl 10

burner ls

List your previews.

burner ls [--status <status>]

Shows a table of all your previews with their ID, subdomain, status, expiry, and command. Filter by status with --status running, --status failed, etc.

burner rm

Destroy a preview.

burner rm <id-or-subdomain-or-url>

Accepts a preview ID (prev_...), bare subdomain (icy-busy-pony-2718), or full URL.