CLI Reference
Invocation: run soviez.sh from any directory after installation (typically /usr/local/bin/soviez.sh).
Not supported: legacy single-flag migration shortcuts (never implemented).
Global options
| Flag | Purpose |
|---|
-h, --help | Usage summary |
--confirm / --yes / -y | Confirm destructive or non-interactive steps |
--dry-run | Preview changes without applying (where supported) |
--output PATH | Export path for bundles and reports |
Host setup and health
| Command | Purpose | Network |
|---|
--init | Prepare host: Docker, Nginx, firewall, security baseline | Local |
--doctor | Consolidated health check | Offline |
--version | Platform version and channel | Offline |
--help | Full usage | Offline |
--platform-install | Install or refresh platform payload | Local |
Environments
| Command | Purpose | Network |
|---|
--list | All Production and Stage environments | Offline |
--new | Create a new Production ERP environment | Connected |
--reattach <operation-id> | Resume an in-progress --new operation | Varies |
sudo soviez.sh --new [--domain erp.example.com] [--activation automatic|manual]
Resource tuning
| Command | Purpose |
|---|
--tune --dry-run | Preview sizing changes |
--tune --explain | Show calculation details |
--tune | Apply safe Odoo/PostgreSQL/Docker sizing |
Updates
| Command | Purpose |
|---|
--update <production-id> --release <release-id> | Apply an approved ERP release |
--update-status|reattach|cancel|retry|recover|rollback|cleanup | Update operation control |
--update-image-status|cleanup | Image retention on disk |
--releases | List available releases (where entitled) |
--release-status <environment-id> | Current release on an environment |
Updates require an exact --release ID. There is no Production-safe “latest” pull.
Stage
| Command | Purpose |
|---|
--stage --production-tenant <id> --stage-domain <fqdn> | Create Stage from Production |
--stage-list|status|start|stop|backup|drop | Stage lifecycle |
--stage-retention-status|extend|run|retry|reattach | Retention management |
Default Stage retention: 14 days. Maximum: 60 days from creation.
Backup and restore
| Command | Purpose |
|---|
--backup <production-id> [--type full|database-only] [--destination PROFILE] | Create backup |
--backup-list|show|verify|pin|unpin|delete|export|import | Backup management |
--backup-destination-list|show|test | Off-host destination profiles |
--backup-schedule-add|list | Scheduled backups |
--restore <production-id> --backup <backup-id> [--confirm] | Restore Production |
--restore-test <backup-id> | Validate backup without switching Production |
--restore-as-stage <backup-id> --stage-domain <fqdn> | Restore into isolated Stage |
--restore-status|cancel|retry|recover|rollback|cleanup | Restore operation control |
Security
| Command | Purpose |
|---|
--security-status|scan|scan-db|check|harden|report | Security posture and scans |
--security-update-check|backup-check | Post-update and backup gates |
--security-quarantine-status|scan|promote|reject | Quarantine workflow |
SSL / TLS
| Command | Purpose |
|---|
--ssl-status|renew|repair|policy|try-again|abort|reattach | Certificate lifecycle |
Operations registry
| Command | Purpose |
|---|
--operations [--active|--failed] | List long-running operations |
--operation-status|reattach|cancel|retry|recover|logs|reconcile | Unified operation control |
Migration (Soviez → Soviez)
Migration uses the --migration-* family only. There is no single-flag migrate-in command.
Common entry points:
soviez.sh --migration-discover <production-id>
soviez.sh --migration-bootstrap-destination [--confirm]
soviez.sh --migration-pair <production-id> --destination-code CODE [--confirm]
soviez.sh --migration-readiness <pair-id>
soviez.sh --migration-transfer-start <pair-id> [--confirm]
soviez.sh --migration-activate-destination <pair-id> [--confirm]
soviez.sh --migration-cutover-start <pair-id> [--confirm]
soviez.sh --migration-status <operation-id>
See MIGRATION.md for the full workflow and additional flags.
Offline
| Command | Purpose |
|---|
--offline-request / --offline-import PATH | Stage offline authorization |
--update <id> --offline-package PATH | Offline ERP update |
See OFFLINE_UPDATES.md and OFFLINE_MODE.md.
Connectivity notes
- Read-only and local commands (
--list, --doctor, --version, diagnostics, recovery) work offline or during service outages.
- Connected mutating commands (install, update, new Stage) require outbound HTTPS and valid entitlement.
- Platform and security self-updates for Soviez.sh are not blocked by Technical Support expiry; ERP product updates are entitlement-gated.
Related docs
