CLI safety reference
Prerequisites and authority
Use this reference with your installed release. Internal implementation routes and settings are not public integration contracts.
Command safety reference
Run commands against the recorded installation, not an assumed working directory. Use the commands supplied with your installed release and check their target and prerequisites before execution.
| Command/action | Effect/risk |
|---|---|
docker version, docker info |
Read runtime status; output may contain host details |
docker ps -a |
Read container inventory |
Compose config --services |
Validate/list service names without full secret expansion output |
Compose ps, bounded logs |
Read status/evidence; logs need redaction |
Compose restart <service> |
Interrupt the selected service |
Compose up with changed files |
May recreate services; confirm configuration first |
| Support-overlay MySQL recreation | Temporary local access and database interruption |
| Restore/update | Data/service-changing maintenance procedure |
| Volume removal or teardown with volumes | Destructive storage action; not routine support |
Do not paste placeholder service names or file paths without resolving them. Avoid shell command lines containing real passwords, tokens or recovery keys; they can enter history or process listings.
Read-only SQL is limited to approved diagnostic tables/columns with bounded queries. Direct INSERT/UPDATE/DELETE is excluded from public diagnostic examples.
Use supported control/installer tools for changes so deployment identity, configuration and persistent storage remain coordinated. Capture evidence and verify the affected workflow after an intervention. Unknown state requires escalation before a broader action.
Related guides
Related guides: Configuration reference (env vars, ports, URLs), Docker services, Compose files and persistent volumes, Database diagnostics and safe query reference, Subscription and provisioning state model.