CLICommand referencesettings
settings
Commands, arguments, and options for openship settings.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
openship settings
Manage user preferences on the selected Openship instance
openship settings [options] [command]| Subcommand | Purpose |
|---|---|
get | Read deployment, cloning and transfer preferences |
update <file> | Update supported user preferences |
build-mode <value> | Set the default build-mode |
route-strategy <value> | Set the default route-strategy |
clone-strategy <value> | Set the default clone-strategy |
deploy-defaults <file> | Set deployment destination defaults |
clone-token [options] <file> | Save a cloning credential; responses do not disclose the token |
clear-clone-token | Remove the saved cloning credential |
transfer [options] | Set volume transfer preferences |
git-forwarding <state> | Control forwarding of git identity to build servers |
openship settings build-mode
Set the default build-mode
openship settings build-mode [options] <value>| Argument | Meaning |
|---|---|
value | auto | server | local |
openship settings clear-clone-token
Remove the saved cloning credential
openship settings clear-clone-token [options]openship settings clone-strategy
Set the default clone-strategy
openship settings clone-strategy [options] <value>| Argument | Meaning |
|---|---|
value | prompt | local | remote-with-token |
openship settings clone-token
Save a cloning credential; responses do not disclose the token
openship settings clone-token [options] <file>| Argument | Meaning |
|---|---|
file | Token file, or - for stdin |
| Option | Meaning |
|---|---|
--default | Use this token by default for cloning |
openship settings deploy-defaults
Set deployment destination defaults
openship settings deploy-defaults [options] <file>| Argument | Meaning |
|---|---|
file | JSON defaultDeployTarget and defaultServerId; null clears, - reads stdin |
openship settings get
Read deployment, cloning and transfer preferences
openship settings get [options]openship settings git-forwarding
Control forwarding of git identity to build servers
openship settings git-forwarding [options] <state>| Argument | Meaning |
|---|---|
state | on | off |
openship settings route-strategy
Set the default route-strategy
openship settings route-strategy [options] <value>| Argument | Meaning |
|---|---|
value | auto | loopback-port | container-ip |
openship settings transfer
Set volume transfer preferences
openship settings transfer [options]| Option | Meaning |
|---|---|
--mode <mode> | Transfer method (choices: "auto", "stream", "direct", "rsync") |
--compression <format> | Compression (choices: "auto", "zstd", "gzip", "none") |
openship settings update
Update supported user preferences
openship settings update [options] <file>| Argument | Meaning |
|---|---|
file | JSON settings patch, or - for stdin |