CLICommand referencedeployment deployment
Commands, arguments, and options for openship deployment.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
Manage deployments (list, inspect, redeploy, rollback, …)
openship deployment|deployments [options] [command]
Inspect pending deployment, routing and certificate actions
openship deployment actions [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Cancel an in-progress deployment
openship deployment cancel [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Show a single deployment
openship deployment get [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Show container info for a deployment
openship deployment info [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Keep a finished deployment awaiting a keep/reject decision
openship deployment keep [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
List deployments (org-wide, or scoped to a project)
openship deployment list [options]
| Option | Meaning |
|---|
--project <id> | Scope to a project (defaults to the linked project) |
--env <environment> | Filter by environment: production | preview |
--limit <n> | Page size (1–100) (default: 50) |
--page <number> | Page number (default: 1) |
--status <status> | Deployment history status filter |
--search <text> | Search deployment history |
--page-info | Return complete records and pagination as JSON |
Show a deployment's current prompt and pending decisions
openship deployment pending [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Pin (or unpin) a deployment's rollback artifact
openship deployment pin [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
| Option | Meaning |
|---|
--off | Unpin instead of pin |
Redeploy from an existing deployment
openship deployment redeploy [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
| Option | Meaning |
|---|
--use-existing-commit | Rebuild the same commit instead of the latest on the branch |
Reject a finished deployment awaiting a keep/reject decision
openship deployment reject [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Answer a pending deployment prompt
openship deployment respond [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
| Option | Meaning |
|---|
--action <action> | An action ID offered by the pending prompt |
Restart a deployment's container
openship deployment restart [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Inspect retained artifacts and which services a rollback would rebuild
openship deployment restore-plan [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Delete a deployment
openship deployment rm [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
| Option | Meaning |
|---|
-y, --yes | Skip the confirmation prompt |
Roll back to a previous deployment
openship deployment rollback [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID to roll back to |
Skip one explicitly selected deployment port check
openship deployment skip-port-check [options] <id> <target>
| Argument | Meaning |
|---|
id | Deployment ID |
target | Port number or target offered by the deployment |
| Option | Meaning |
|---|
-y, --yes | Acknowledge skipping this readiness check |
SSL certificate operations
openship deployment ssl [options] [command]
Renew (issue) an SSL certificate for a domain
openship deployment ssl renew [options] <domain>
| Argument | Meaning |
|---|
domain | Domain to renew |
| Option | Meaning |
|---|
--www | Also renew the www subdomain (separately — its own certificate) |
Check SSL certificate status for a domain
openship deployment ssl status [options] <domain>
| Argument | Meaning |
|---|
domain | Domain to probe |
Read the complete persisted deployment state and outstanding prompts
openship deployment status [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Show container resource usage for a deployment
openship deployment usage [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
Wait for the persisted deployment outcome or a decision that needs your response
openship deployment wait [options] <id>
| Argument | Meaning |
|---|
id | Deployment ID |
| Option | Meaning |
|---|
--timeout <ms> | Maximum wait duration; leaves the deployment running on timeout (default: 600000) |
--interval <ms> | Status polling interval (minimum 10 ms) (default: 1000) |