Environment variables
Environment variables the perpetual CLI reads. A flag always beats the
variable that stands in for it.
Sign-in
<PROFILE> is a profile name in upper case, with hyphens changed to
underscores. The profile my-staging reads PERPETUAL_MY_STAGING_EMAIL.
| Variable | Used for | Beaten by |
|---|---|---|
PERPETUAL_PROFILE | The profile a command signs in with. | --profile |
PERPETUAL_TOKEN | A bearer token, used instead of the profile's stored login. The endpoint still comes from the profile or from .perpetual.toml. perpetual login ignores it, as does any command that needs the stored login, and each prints a warning. | Nothing |
PERPETUAL_<PROFILE>_EMAIL | The email for password sign-in with that profile. | --email |
PERPETUAL_EMAIL | The email for password sign-in when no profile-specific variable is set. | --email, PERPETUAL_<PROFILE>_EMAIL |
PERPETUAL_<PROFILE>_PASSWORD | The password for password sign-in with that profile. The CLI prints a warning when it uses it. | --password, --password-file |
PERPETUAL_PASSWORD | The password for password sign-in when no profile-specific variable is set. The CLI prints a warning when it uses it. | --password, --password-file, PERPETUAL_<PROFILE>_PASSWORD |
PERPETUAL_AUTH | The sign-in method perpetual login uses: interactive, password, or client-credentials. | --auth |
PERPETUAL_CLIENT_ID | The OAuth client ID for client-credentials sign-in. | --client-id |
PERPETUAL_CLIENT_SECRET | The OAuth client secret for client-credentials sign-in. | --client-secret |
PERPETUAL_REDIRECT_URI | The redirect URI for interactive sign-in. | --redirect-uri |
Organization and space
| Variable | Used for | Beaten by |
|---|---|---|
PERPETUAL_ORG_ID | The organization a command runs in. It beats org_id in .perpetual.toml and the profile's stored organization. | --org-id |
PERPETUAL_SPACE_ID | The space a command acts on, as a space ID such as SPC_ABC. It beats space_id in .perpetual.toml. | --space |
Where the CLI keeps its files
| Variable | Used for |
|---|---|
XDG_CONFIG_HOME | The CLI keeps its configuration in perpetual/ under this directory. Without it, the CLI uses ~/.config/perpetual. |
XDG_STATE_HOME | The CLI keeps its state, including stored logins, in perpetual/ under this directory. Without it, the CLI uses ~/.local/state/perpetual. |
The CLI uses either variable only when it holds an absolute path.
Variables the CLI ignores
Earlier releases read these. The CLI now prints a warning when one is set.
| Variable | Use instead |
|---|---|
PERPETUAL_ENDPOINT, PERPETUAL_<PROFILE>_ENDPOINT | A profile for each endpoint, or endpoint in .perpetual.toml. |
PERPETUAL_<PROFILE>_ORG_ID | perpetual org use, PERPETUAL_ORG_ID, or org_id in .perpetual.toml. |
Related
Perpetual CLI 0.5.0