Skip to content

Remote management

The simpledeploy CLI doubles as a remote client. Configure server contexts, then use pull, diff, and sync to keep local compose files in sync with one or more servers.

Manage remote server connections.

Terminal window
# Add a context
simpledeploy context add production --url https://manage.example.com --api-key sd_...
# Switch context
simpledeploy context use staging
# List contexts (* = active)
simpledeploy context list

Contexts live in ~/.simpledeploy/config.yaml.

Export remote app config to local files.

Terminal window
simpledeploy pull --app myapp -o ./
simpledeploy pull --all -o ./apps/

Downloads compose files from the remote server.

Compare local config vs remote state.

Terminal window
simpledeploy diff --app myapp
simpledeploy diff -d ./apps/

Shows line-by-line differences between local compose files and remote.

Sync a local directory to the remote server.

Terminal window
simpledeploy sync -d ./apps/

Deploys new/changed apps and removes apps not present locally.

A typical GitOps-ish workflow:

  1. simpledeploy pull --all -o ./apps/ to seed a local directory
  2. Commit ./apps/ to a Git repo
  3. Edit compose files locally, simpledeploy diff -d ./apps/ to preview
  4. simpledeploy sync -d ./apps/ to apply

For CI-driven deploys, see GitHub Actions integration.