server

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

openship server

Manage Cloud and self-hosted deployment servers

openship server [options] [command]

Subcommand	Purpose
`managed`	Manage subscription-owned Cloud servers and connected Cloud destinations
`network`	Manage private networks and reviewed network operations
`cluster`	Manage compute clusters, scaling runtimes and replicated storage
`github`	Manage GitHub credentials on a deployment server
`tunnel`	Manage tunnels opened on the selected Openship instance (not this CLI machine)
`containers`	Inspect and update infrastructure containers through the engine
`security`	Inspect server advisories and review host maintenance runs
`swarm [options] <id>`	Inspect an existing Docker Swarm without changing its services
`connect-swarm [options] <id>`	Use an existing Swarm manager for project deployments; preserves existing stacks
`destinations`	List deployment destinations and their supported capabilities
`get <id>`	Read server details, its managed plan and lifecycle progress
`reachability <id>`	Probe the controller's current connection to this server
`usage <id>`	Read current resource use and project allocations
`infrastructure <id>`	Read network, compute-cluster and shared-storage membership
`deletion-preview <id>`	Inspect workloads and retained data before removing a server
`scan-ports <id>`	Inspect listening ports on this server
`configure <id> <file>`	Change a server's name or connection settings; omitted fields are preserved
`exec [options] <id> <command>`	Execute a bounded command through the server's authorized connection
`network-settings`	Inspect or change this server's Internet-access policy
`list\|ls`	List servers in the active organization
`add [options]`	Add a new server
`rm\|remove <id>`	Delete a server
`test-connection\|test [options]`	Test an SSH connection without saving it
`check [options] <serverId>`	Run component health checks against a saved server
`update [options] <serverId>`	Check for and apply native-module migrations (OpenResty, …)
`install [options] <serverId>`	Install components on a server
`install-session [options] [sessionId]`	Inspect a server installation session
`install-events [options] [sessionId]`	Reattach to installation logs and prompts without starting another install
`uninstall [options] <serverId> <component>`	Remove a component through the server's shared installer
`install-respond [options] <sessionId>`	Respond to an installation prompt
`rate-limit [options] <serverId>`	Read or update per-server OpenResty rate limiting
`monitor <serverId>`	Stream live system stats (SSE)
`ssh\|terminal [options] <serverId>`	Open a Cloud or self-hosted server terminal through the selected controller

openship server add

Add a new server

openship server add [options]

Option	Meaning
`--host <host>`	SSH host / IP
`--name <name>`	Display name
`--port <port>`	SSH port (default: "22")
`--user <user>`	SSH user (default: "root")
`--auth-method <method>`	Auth method (password\|key\|agent)
`--password <password>`	SSH password (password auth)
`--password-file <file>`	SSH password file on this machine, or - for stdin
`--key-path <path>`	Private key path on the controller host
`--private-key-file <file>`	Read an SSH key from this machine, or - for stdin
`--key-passphrase <passphrase>`	Private key passphrase
`--jump-host <host>`	SSH jump / bastion host
`--ssh-transport <transport>`	SSH transport (direct\|cloudflare)
`--ssh-args <args>`	SSH connection tuning arguments

openship server check

Run component health checks against a saved server

openship server check [options] <serverId>

Option	Meaning
`-c, --component <name...>`	Limit to specific components

openship server configure

Change a server's name or connection settings; omitted fields are preserved

openship server configure [options] <id> <file>

Argument	Meaning
`id`	Server ID
`file`	JSON patch with the fields to change

openship server connect-swarm

Use an existing Swarm manager for project deployments; preserves existing stacks

openship server connect-swarm [options] <id>

Argument	Meaning
`id`	Connected Swarm manager server ID

Option	Meaning
`--name <name>`	Cluster display name
`--request-id <uuid>`	Reuse after a lost response for an idempotent retry

openship server deletion-preview

Inspect workloads and retained data before removing a server

openship server deletion-preview [options] <id>

Argument	Meaning
`id`	Server ID

openship server destinations

List deployment destinations and their supported capabilities

openship server destinations [options]

openship server exec

Execute a bounded command through the server's authorized connection

openship server exec [options] <id> <command>

Argument	Meaning
`id`	Server ID
`command`	Shell command to run on this server

Option	Meaning
`--cwd <path>`	Remote working directory
`--timeout <ms>`	Command deadline in milliseconds
`--max-output <bytes>`	Maximum captured output

openship server get

Read server details, its managed plan and lifecycle progress

openship server get [options] <id>

