Servel

Deploy applications and infrastructure to Docker Swarm with Vercel-like simplicity. Auto-detects project type, provisions SSL, zero-downtime rolling updates.

Decision Tree

code

Task → What are you trying to do?
│
├─ Deploy app → servel deploy --verbose
│   ├─ Need database? → servel add postgres --name db && servel deploy --verbose --link-infra db
│   ├─ Preview/PR? → servel deploy --verbose --preview --ttl 24h
│   └─ Multi-env? → servel deploy --verbose --env production
│
├─ Add infrastructure → servel add <type> --name <name>
│   ├─ Bundle? → servel add redis,postgres --prefix app
│   ├─ High-availability? → servel add postgres --name db --ha
│   └─ Link to app? → servel link myapp --infra db
│
├─ Debug/inspect → servel logs <name> -f | servel exec <name> sh
│   └─ Infra? → Use @ prefix: servel logs @mydb -f | servel exec @mydb --service rails sh
│
├─ Dev mode → servel dev
│   └─ Team sync? → servel dev --team
│
├─ Find resource → servel find <name>
│   └─ Infra only? → servel find @<name> --type postgres
│
├─ Manage server → servel remote status | servel ssh <server>
│   └─ Capacity? → servel capacity
│
├─ Routing issues → servel traefik status | servel verify dns <domain>
│
└─ Backup/restore → servel infra backup <name> | servel infra restore <name> <file>

Service Addressing (Symbol Prefixes)

Most commands that target a service (exec, logs, inspect, stats, restart, stop, start, scale, env, remove) support symbol prefixes:

Prefix	Type	Resolves to	Example
`name`	Deployment	`servel-name-*`	`servel logs myapp -f`
`@name`	Infrastructure	`servel-infra-name-*`	`servel logs @mydb -f`
`~name`	System	`servel-system-name`	`servel logs ~traefik`

For multi-service infrastructure (chatwoot, supabase, etc.), use --service:

bash

servel exec @chatwoot --service rails sh
servel logs @supabase --service postgres -f
servel restart @chatwoot --service sidekiq

Quick Reference

Deploy

IMPORTANT: Always use --verbose flag when deploying. It shows full build output, making it much easier to diagnose issues and understand what's happening. Without it, build output is summarized and critical context is lost.

bash

servel deploy --verbose               # Auto-detect & deploy (ALWAYS use --verbose)
servel deploy --verbose --preview --ttl 24h     # Preview with cleanup
servel deploy --verbose --link-infra db,redis   # Link infrastructure
servel deploy --verbose --dry-run               # Show plan only
servel deploy --verbose --no-registry           # Skip registry (single-node)
servel deploy --verbose --env staging           # Multi-environment
servel deploy --verbose --rebuild               # Force rebuild, skip cache
servel deploy --memory 1g --cpu 0.5   # Resource limits
servel ps                             # List deployments
servel ps --all-servers               # List across all servers
servel ps --tree                      # Tree view with dependencies
servel logs <name> -f                 # Follow logs
servel watch <name>                   # Watch deploy progress (TUI)
servel rm <name>                      # Remove
servel rollback <name>                # Rollback version
servel scale <name> 3                 # Scale replicas
servel restart <name>                 # Restart deployment
servel stop <name>                    # Stop deployment
servel start <name>                   # Start stopped deployment
servel rename <old> <new>             # Rename deployment
servel exec <name> sh                 # Shell into container
servel exec <name> -- cmd args        # Run command in container
servel inspect <name>                 # Detailed deployment info
servel history <name>                 # Deployment history
servel versions <name>                # Available versions
servel find myapp                    # Find across all servers
servel find @mydb                    # Find infrastructure only
servel find --type postgres          # Filter by infra type

Build args injected automatically:

•SERVEL_GIT_COMMIT — Git commit SHA (available during build)
•SERVEL_GIT_BRANCH — Git branch name (available during build)
•SERVEL_DEPLOY_TIME — Deploy timestamp in RFC3339 UTC (always set)

Use ARG SERVEL_GIT_COMMIT + ENV SERVEL_GIT_COMMIT=$SERVEL_GIT_COMMIT in Dockerfile to persist at runtime.

Detection priority: servel.yaml → docker-compose.yml → Dockerfile → preset → Nixpacks

Smart mode (default): Detects what changed → config-only (~8s), static-only (~10s), or full build.

Key flags:

