CLICommand referenceprojectconnections

project connections

Commands, arguments, and options for openship project connections.

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

openship project connections

Wire app outputs into a project's environment through the engine

openship project connections [options] [command]
SubcommandPurpose
list <id>List this project's incoming app connections
candidates <id>List apps that can supply connection outputs
consumers <id>List projects consuming this project's outputs
create <id> <file>Connect one app output; redeploy to apply it
bundle <id> <file>Connect several app outputs atomically; redeploy to apply them
remove|rm [options] <id> <connection>Remove an app connection

openship project connections bundle

Connect several app outputs atomically; redeploy to apply them

openship project connections bundle [options] <id> <file>
ArgumentMeaning
idTarget project ID
fileJSON connection bundle with sourceProjectId and items

openship project connections candidates

List apps that can supply connection outputs

openship project connections candidates [options] <id>
ArgumentMeaning
idProject ID

openship project connections consumers

List projects consuming this project's outputs

openship project connections consumers [options] <id>
ArgumentMeaning
idProject ID

openship project connections create

Connect one app output; redeploy to apply it

openship project connections create [options] <id> <file>
ArgumentMeaning
idTarget project ID
fileJSON connection with sourceProjectId, outputId, envKey and optional mode

openship project connections list

List this project's incoming app connections

openship project connections list [options] <id>
ArgumentMeaning
idProject ID

openship project connections remove

Remove an app connection

openship project connections remove|rm [options] <id> <connection>
ArgumentMeaning
idTarget project ID
connectionConnection ID
OptionMeaning
-y, --yesSkip confirmation

On this page