CLICommand referencesystemonboarding

system onboarding

Commands, arguments, and options for openship system onboarding.

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

openship system onboarding

First-run instance setup

openship system onboarding [options] [command]
SubcommandPurpose
statusCheck whether the controller has completed first-run setup
apply [options]Configure a fresh instance (fails once already configured)

openship system onboarding apply

Configure a fresh instance (fails once already configured)

openship system onboarding apply [options]
OptionMeaning
--ssh-host <host>SSH host of the target server
--ssh-port <n>SSH port (default 22)
--ssh-user <user>SSH user (default root)
--ssh-auth-method <method>SSH auth method
--ssh-password <password>SSH password
--ssh-key-path <path>SSH private key path
--ssh-key-passphrase <pass>SSH key passphrase
--ssh-jump-host <host>SSH jump host
--ssh-transport <transport>SSH transport (direct|cloudflare)
--ssh-args <args>SSH connection tuning arguments
--server-name <name>Display name for the server
--auth-mode <mode>Initial auth mode: none | local | cloud
--tunnel-provider <provider>Tunnel provider
--tunnel-token <token>Tunnel token
--default-build-mode <mode>Default build mode
--default-rollback-window <n>Default rollback window

openship system onboarding status

Check whether the controller has completed first-run setup

openship system onboarding status [options]

On this page