Argument	Meaning
`id`	Server ID

openship server infrastructure

Read network, compute-cluster and shared-storage membership

openship server infrastructure [options] <id>

Argument	Meaning
`id`	Server ID

openship server install

Install components on a server

openship server install [options] <serverId>

Option	Meaning
`-c, --component <name...>`	Component names from server check (for example docker, git, edge, rsync)
`--config <file>`	Installer configuration as JSON, or - for stdin
`-y, --yes`	Confirm a reinstall or explicit edge takeover
`--follow`	Stream install logs live (SSE)

openship server install-events

Reattach to installation logs and prompts without starting another install

openship server install-events [options] [sessionId]

Option	Meaning
`--server <serverId>`	Select the server's current installation

openship server install-respond

Respond to an installation prompt

openship server install-respond [options] <sessionId>

Option	Meaning
`--action <action>`	Action id offered by the prompt

openship server install-session

Inspect a server installation session

openship server install-session [options] [sessionId]

Option	Meaning
`--server <serverId>`	Select the server's current installation

openship server list

List servers in the active organization

openship server list|ls [options]

openship server monitor

Stream live system stats (SSE)

openship server monitor [options] <serverId>

openship server network-settings

Inspect or change this server's Internet-access policy

openship server network-settings [options] [command]

Subcommand	Purpose
`get <id>`	Read Internet access and ingress ports
`set [options] <id> <file>`	Apply a reviewed network policy, rejecting changes to stale state

openship server network-settings get

Read Internet access and ingress ports

openship server network-settings get [options] <id>

Argument	Meaning
`id`	Server ID

openship server network-settings set

Apply a reviewed network policy, rejecting changes to stale state

openship server network-settings set [options] <id> <file>

Argument	Meaning
`id`	Server ID
`file`	JSON internetAccess, expectedInternetAccess and confirm fields

Option	Meaning
`-y, --yes`	Confirm the policy change

openship server rate-limit

Read or update per-server OpenResty rate limiting

openship server rate-limit [options] <serverId>

Option	Meaning
`--rps <n>`	Requests per second (0 removes the limit)
`--burst <n>`	Burst allowance
`--whitelist <cidr...>`	CIDRs exempt from limiting

openship server reachability

Probe the controller's current connection to this server

openship server reachability [options] <id>

Argument	Meaning
`id`	Server ID

openship server rm

Delete a server

openship server rm|remove [options] <id>

openship server scan-ports

Inspect listening ports on this server

openship server scan-ports [options] <id>

Argument	Meaning
`id`	Server ID

openship server ssh

Open a Cloud or self-hosted server terminal through the selected controller

openship server ssh|terminal [options] <serverId>

Option	Meaning
`--origin <url>`	Trusted dashboard origin (defaults to the saved context dashboard)
`--timeout <ms>`	Maximum time to open the terminal (default: 30000)

openship server swarm

Inspect an existing Docker Swarm without changing its services

openship server swarm [options] <id>

Argument	Meaning
`id`	Connected server ID; use a Swarm manager for stack inventory

Option	Meaning
`--details`	Include stacks, services, ports, mounts and nodes

openship server test-connection

Test an SSH connection without saving it

openship server test-connection|test [options]

Option	Meaning
`--host <host>`	SSH host / IP
`--port <port>`	SSH port (default: "22")
`--user <user>`	SSH user (default: "root")
`--auth-method <method>`	Auth method (password\|key\|agent)
`--password <password>`	SSH password
`--password-file <file>`	SSH password file on this machine, or - for stdin
`--key-path <path>`	Private key path on the controller host
`--private-key-file <file>`	Read an SSH key from this machine, or - for stdin
`--key-passphrase <passphrase>`	Private key passphrase
`--jump-host <host>`	SSH jump / bastion host
`--ssh-transport <transport>`	SSH transport (direct\|cloudflare)
`--ssh-args <args>`	SSH connection tuning arguments

openship server uninstall

Remove a component through the server's shared installer

openship server uninstall [options] <serverId> <component>

Option	Meaning
`--config <file>`	Installer configuration as JSON, or - for stdin
`-y, --yes`	Confirm component removal

openship server update

Check for and apply native-module migrations (OpenResty, …)

openship server update [options] <serverId>

Option	Meaning
`-c, --component <name...>`	Limit to specific modules
`--check`	Only report drift; don't apply
`-y, --yes`	Confirm migrations that require consent

openship server usage

Read current resource use and project allocations

openship server usage [options] <id>

Argument	Meaning
`id`	Server ID

On this page