CLICommand referenceserviceenv

service env

Commands, arguments, and options for openship service env.

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

openship service env

Inspect, edit, and apply a service's environment variables

openship service env [options] [command]
SubcommandPurpose
get [options] <service>List a service's environment variables (secrets masked)
set [options] <service> <pairs...>Set a service's environment variables for one environment
inspect [options] <service>Show effective variables, their sources, and pending runtime changes (secrets masked)
reveal [options] <service> <keys...>Print explicitly selected secret values; requires service write access
delete|unset [options] <service> <keys...>Remove selected service overrides; inherited values become effective again
apply [options] <service>Apply the saved environment to the active container through the engine's replacement and rollback workflow

openship service env apply

Apply the saved environment to the active container through the engine's replacement and rollback workflow

openship service env apply [options] <service>
ArgumentMeaning
serviceService name or id
OptionMeaning
-p, --project <id|slug|name>Stack (project) id, slug, or name

openship service env delete

Remove selected service overrides; inherited values become effective again

openship service env delete|unset [options] <service> <keys...>
ArgumentMeaning
serviceService name or id
keysOverride keys to remove
OptionMeaning
-p, --project <id|slug|name>Stack (project) id, slug, or name
-e, --env <environment>Environment: production | preview | development (default: "production")

openship service env get

List a service's environment variables (secrets masked)

openship service env get [options] <service>
ArgumentMeaning
serviceService name or id
OptionMeaning
-p, --project <id|slug|name>Stack (project) id, slug, or name
-e, --env <environment>Environment: production | preview | development

openship service env inspect

Show effective variables, their sources, and pending runtime changes (secrets masked)

openship service env inspect [options] <service>
ArgumentMeaning
serviceService name or id
OptionMeaning
-p, --project <id|slug|name>Stack (project) id, slug, or name
-e, --env <environment>Environment: production | preview | development
--runtimeInspect the running container to check whether saved values are applied

openship service env reveal

Print explicitly selected secret values; requires service write access

openship service env reveal [options] <service> <keys...>
ArgumentMeaning
serviceService name or id
keysVariable keys to reveal
OptionMeaning
-p, --project <id|slug|name>Stack (project) id, slug, or name
-e, --env <environment>Environment: production | preview | development
--source <source>Read saved effective values or the live container (choices: "effective", "runtime", default: "effective")
--container <id>Expected container ID when reading runtime values

openship service env set

Set a service's environment variables for one environment

openship service env set [options] <service> <pairs...>
ArgumentMeaning
serviceService name or id
pairsKEY=VALUE pairs
OptionMeaning
-p, --project <id|slug|name>Stack (project) id, slug, or name
-e, --env <environment>Environment: production | preview | development (default: "production")
--secretMark the provided variables as secret
--replaceReplace ALL variables for this environment with only the given pairs

On this page