CLICommand referencesystemsettings
system settings
Commands, arguments, and options for openship system settings.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
openship system settings
Read or update instance settings
openship system settings [options] [command]| Subcommand | Purpose |
|---|---|
patch [options] [file] | Update any supported instance setting using its shared JSON contract |
reset [options] | Reset instance settings and return to setup |
get | Show current instance settings |
set [options] | Update instance-level settings |
openship system settings get
Show current instance settings
openship system settings get [options]openship system settings patch
Update any supported instance setting using its shared JSON contract
openship system settings patch [options] [file]| Argument | Meaning |
|---|---|
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|---|
--schema | Print the accepted JSON schema without making a request |
openship system settings reset
Reset instance settings and return to setup
openship system settings reset [options]| Option | Meaning |
|---|---|
-y, --yes | Confirm the instance reset |
openship system settings set
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 |