CLI Reference

# From a repo with a GitHub remote — name and repo auto-detected
cd ~/my-project
brokr create web-app
 
# New repo from scratch
brokr create web-app --name my-app
 
# Scaffold a Next.js starter (no login needed)
brokr create web-app --name my-app --fw next
 
# With a custom domain
brokr create web-app --name smooth --domain smooth.app
 
# With staging enabled
brokr create web-app --name my-app --staging

brokr delete my-app
# ⚠ This will permanently delete 'my-app' and all resources.
# Type the stack name to confirm: my-app
# ✓ Stack deleted

brokr list
# my-app      active    https://my-app.brokr.sh
# side-proj   provisioning

brokr status my-app
brokr status my-app --watch
brokr status --json

brokr add database --stack my-app
brokr add ai_provider --stack my-app
brokr add auth --stack my-app  # auto-scaffolds auth files

brokr remove database --stack my-app
brokr remove neon --stack my-app     # provider alias works too
brokr remove email --yes             # skip confirmation

# Full deploy — code + env + build + watch
brokr deploy
#   ✓ Code pushed      →  https://github.com/you/my-app
#   ✓ Env synced       →  12 vars pushed to Vercel
#   ✓ Deploy triggered →  dpl_abc123
#   ✓ Ready            →  https://my-app.brokr.sh  (1m 18s)
 
# Custom commit message
brokr deploy -m "fix auth redirect"
 
# Just sync env vars, no code push or build
brokr deploy --env-only
 
# Skip env sync, just deploy code
brokr deploy --skip-env
 
# Deploy to staging (if enabled)
brokr deploy staging
 
# Deploy to production
brokr deploy prod

brokr promote
# ✓ PR created: staging → main
# ✓ Auto-merged (squash)
# Production will auto-deploy after merge.

# Enable staging on a stack
brokr staging enable --stack my-app
 
# Add your current IP to the whitelist
brokr staging wl add
 
# Add a specific IP
brokr staging wl add 203.0.113.42
 
# List whitelisted IPs
brokr staging wl list
 
# Disable whitelisting
brokr staging wl off

# By name (requires auth)
brokr attach my-app
 
# By dashboard attach code (no auth needed — opens OAuth flow)
brokr attach att_A1b2C3d4
 
# After attaching, seeds .env.brokr with managed vars
# ✓ Attached to my-app
# ✓ .env.brokr seeded → 8 vars

brokr detach
# ✓ Removed .brokr
# ✓ Removed .env.brokr
 
# Also remove .git directory
brokr detach
# (prompts unless --yes)
 
# Keep git history
brokr detach --keep-git
 
# Full clean including node_modules
brokr detach --clean

brokr fork git --stack my-app
# ✓ Forked to github.com/you/my-app
# Update Vercel project to use fork? (y/n)
# ✓ Local remotes updated: origin → brokr, fork → origin

brokr transfer git --stack my-app
# ⚠ This is irreversible. Type 'my-app' to confirm: my-app
# ✓ Repo transferred to github.com/you/my-app
# ✓ Vercel project updated
# ✓ Stack marked as user-owned
 
# Preview without making changes
brokr transfer git --stack my-app --dry-run

# Live tail (default)
brokr logs
 
# Last 2 hours, errors only
brokr logs --last 2h --level error
 
# Filter by function path
brokr logs --source /api/chat
 
# Specific deployment
brokr logs --deployment dpl_abc123

# Last 10 error groups (default)
brokr errors
 
# Last 24 hours, more groups
brokr errors --last 1d --limit 25

brokr doctor
# ✓ Node.js v20.11.0
# ✓ Authenticated as you@example.com
# ✓ API reachable at https://api.brokr.sh
# ✓ Token valid

brokr balance
# Balance: $42.50
# Auto-reload: ON ($25 when below $5)
# Payment method: Visa ****4242

# Default $25 top-up
brokr topup
 
# Custom amount
brokr topup 100
# Opens Stripe Checkout → polls for confirmation
# ✓ Payment confirmed → Balance: $142.50

brokr billing
# Opens https://billing.stripe.com/session/...

# Interactive session
brokr build
 
# One-shot mode
brokr build "add a contact form with email sending"
 
# Use a different model
brokr build --model sonnet "refactor the auth flow"
 
# Create a branch for changes
brokr build --branch "add dark mode support"

# Apply a bundle
brokr apply a1b2c3d4
# ✓ Created  src/components/ContactForm.tsx
# ✓ Updated  src/app/page.tsx
 
# Preview without writing files
brokr apply a1b2c3d4 --dry-run

brokr search domains --name smooth
#   smooth.app       $14.99/yr   ✓ available
#   smooth.dev       $12.99/yr   ✓ available
#   smooth.io        $34.99/yr   ✓ available
#   smooth.com       —           ✗ taken
 
# Filter by TLD
brokr search domains --name my-app --tld .app,.dev
 
# Show more results
brokr search domains --name cool-project --count 10

brokr whoami
# you@example.com

# From the stack directory (reads .brokr)
brokr claim
# ✓ Stack claimed → clxxxxxxxxxxxxx
 
# Explicit stack ID
brokr claim clxxxxxxxxxxxxx

# Quoted string → NL mode
brokr "give me a postgres database on neon for my-app"
 
# Unrecognized command → NL mode
brokr add a database to my-app
 
# Explicit via alias
brokr do "spin up an ai-app with vercel and openai"

// CreateStackResponse
{
  "ok": true,
  "stackId": "stk_abc123",
  "plan": {
    "stackName": "my-app",
    "mode": "temporary",
    "repoConfig": {
      "mode": "create",
      "ownership": "brokr-managed",
      "mutation": "direct",
      "raw": "create",
      "value": "create"
    }
  },
  "message": "Stack provisioned"
}
 
// ErrorResponse
{
  "ok": false,
  "code": "STACK_NOT_FOUND",
  "message": "Stack 'my-app' does not exist.",
  "hint": "Run 'brokr list' to see your stacks."
}