// Use when modifying stackctl.sh and you need the repo-specific safety, portability, and validation rules for stack orchestration changes
Use when onboarding to the Local-Stack repo, locating the owning service or stack for a change, or checking Swarm migration conventions before editing infrastructure files
Use when changing Python utilities under tools/ and you need the repo-specific contracts for rendering, env handling, validation, and secret-safe behavior
| name | project-stackctl-changes |
| description | Use when modifying stackctl.sh and you need the repo-specific safety, portability, and validation rules for stack orchestration changes |
| metadata | {"migrated-from":".github/instructions/stackctl.instructions.md","source-format":".instructions.md"} |
stackctl.sh orchestrates rendering, deployment, diagnostics, and environment file management for Swarm stacks in this repo. Changes must stay portable across macOS and Linux, safe by default, and quiet about secrets.
stackctl.sh.set -euo pipefail and IFS=$'\n\t'.--force, interactive confirmation unless -y/--yes, and timestamped backups.${RENDER_DIR:-$SCRIPT_DIR/.rendered} and never print secret values.ensure_swarm_info and ensure_traefik_network in the deployment path, including dry-run-safe behavior.up, down, status, logs, doctor, and env.| Subcommand | Required behavior |
|---|---|
up | Render compose files, deploy stacks, optionally follow logs, honor --dry-run and stack selection |
down | Remove stacks, optionally remove network, honor --dry-run and -y/--yes |
status | List services for selected stacks |
logs | Follow logs for chosen services and clean up background jobs on exit |
doctor | Validate environment, network, and compose syntax |
env | List or recreate .env files from examples with safeguards and a summary report |
Run these after any stackctl.sh change:
bash -n stackctl.sh
./stackctl.sh help
./stackctl.sh doctor --fix-network
./stackctl.sh env --list
.rendered/ or logging secret values.