env
env list
List an application's environment variables.
read onlyrepeatable
Every variable set on the application, with the values hidden unless you ask for them.
What the application receives through a shared group is not included here. That is
env group get.
--hangar <name> lists a Hangar's variables instead of an application's.
Usage
outplane env list [flags]Flags
| Flag | Type | Description |
|---|---|---|
--app | string | Application name or id. Defaults to the linked app. A flag rather than an argument, so that variable names cannot be mistaken for it. |
--hangar | string | A Hangar's name or id, instead of an application. Not with --app. |
--reveal | bool | Print the values instead of hiding them. |
The global flags apply as well.
Output
| Field | Type | Description |
|---|---|---|
key | string | |
value | string | The value, or a mask when --reveal was not given. Read revealed to know which one you have. |
revealed | bool | Whether value is the real value. |
length | int | The value's length, which is reported even when it is hidden. |
Examples
Which variables are set on the linked app
outplane env listThe same for a named app, with values
outplane env list --app checkout --revealJust the names
outplane env list --json --fields key{
"items": [
{
"key": "DATABASE_URL"
},
{
"key": "PORT"
}
],
"total": 2,
"truncated": false
}Which variables a Hangar starts with
outplane env list --hangar myhangarWhat to Know
- value is masked unless --reveal is given, in every format including --json. Check revealed before treating it as a credential; length is accurate either way.
- Variables an application receives from a shared group are not listed. This reports what is set on the application itself.
- Keys are compared case-insensitively by the platform, so PATH and path are the same variable.
- --hangar names a Hangar instead of an application, and is refused together with --app. A Hangar is an application record with the same id, so the requests are the same, and a result's app field holds the Hangar's name.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
3 | auth | Not authenticated, token revoked or expired, or forbidden for this team. |
5 | not_found | The named resource does not exist, or is not visible to this credential. |
8 | upstream | The Out Plane API returned a server error. |
The code on the error object is one of context.no_app, app.not_found, hangar.not_found, hangar.ambiguous, usage.conflicting_flags, usage.empty_argument. Branch on that, or on the exit status. The message is prose and changes.