app

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

openship app

Browse, install, and configure catalog apps

openship app [options] [command]

Subcommand	Purpose
`list\|ls`	List available catalog apps
`get <id>`	Show an app template and an accessible installation draft
`host-fit [options] <id>`	Check an app's requirements against a deployment destination
`install [options] <id>`	Create or update an app installation draft; deploy its returned project ID with openship deploy
`custom`	Manage this organization's custom app definitions
`settings`	Read and update an installed app's curated settings
`connection <project>`	Show resolved app connection details, including credentials; requires project write access

Show resolved app connection details, including credentials; requires project write access

openship app connection [options] <project>

Argument	Meaning
`project`	Installed app project ID

Manage this organization's custom app definitions

openship app custom [options] [command]

Subcommand	Purpose
`list\|ls`
`add <file>`	Validate and save a custom app definition
`remove\|rm <id>`	Remove a custom catalog definition

Validate and save a custom app definition

openship app custom add [options] <file>

Argument	Meaning
`file`	AppTemplate JSON file

Use this command with the arguments below.

openship app custom list|ls [options]

Remove a custom catalog definition

openship app custom remove|rm [options] <id>

Argument	Meaning
`id`	Custom app ID

Show an app template and an accessible installation draft

openship app get [options] <id>

Argument	Meaning
`id`	Catalog app ID

Check an app's requirements against a deployment destination

openship app host-fit [options] <id>

Argument	Meaning
`id`	Catalog app ID

Option	Meaning
`--server <id>`	Registered server ID
`--target <target>`	Deployment target, such as cloud

Create or update an app installation draft; deploy its returned project ID with openship deploy

openship app install [options] <id>

Argument	Meaning
`id`	Catalog app ID

Option	Meaning
`--name <name>`	Project name
`--config <file>`	JSON object of app configuration values
`--routes <file>`	JSON array of endpoint routing choices

List available catalog apps

openship app list|ls [options]

Read and update an installed app's curated settings

openship app settings [options] [command]

Subcommand	Purpose
`get <project>`
`update <project> <file>`

Use this command with the arguments below.

openship app settings get [options] <project>

Argument	Meaning
`project`	Installed app project ID

Use this command with the arguments below.

openship app settings update [options] <project> <file>

Argument	Meaning
`project`	Installed app project ID
`file`	JSON object containing a changes array of {service, key, value}