service

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship service

Manage the services in a compose stack (a multi-service project)

openship service|services [options] [command]

Subcommand	Purpose
`terminal [options] <service>`	Open a shell in a running service on Cloud or a self-hosted server
`volumes [options] <service>`	Read measured service volume sizes
`list [options]`	List the services in a stack
`get [options] <service>`	Show one service's configuration
`update [options] <service> <file>`	Patch service configuration from a JSON file using the shared service contract
`create [options] <name>`	Add a service to a stack
`delete\|rm [options] <service>`	Remove a service from a stack
`sync [options] <compose-file>`	Sync a stack's services from a docker-compose file (services not in the file are removed)
`start [options] <service>`	Start a service's container
`stop [options] <service>`	Stop a service's container
`restart [options] <service>`	Restart a service's container (use service env apply for pending environment changes)
`containers [options]`	List the stack's active-deployment containers
`drift`	Resolve compose drift on a service (upstream compose changed a value you edited)
`env`	Inspect, edit, and apply a service's environment variables
`logs [options] <service>`	Show or stream a service's runtime logs
`exec [options] <service> <command>`	Run a shell command inside a service's isolated container

openship service containers

List the stack's active-deployment containers

openship service containers [options]

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name

openship service create

Add a service to a stack

openship service create [options] <name>

Argument	Meaning
`name`	Service name (unique within the stack)

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name
`--image <image>`	Container image (e.g. postgres:16)
`--build <context>`	Build context path (relative to repo root)
`--dockerfile <path>`	Dockerfile path (relative to build context)
`--port <mapping>`	Port mapping, e.g. 8080:80 (repeatable) (default: [])
`--depends-on <service>`	Service this depends on (repeatable) (default: [])
`--env <KEY=VALUE>`	Compose environment default (repeatable) (default: [])
`--command <command>`	Override the container command
`--restart <policy>`	Restart policy: no \| always \| on-failure \| unless-stopped
`--expose`	Expose the service publicly through managed routing
`--exposed-port <port>`	Container port to expose publicly
`--domain <label>`	Free subdomain label (with --expose)

openship service delete

Remove a service from a stack

openship service delete|rm [options] <service>

Argument	Meaning
`service`	Service name or id

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name
`-y, --yes`	Skip the confirmation prompt

openship service drift

Resolve compose drift on a service (upstream compose changed a value you edited)

openship service drift [options] [command]

Subcommand	Purpose
`accept [options] <service>`	Apply the upstream compose values, discarding your edits
`keep [options] <service>`	Keep your edits and stop flagging the upstream change

openship service drift accept

Apply the upstream compose values, discarding your edits

openship service drift accept [options] <service>

Argument	Meaning
`service`	Service name or id

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name

openship service drift keep

Keep your edits and stop flagging the upstream change

openship service drift keep [options] <service>

Argument	Meaning
`service`	Service name or id

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name

openship service exec

Run a shell command inside a service's isolated container

openship service exec [options] <service> <command>

Argument	Meaning
`service`	Service name or id
`command`	Shell command (quote it as one argument)

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name
`--cwd <path>`	Working directory inside the container
`--timeout <ms>`	Command timeout in milliseconds (default: "30000")

openship service get

Show one service's configuration

openship service get [options] <service>

Argument	Meaning
`service`	Service name or id

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name

openship service list

List the services in a stack

openship service list [options]

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name

openship service logs

Show or stream a service's runtime logs

openship service logs [options] <service>

Argument	Meaning
`service`	Service name or id

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name
`-f, --follow`	Stream new log lines as they arrive (SSE)
`--tail <n>`	Number of lines to show from the end (default: "200")

openship service restart

Restart a service's container (use service env apply for pending environment changes)

openship service restart [options] <service>

Argument	Meaning
`service`	Service name or id

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name
`--force`	Bounce even with pending env changes (they will NOT be applied)

openship service start

Start a service's container

openship service start [options] <service>

Argument	Meaning
`service`	Service name or id

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name

openship service stop

Stop a service's container

openship service stop [options] <service>

Argument	Meaning
`service`	Service name or id

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name

openship service sync

Sync a stack's services from a docker-compose file (services not in the file are removed)

openship service sync [options] <compose-file>

Argument	Meaning
`compose-file`	Path to docker-compose.yml / compose.yaml

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name
`-y, --yes`	Skip the confirmation prompt

openship service terminal

Open a shell in a running service on Cloud or a self-hosted server

openship service terminal [options] <service>

Argument	Meaning
`service`	Service name or ID

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name
`--origin <url>`	Trusted dashboard origin (defaults to the saved context dashboard)

openship service update

Patch service configuration from a JSON file using the shared service contract

openship service update [options] <service> <file>

Argument	Meaning
`service`	Service name or id
`file`	JSON patch (image, command, ports, routing, build settings, enabled, etc.)

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name

openship service volumes

Read measured service volume sizes

openship service volumes [options] <service>

Argument	Meaning
`service`	Service name or ID

Option	Meaning
`-p, --project <id\|slug\|name>`	Stack (project) id, slug, or name

On this page