system

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

openship system

Instance settings, onboarding, migration, and data transfer

openship system [options] [command]

Subcommand	Purpose
`settings`	Read or update instance settings
`onboarding`	First-run instance setup
`upgrade-to-auth [options]`	Promote a zero-auth instance to email/password login
`browse [path]`	List directories on the instance host (defaults to home)
`migration`	Team-mode migration lifecycle
`data-transfer`	Whole-instance export / import (owner-only)

List directories on the instance host (defaults to home)

openship system browse [options] [path]

Argument	Meaning
`path`	Directory to list

Whole-instance export / import (owner-only)

openship system data-transfer [options] [command]

Subcommand	Purpose
`export [options]`	Export the entire instance to a JSON file
`import [options]`	Import an instance export file

Export the entire instance to a JSON file

openship system data-transfer export [options]

Option	Meaning
`--passphrase <passphrase>`	Seal secrets under this passphrase
`--out <file>`	Write the export to this file instead of stdout

Import an instance export file

openship system data-transfer import [options]

Option	Meaning
`--file <path>`	Path to an export file
`--passphrase <passphrase>`	Passphrase used at export time
`--mode <mode>`	wipe (replace) \| merge (default: "wipe")
`-y, --yes`	Skip the confirmation prompt

First-run instance setup

openship system onboarding [options] [command]

Subcommand	Purpose
`apply [options]`	Configure a fresh instance (fails once already configured)

Configure a fresh instance (fails once already configured)

openship system onboarding apply [options]

Option	Meaning
`--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-args <args>`	Extra SSH args
`--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

Read or update instance settings

openship system settings [options] [command]

Subcommand	Purpose
`get`	Show current instance settings
`set [options]`	Update instance-level settings

Show current instance settings

openship system settings get [options]

Update instance-level settings

openship system settings set [options]

Option	Meaning
`--auth-mode <mode>`	Auth mode: none \| local \| cloud
`--confirm <phrase>`	Required for auth-mode none: "I-understand-no-auth"
`--tunnel-provider <provider>`	Tunnel provider (empty string clears)
`--tunnel-token <token>`	Tunnel token
`--default-build-mode <mode>`	Default build mode
`--default-rollback-window <n>`	Default rollback window
`--invitation-mail-source <src>`	Invitation mail source: platform \| cloud

Promote a zero-auth instance to email/password login

openship system upgrade-to-auth [options]

Option	Meaning
`--name <name>`	Account display name
`--email <email>`	Account email
`--password <password>`	Account password (prompted if omitted)
`--use-own-mail-server`	Warm the self-hosted mail server for auth emails