•--name, -n — Deployment name
•--domain, -d — Domain for routing
•--preview — Preview environment
•--ttl — Preview lifetime (1h, 6h, 1d, 7d, 2w)
•--link-infra — Link infrastructure (comma-separated)
•--no-registry — Skip registry push
•--rebuild — Force rebuild
•--no-smart — Disable smart detection
•--verbose — Show full build output (always recommended)
•--env — Target environment
•--build-on <node> — Build on specific node
•--local-build — Build locally, push to registry

Deploy Aliases

Define deployment presets in servel.yaml:

yaml

deploy:
  aliases:
    preview:
      ttl: "0"
      domain: "{branch}.preview.myapp.com"
      no_index: true
    quick:
      fast: true
      local: true
    staging:
      env: staging
      domain: "staging.myapp.com"

Usage: servel deploy preview, servel deploy quick

•If a directory exists with that name → deploys directory
•Otherwise → applies alias settings

Infrastructure (45+ types)

Category	Types
Database	postgres, mysql, mongodb, clickhouse, redis, libsql + HA variants (postgres-ha, mysql-ha, mongodb-ha, redis-ha)
Queue	rabbitmq
Search	meilisearch, typesense
Platform	supabase, supabase-ha, chatwoot, typebot, convex, affine, forgejo, clawdbot, maily, surfsense
Analytics	plausible, umami, openreplay
Monitoring	prometheus, grafana, loki, promtail, uptimekuma, gatus, peekaping
Realtime	livekit, livekit-egress, hocuspocus, y-sweet
Storage	minio
Email	posteio
CI	woodpecker, woodpecker-agent
Blockchain	bitcoin, ipfs, lnd

bash

servel add postgres --name db         # Create
servel add redis,postgres --prefix app # Bundle multiple
servel add postgres --name db --ha    # High-availability
servel add supabase --name supa       # Full platform stack
servel add chatwoot --var Domain=chat.example.com  # Auto-init on first deploy
servel infra status                   # Health check all
servel infra vars db                  # View env vars
servel logs @db -f                    # Follow infra logs (@ prefix)
servel logs @chatwoot --service rails -f  # Multi-service infra logs
servel infra backup db                # Backup
servel infra restore db backup.sql.gz # Restore
servel infra rotate db                # Rotate credentials
servel infra restart db --force       # Force restart
servel infra start db                 # Start
servel infra stop db                  # Stop
servel infra rename old new           # Rename
servel infra rm db                    # Remove
servel infra check                    # Diagnose all (orphaned constraints, port conflicts, stuck services)
servel infra check mydb               # Check specific infra
servel infra sql @mydb schema.sql     # Run SQL file against database
servel infra sql @mydb "SELECT 1"     # Run inline SQL
servel link myapp --infra db          # Link → injects DATABASE_URL
servel unlink myapp --infra db        # Unlink
servel deps myapp                     # Show dependencies
servel connect db                     # Quick connect to infra

Linking injects: DATABASE_URL, REDIS_URL, MONGODB_URI, etc. based on infrastructure type.

Lifecycle hooks: Some templates auto-run setup commands on first deploy (e.g., Chatwoot runs db:chatwoot_prepare).

Node pinning:

•--node hostname — By hostname
•--alias db-node — By alias
•--label storage=ssd — By node label

Server Management (remote)

servel server is aliased to servel remote. Both work interchangeably.

bash

servel ssh <server>                   # SSH into server
servel remote status                  # Cluster health (CPU, memory, disk)
servel remote add <name> user@host    # Add server
servel remote list                    # List servers
servel remote use <name>              # Switch default server
servel remote remove <name>           # Remove server
servel remote provision               # Automated setup
servel remote provision --repair      # Repair corrupted keys/services
servel remote domain set example.com  # Set primary domain
servel remote keys add <name> --key-file pubkey.pub # Add deploy key
servel capacity                       # Capacity forecast + recommendations
servel capacity --json                # JSON output
servel df                             # Disk usage
servel df --volumes                   # Volume usage by category
servel df --nodes                     # Per-node usage
servel doctor                         # Diagnose issues
servel doctor --remote KN             # Remote server diagnostics
servel cleanup                        # Remove expired environments
servel cleanup --force                # No confirmation
servel prune                          # Remove dangling images/containers
servel prune --all                    # Remove unused images/networks/cache
servel prune --all --volumes          # ⚠️ DATA LOSS: removes unused volumes

Node Management

bash

