CLI Reference

Complete command reference for every relight command.

Global patterns

  • Topic root = list: relight apps lists apps, relight db lists databases
  • --json on most commands for machine-readable output
  • --compute <name> to target a specific compute provider
  • --db <name> to target a specific database provider
  • --dns <name> to target a specific DNS provider
  • --confirm <name> to skip destructive prompts

providers

relight providers                          List configured providers
relight providers add [type]               Add a provider (gcp, aws, azure, cf, do, ghcr)
relight providers remove <name>            Remove a provider
relight providers default <layer> <name>   Set default provider for a layer (app, db, dns, registry)

deploy

relight deploy [name] [path]      Deploy from Dockerfile
  --compute <name>                Provider for compute
  -t, --tag <tag>                 Image tag
  -e, --env KEY=VALUE ...         Set env vars
  --regions <hints>               Region hints (comma-separated)
  -i, --instances <n>             Instances per region
  --port <port>                   Container port (default: 8080)
  --sleep <duration>              Idle timeout (default: 30s)
  --instance-type <type>          Preset: lite, base, standard, large
  --vcpu <n>                      vCPU allocation
  --memory <mb>                   Memory in MiB
  --disk <mb>                     Disk in MB
  --dns <name>                    Provider for DNS records
  --no-observability              Disable observability (CF only)
  --json                          JSON output
  -y, --yes                       Skip confirmation

apps

relight apps                      List all deployed apps
  --compute <name>                Filter by provider
  --json                          JSON output
relight apps info [name]          Show app details
relight apps destroy [name]       Destroy app
  --confirm <name>                Skip confirmation
relight destroy [name]            Alias for apps destroy

config

relight config show [name]        Show env vars
  --json                          JSON output
relight config set <args...>      Set env vars ([name] KEY=VALUE ...)
  -s, --secret                    Store as encrypted secret
relight config get <args...>      Get a single var ([name] KEY)
relight config unset <args...>    Remove env vars ([name] KEY ...)
relight config import [name]      Import from .env file or stdin
  -f, --file <path>               Path to .env file
  -s, --secret                    Import all as secrets

scale

relight scale [name]              Show current scaling
  -r, --regions <hints>           Set regions
  -i, --instances <n>             Instances per region
  --instance-type <type>          Size preset
  --vcpu <n>                      vCPU allocation
  --memory <mb>                   Memory in MiB
  --disk <mb>                     Disk in MB
  --json                          JSON output

domains

relight domains [name]            List custom domains
  --json                          JSON output
relight domains add [args...]     Add custom domain ([name] [domain])
  --dns <name>                    Provider for DNS records
relight domains remove <args...>  Remove custom domain ([name] <domain>)

db

relight db                        List all databases
  --db <name>                     Filter by provider
  --json                          JSON output
relight db create <name>          Create database
  --db <name>                     Database provider
  --location <hint>               Location hint
  --jurisdiction <j>              Jurisdiction (eu, fedramp)
relight db destroy <name>         Destroy database
  --confirm <name>                Skip confirmation
relight db info <name>            Show connection details
relight db attach <name> [app]    Attach to app (injects DATABASE_URL)
  --db <name>                     Database provider
  --compute <name>                App compute provider
relight db detach [app]           Detach from app
relight db shell <name>           Interactive SQL REPL
relight db query <args...>        Run SQL query ([name] <sql>)
  --json                          JSON output
relight db import <args...>       Import .sql file ([name] <path>)
relight db export <name>          Export as SQL dump
  -o, --output <path>             Write to file
relight db token <name>           Show auth token
  --rotate                        Rotate credentials
relight db reset <name>           Drop all tables
  --confirm <name>                Skip confirmation

monitoring

relight ps [name]                 Show container status
  --json                          JSON output
relight logs [name]               Stream live logs
relight cost [name]               Show estimated costs
  --since <period>                Date range (7d, 30d, YYYY-MM-DD)
  --json                          JSON output
relight open [name]               Open app in browser
relight regions                   List available regions
  --compute <name>                Provider for compute
  --json                          JSON output
relight doctor                    Check system setup