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.
Inspect, edit, and apply a service's environment variables
openship service env [options] [command]
Apply the saved environment to the active container through the engine's replacement and rollback workflow
openship service env apply [options] <service>
| Argument | Meaning |
|---|
service | Service name or id |
| Option | Meaning |
|---|
-p, --project <id|slug|name> | Stack (project) id, slug, or name |
Remove selected service overrides; inherited values become effective again
openship service env delete|unset [options] <service> <keys...>
| Argument | Meaning |
|---|
service | Service name or id |
keys | Override keys to remove |
| Option | Meaning |
|---|
-p, --project <id|slug|name> | Stack (project) id, slug, or name |
-e, --env <environment> | Environment: production | preview | development (default: "production") |
List a service's environment variables (secrets masked)
openship service env get [options] <service>
| Argument | Meaning |
|---|
service | Service name or id |
| Option | Meaning |
|---|
-p, --project <id|slug|name> | Stack (project) id, slug, or name |
-e, --env <environment> | Environment: production | preview | development |
Show effective variables, their sources, and pending runtime changes (secrets masked)
openship service env inspect [options] <service>
| Argument | Meaning |
|---|
service | Service name or id |
| Option | Meaning |
|---|
-p, --project <id|slug|name> | Stack (project) id, slug, or name |
-e, --env <environment> | Environment: production | preview | development |
--runtime | Inspect the running container to check whether saved values are applied |
Print explicitly selected secret values; requires service write access
openship service env reveal [options] <service> <keys...>
| Argument | Meaning |
|---|
service | Service name or id |
keys | Variable keys to reveal |
| Option | Meaning |
|---|
-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 |
Set a service's environment variables for one environment
openship service env set [options] <service> <pairs...>
| Argument | Meaning |
|---|
service | Service name or id |
pairs | KEY=VALUE pairs |
| Option | Meaning |
|---|
-p, --project <id|slug|name> | Stack (project) id, slug, or name |
-e, --env <environment> | Environment: production | preview | development (default: "production") |
--secret | Mark the provided variables as secret |
--replace | Replace ALL variables for this environment with only the given pairs |