servel node ls                        # List swarm nodes
servel node ps                        # Per-node service view (grouped by host)
servel node ps --node KN-MANAGER      # Filter to specific node
servel node ps --json                 # JSON output
servel node add worker user@host      # Add node to cluster
servel node remove <name>             # Remove node
servel node promote <name>            # Promote to manager
servel node health <name>             # Check node health
servel node specs <name>              # Node specifications
servel node drain <name>              # Drain for maintenance
servel node drain <name> --remove     # Drain then remove from cluster
servel node activate <name>           # Reactivate drained node
servel node balance --dry-run         # Preview rebalance plan
servel node balance                   # Execute cluster rebalance
servel node schedule <name> --at "2026-02-01 03:00"  # One-time drain
servel node schedule <name> --in 2h   # Relative time drain
servel node schedule <name> --cron "0 3 * * *"       # Recurring drain
servel node schedule <name> --cron "0 3 * * *" --reactivate "0 7 * * *"  # Drain + reactivate
servel node schedule ls               # List scheduled actions
servel node schedule cancel <name>    # Cancel schedule
servel node install --all             # Install servel CLI on all workers
servel node upgrade --all             # Upgrade servel CLI on all nodes
servel node alias <hostname> <alias>  # Set friendly alias
servel node label <hostname> key=val  # Add/remove node labels

Secrets

bash

servel secrets set API_KEY            # Set (prompted input)
servel secrets set API_KEY "value"    # Set with value
servel secrets list                   # List keys
servel secrets get API_KEY            # Get value
servel secrets rm API_KEY             # Remove
servel secrets rotate API_KEY         # Rotate
servel secrets backup                 # Backup all secrets
servel secrets scan                   # Scan for exposed secrets
servel deploy --migrate-secrets       # Auto-detect *_KEY, *_SECRET, *_PASSWORD

Domains & Routing

bash

servel domains add myapp app.com      # Add domain (auto-SSL)
servel domains ls                     # List all domains
servel domains rm myapp app.com       # Remove domain
servel domains redirect old.com new.com # Create redirect
servel domains remove-redirect old.com # Remove redirect
servel domains list-redirects         # List redirects
servel routes <name>                  # Show deployment routes

Traefik (Routing Layer)

bash

servel traefik status                 # Router status
servel traefik logs                   # Traefik logs
servel traefik routes <name>          # Detailed route info
servel traefik certs                  # SSL certificate info
servel traefik test <domain>          # Test domain routing
servel traefik restart                # Restart Traefik

Verification

bash

servel verify <name>                  # Full verification
servel verify config                  # Verify configuration
servel verify health <name>           # Check service health
servel verify ssl <domain>            # Check SSL certificates
servel verify dns <domain>            # Check DNS configuration
servel verify routing <name>          # Check Traefik routing
servel verify dependencies <name>     # Check dependencies
servel verify resources               # Check resource availability

Dev Mode

bash

servel dev                            # Start dev session
servel dev --team                     # Bidirectional sync (collaboration)
servel dev --port 3001                # Custom port
servel dev --domain staging.app.com   # Custom domain
servel dev --no-sync                  # One-time upload only
servel dev --conflict-policy newer-wins # Sync conflict resolution
servel dev list                       # Active sessions
servel dev logs <id> -f               # Follow session logs
servel dev stop <id>                  # Stop session
servel tunnel                         # Expose localhost publicly
servel tunnel start <port>            # Start tunnel on port
servel tunnel list                    # List active tunnels
servel tunnel stop <id>               # Stop tunnel
servel port-forward db 5432           # Forward remote port locally

Conflict policies: remote-wins, local-wins, newer-wins, backup

Environment Variables

bash

servel env set <name> KEY=VALUE       # Set env var
servel env vars <name>                # Show env vars
servel env list                       # List environments
servel config show <name>             # Show deployment config
servel config sync <name>             # Sync config to servel.yaml
servel config sync --dry-run          # Preview sync

Alerts

bash

servel alerts setup                   # Interactive wizard
servel alerts add telegram            # Add Telegram channel
servel alerts add slack               # Add Slack channel
servel alerts add discord             # Add Discord channel
servel alerts add webhook             # Add webhook
servel alerts test                    # Test notifications
servel alerts status                  # Show alert status
servel alerts history                 # View alert history
servel alerts pause 2h                # Maintenance mode (pause alerts)

CI/CD

bash

servel ci init github                 # Initialize GitHub Actions
servel ci init gitlab                 # Initialize GitLab CI
servel ci list                        # List pipelines
servel ci run <config>                # Run built-in CI
servel ci run <config> --domain x.com # Auto-route CI service
servel ci status <run-id>             # Check run status
servel ci logs <run-id>               # View CI logs
servel ci recent                      # Recent runs
servel ci cancel <run-id>             # Cancel run
servel ci retry <run-id>              # Retry run

