# CLI Reference Complete reference for every strut command, flag, and subcommand. Each command supports `--help` for inline usage (e.g. `strut my-stack backup --help`). ``` strut [--env ] [options] ``` ## Global Flags | Flag | Description | |------|-------------| | `--env ` | Environment name (reads `..env`) | | `--services ` | Service profile: `messaging`, `ui`, `full` | | `--json` | JSON output (where supported) | | `--dry-run` | Preview destructive operations without executing | | `--no-tui` | Disable the interactive TUI (since v0.19.0) | | `STRUT_NO_TUI=1` | Env-var equivalent of `--no-tui` (since v0.19.0) | ## Top-Level Commands These don't require a stack name: | Command | Description | |---------|-------------| | `strut` | Interactive TUI picker (stack → command → env) when stdin is a tty (since v0.19.0) | | `strut --print` | Same as `strut` but prints the resolved command instead of running it (since v0.19.0) | | `strut init [--registry ] [--org ]` | Initialize a new project with `strut.conf` | | `strut list` | List all available stacks | | `strut list plugins [--json]` | List discovered project plugins (since v0.17.0) | | `strut help ` | Show a project plugin's help text (since v0.17.0) | | `strut scaffold [--recipe ]` | Create a new stack from templates (optionally from a recipe, since v0.18.0) | | `strut scaffold list [--json]` | List available scaffold recipes (since v0.18.0) | | `strut upgrade` | Upgrade strut to latest version | | `strut --version` | Show installed version | | `strut skills [list\|install] [--format ]` | AI agent context management | | `strut audit [user] [key] [port]` | Audit a VPS | | `strut audit:list` | List past audits | | `strut audit:generate --from ` | Generate stack from audit | | `strut migrate [user] [port] [key] [--yes]` | Run migration wizard | | `strut migrate:status` | Show migration status | | `strut monitoring ` | Monitoring stack management | | `strut doctor [--check-vps] [--json] [--fix]` | Diagnostic environment check (includes SSH key perms) | | `strut status-all [--env ] [--json]` | Dashboard showing every stack at once (since v0.11.0) | | `strut posture [--stack ] [--category ] [--fail-on ] [--json]` | Security/ops posture check (since v0.11.0) | | `strut group list\|show\|add\|remove\| ` | Stack group dispatcher (since v0.15.0) | | `strut notify test ` | Send test notification (since v0.9.0) | | `strut completions ` | Print shell completion script (since v0.17.0) | | `strut init --completions` | Auto-install completions for current shell (since v0.17.0) | ## Per-Stack Commands All require: `strut [--env ]` ### Deployment | Command | Description | |---------|-------------| | `release [--services ]` | Full VPS release: update repo → migrate → deploy → verify | | `deploy [--services ] [--pull-only] [--skip-validation] [--force-unlock] [--no-lock] [--blue-green\|--standard]` | Deploy stack containers (concurrency-locked since v0.13.0; blue-green since v0.20.0) | | `stop [--volumes] [--timeout N]` | Stop running containers | | `update` | Pull latest strut code on VPS (no container restart) | | `diff [--json]` | Preview pending env/image changes vs VPS (since v0.13.0) | | `lock [--force] [--remote\|--local]` | Inspect/manage deploy concurrency locks (since v0.13.0) | ### Monitoring & Status | Command | Description | |---------|-------------| | `health [--json]` | Run health checks against `services.conf` | | `logs [service] [--follow] [--since ]` | View service logs | | `logs:download [service] [--since ]` | Download logs to local | | `logs:rotate` | Rotate log files | | `status` | Show container status | ### Database Operations | Command | Description | |---------|-------------| | `backup [postgres\|neo4j\|mysql\|sqlite\|all]` | Create backups | | `backup offsite >` | Offsite backup sync to S3/R2/B2 (since v0.16.0) | | `restore ` | Restore from backup file | | `db:pull [type] [--download-only] [--file ]` | Pull backup from VPS, restore locally | | `db:push [type] [--upload-only] [--file ]` | Push local backup to VPS, restore remotely | | `db:schema [apply\|verify\|all]` | Apply or verify Postgres schema SQL | | `migrate [neo4j\|postgres] [--status\|--up\|--down N]` | Run database migrations | ### Configuration Management | Command | Description | |---------|-------------| | `validate` | Validate all config files against expected schemas | | `drift [detect\|report\|fix\|auto-fix\|history]` | Configuration drift detection | | `keys ` | Key management (SSH, API, env, db, GitHub) | | `volumes [status\|init\|config]` | Volume management | | `domain [--skip-ssl]` | Configure domain and SSL | | `rollback [--list] [--dry-run]` | Roll back to previous deploy snapshot (blue-green: flips active color, since v0.20.0) | | `rollback diff [--json]` | Diff images between two snapshots; refs: `HEAD`, `HEAD~N`, basename (since v0.16.0) | | `prune [--volumes] [--all] [--no-protect]` | Prune docker resources; `--no-protect` skips rollback-image protection (since v0.16.0) | ### VPS Access | Command | Description | |---------|-------------| | `shell` | SSH to VPS (interactive) | | `exec ` | Execute single command on VPS | ### Debugging | Command | Description | |---------|-------------| | `debug exec ` | Execute command in container | | `debug shell ` | Open interactive shell in container | | `debug port-forward :` | Forward port from container | | `debug copy ` | Copy files to/from container | | `debug snapshot ` | Create container snapshot | | `debug inspect-env ` | Show environment variables | | `debug stats ` | Show real-time resource usage | ### Local Development | Command | Description | |---------|-------------| | `local start [--services ]` | Start stack locally | | `local stop` | Stop local stack | | `local reset` | Reset local environment | | `local sync-env --from ` | Sync env vars from production | | `local sync-db --from [target] [--anonymize]` | Sync database from production | | `local logs [--follow]` | Tail local logs | | `local test` | Run local smoke tests | ## Monitoring Commands ```bash strut monitoring deploy # Deploy monitoring stack strut monitoring add-target [env] # Add stack to monitoring strut monitoring remove-target # Remove from monitoring strut monitoring alert-channel add [options] # Configure alerts strut monitoring alert-channel test [type] # Test alert delivery strut monitoring status [--json] # Show monitoring status ``` ## Stack Groups (since v0.15.0) Groups are declared in `groups.conf` (INI-style) and run a strut command across every stack in the group. ```bash strut group list # List all groups strut group show # List members of a group strut group add # Append a stack strut group remove # Remove a stack strut group [--env ] [--stop-on-error] [--json] strut group logs [--follow] [--since ] [--grep ] [--service ] ``` `group logs` multiplexes logs across every member with a colored `[stack]` prefix. All other commands shell out to `strut ` per member and collect pass/fail. See [[Stack Groups]]. ## Notifications (since v0.9.0) ```bash strut notify test slack # Send a test event to SLACK_WEBHOOK strut notify test discord strut notify test webhook ``` Providers are configured in `notifications.conf` at the project root. See [[Notifications]]. ## Service Profiles | Profile | Description | |---------|-------------| | _(none)_ | Core services (default compose file) | | `gdrive` | Core + Google Drive ingestion | | `messaging` | Core + messaging service | | `ui` | Core + UI service | | `full` | All services | ## Examples ```bash # Full production release (recommended) strut my-app release --env prod # Preview before deploying strut my-app release --env prod --dry-run # Deploy with all services strut my-app deploy --env prod --services full # Health check with JSON output strut my-app health --env prod --json # Follow logs for a specific service strut my-app logs api --follow --env prod # Backup all databases strut my-app backup all --env prod # Pull production database locally strut my-app db:pull --env prod # Check for config drift strut my-app drift detect --env prod # Rotate database passwords strut my-app keys db:rotate postgres --env prod # Configure domain with SSL strut my-app domain api.example.com admin@example.com --env prod # List all stacks strut list # Create a new stack strut scaffold my-new-app # Cross-stack dashboard strut status-all --env prod strut status-all --env prod --json # Security/ops posture audit (CI-friendly exit codes) strut posture strut posture --category secrets --fail-on warn --json # Preview deploy changes vs VPS strut my-stack diff --env prod # Blue-green deploy (zero-downtime swap) strut my-stack deploy --env prod --blue-green strut my-stack deploy --env prod --blue-green --dry-run strut my-stack rollback --env prod # flips back to drained color # Diff two rollback snapshots strut my-stack rollback diff HEAD~1 HEAD strut my-stack rollback diff 20260420-091500 HEAD --json # Group operations strut group list strut group vps-1 deploy --env prod strut group vps-1 logs --follow # Offsite backup sync strut my-stack backup offsite status --env prod strut my-stack backup offsite sync --env prod strut my-stack backup offsite list --env prod ```