server

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

openship server

Manage self-hosted SSH servers

openship server [options] [command]

Subcommand	Purpose
`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 [sessionId]`	Inspect a server installation session
`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 <serverId>`	Open an interactive SSH terminal (coming soon)

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)
`--key-path <path>`	Path to private key (key auth)
`--key-passphrase <passphrase>`	Private key passphrase
`--jump-host <host>`	SSH jump / bastion host
`--ssh-args <args>`	Extra raw ssh args

Run component health checks against a saved server

openship server check [options] <serverId>

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

Install components on a server

openship server install [options] <serverId>

Option	Meaning
`-c, --component <name...>`	Components to install (docker\|git\|edge\|rsync)
`--follow`	Stream install logs live (SSE)

Respond to an installation prompt

openship server install-respond [options] <sessionId>

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

Inspect a server installation session

openship server install-session [options] [sessionId]

List servers in the active organization

openship server list|ls [options]

Stream live system stats (SSE)

openship server monitor [options] <serverId>

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

Delete a server

openship server rm|remove [options] <id>

Open an interactive SSH terminal (coming soon)

openship server ssh [options] <serverId>

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
`--key-path <path>`	Path to private key
`--key-passphrase <passphrase>`	Private key passphrase
`--jump-host <host>`	SSH jump / bastion host
`--ssh-args <args>`	Extra raw ssh args

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