Access Control

bash

servel auth login                     # User authentication
servel auth logout                    # Logout
servel auth whoami                    # Current user info
servel auth enable <name>             # Enable basic auth
servel auth disable <name>            # Disable basic auth
servel access user                    # User management
servel access user create --name bob --ssh-key key.pub  # Add user with key
servel access user create --name bob --generate-key     # Generate keypair for user
servel access role                    # Role management
servel access setup                   # Initialize access control on server
servel access setup --rotate-join-key # Rotate join key
servel access invite bob              # Generate invite token
servel access join <token>            # Join server with invite token (no prior SSH needed)

Registry

bash

servel registry                       # Browse registry repos
servel registry tags myapp            # List tags with sizes
servel registry rm myapp:v1.0         # Delete tag (confirmation required)
servel registry info                  # Registry info + capabilities
servel registry du                    # Per-repo disk usage breakdown

Advanced

bash

servel detect                         # Detect project build type
servel detect --verbose               # Detailed detection info
servel init                           # Initialize servel.yaml
servel validate                       # Validate servel.yaml
servel upgrade                        # Self-upgrade CLI
servel upgrade-servers                # Upgrade servel on all servers
servel upgrade-servers --remote KN    # Upgrade specific server
servel audit list                     # View audit logs
servel audit stats                    # Audit statistics
servel tag <name> <tag>               # Add tags to deployment
servel untag <name> <tag>             # Remove tags

Common Workflows

Deploy with Database

bash

servel add postgres --name mydb
servel deploy --verbose --link-infra mydb
# App receives DATABASE_URL, DB_HOST, DB_PORT, DB_PASSWORD

Preview Deployments

bash

servel deploy --verbose --preview --ttl 24h
# Returns: https://myapp-pr42.example.com

Multi-Environment

bash

servel deploy --verbose --env production
servel deploy --verbose --env staging
servel deploy --verbose --preview

Debug Container

bash

servel logs myapp -f                  # View logs
servel exec myapp sh                  # Shell into container
servel exec myapp -- cat /app/.env    # Run command
servel logs @mydb -f                  # View infra logs (@ prefix)
servel exec @chatwoot --service rails sh  # Multi-service infra

Backup & Restore

bash

servel infra backup mydb
servel infra restore mydb backup-2024-01-15.sql.gz

CI/CD Deploy Keys

bash

servel remote keys add prod --name github-actions --key-file pubkey.pub

Troubleshoot Routing

bash

servel verify dns app.example.com     # Check DNS
servel verify ssl app.example.com     # Check SSL
servel traefik test app.example.com   # Test routing
servel traefik logs                   # View Traefik logs

Configuration (servel.yaml)

yaml

name: myapp
domain: app.example.com

build:
  preset: bun                         # bun, node, python, go
  dockerfile: Dockerfile
  buildCommand: bun run build
  startCommand: bun run start

env:
  NODE_ENV: production

secrets:
  - API_KEY
  - DB_PASSWORD

resources:
  memory: 512M
  cpus: 0.5

replicas: 2

healthcheck:
  type: http                          # http, tcp, cmd, none
  path: /health
  interval: 30s
  timeout: 10s
  retries: 3

update:
  order: start-first                  # start-first, stop-first
  failure_action: rollback            # rollback, pause, continue

infra:
  - name: mydb
    prefix: DB                        # → DB_HOST, DB_PORT, DB_PASSWORD

routes:
  - type: http
    domain: app.example.com
    port: 3000
  - type: http
    domain: api.example.com
    path: /v1/*
    port: 3001

persist:
  - /app/data
  - /app/uploads

dev:
  command: bun run dev
  port: 3000
  sync:
    ignore:
      - "*.log"
      - ".cache"

environments:
  production:
    domain: myapp.com
    replicas: 5
  staging:
    domain: staging.myapp.com
  preview:
    ttl: 7d

Aliases

Command	Aliases
deploy	d, push
remove	rm, delete
logs	log
exec	x, run
rollback	rb
inspect	i, info
ps	ls, list
verify	v, check
doctor	dr
port-forward	pf
watch	w
remote	srv, server
infra	infrastructure
domains	dom
alerts	alert, alrt
connect	conn
tunnel	tun
rename	mv, move
add	create, new
stats	stat
access	acl
find	search, where
capacity	cap, forecast
registry	reg
redeploy	rd

Troubleshooting

Issue	Solution
Build fails	`servel logs <name>` (deploy should already use `--verbose`)
Port conflict	Use `--port` flag
Domain not working	`servel verify dns <domain>`
SSL issues	`servel verify ssl <domain>`
Container exits	Check start command and port
Smart mode wrong	Use `--no-smart` for full rebuild
Routing broken	`servel traefik test <domain>`
Health check fails	`servel verify health <name>`

Diagnostic commands:

bash

servel doctor                         # System check
servel verify health <name>           # Health check
servel verify dns <domain>            # DNS check
servel verify ssl <domain>            # SSL check
servel traefik status                 # Routing status
servel logs <name>                    # View logs
servel inspect <name>                 # Deployment details

Project Context Detection

For advanced cases, check these local files to understand the deployment context before running servel commands.

.servel/ Directory (Project State)

Located at <project-root>/.servel/. Created automatically after first deploy. Contains deployment state that tells you which server this project deploys to and its current configuration.

Files:

•.servel/state.json — Production environment state
•.servel/state.<env>.json — Other environment states (e.g., state.staging.json)

State file structure:

json

{
  "version": 1,
  "server": "KN",                    // ← Which server this deploys to
  "server_fingerprint": "uuid-...",  // Stable ID (survives server renames)
  "deployment_id": "myapp",
  "environment": "production",
  "build_type": "dockerfile",        // dockerfile, compose, nixpacks
  "project_name": "myapp",
  "domain": "myapp.example.com",     // Saved domain (non-config projects)
  "install_command": "",             // Vercel-style overrides
  "build_command": "",
  "start_command": "",
  "port": "",
  "runtime": "",                     // node or bun (for Nixpacks JS/TS)
  "tags": [],
  "network_mode": "",
  "network_name": ""
}

How to use:

•Read .servel/state.json to determine the target server and deployment name
•Check for multiple environments with .servel/state.*.json
•The server field maps to a remote in ~/.servel/config.yaml
•If .servel/ doesn't exist, the project hasn't been deployed yet

List environments:

bash

ls .servel/state*.json  # See all deployed environments

servel.yaml (Project Configuration)

Located at <project-root>/servel.yaml. Defines how the project should be built and deployed. This is the declarative config — checked into version control.

Key fields for context:

yaml

name: myapp                          # Deployment name
domain: app.example.com              # Primary domain
domains:                             # Multiple domains
  - app.example.com
  - api.example.com
port: 3000                           # Container port

build:
  preset: bun                        # bun, node, python, go
  dockerfile: Dockerfile
  buildCommand: bun run build
  startCommand: bun run start

env:
  NODE_ENV: production
secrets:
  - API_KEY

resources:
  memory: 512M
  cpus: 0.5
replicas: 2

infra:                               # Linked infrastructure
  - name: mydb
    prefix: DB                       # → DB_HOST, DB_PORT, DB_PASSWORD

routes:                              # Advanced routing
  - type: http
    domain: app.example.com
    port: 3000

persist:                             # Persistent storage paths
  - /app/data

environments:                        # Multi-environment overrides
  production:
    domain: myapp.com
    replicas: 5
  staging:
    domain: staging.myapp.com

deploy:
  aliases:                           # Deploy presets
    preview:
      ttl: "0"
      domain: "{branch}.preview.myapp.com"
    quick:
      fast: true
      local: true

middlewares:                          # Traefik middleware config
  rate_limit:
    average: 100
    burst: 50

dev:                                 # Dev mode settings
  command: bun run dev
  port: 3000

Detection priority: servel.yaml → docker-compose.yml → Dockerfile → preset → Nixpacks

Putting It Together

When working with a servel-managed project:

•Check .servel/state.json → Know which server, deployment name, and environment
•Check servel.yaml → Know build config, domains, infra links, resources
•No .servel/ dir → Project not yet deployed (use servel deploy first)
•No servel.yaml → Auto-detected project (Dockerfile/compose/preset)

Example workflow:

code

# Understand current project deployment
cat .servel/state.json          # → server: "KN", project_name: "myapp"
cat servel.yaml                 # → domain, infra links, build config

# Now you know: myapp is deployed on KN server
servel logs myapp               # View logs
servel inspect myapp            # Full details

Reference Files

•Template Building Guide - Create custom infrastructure types
•Full docs: https://servel.dev/docs
•Infrastructure Hub: https://hub.servel.dev