Skip to main content

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.

VariableUsed forBeaten by
PERPETUAL_PROFILEThe profile a command signs in with.--profile
PERPETUAL_TOKENA 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>_EMAILThe email for password sign-in with that profile.--email
PERPETUAL_EMAILThe email for password sign-in when no profile-specific variable is set.--email, PERPETUAL_<PROFILE>_EMAIL
PERPETUAL_<PROFILE>_PASSWORDThe password for password sign-in with that profile. The CLI prints a warning when it uses it.--password, --password-file
PERPETUAL_PASSWORDThe 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_AUTHThe sign-in method perpetual login uses: interactive, password, or client-credentials.--auth
PERPETUAL_CLIENT_IDThe OAuth client ID for client-credentials sign-in.--client-id
PERPETUAL_CLIENT_SECRETThe OAuth client secret for client-credentials sign-in.--client-secret
PERPETUAL_REDIRECT_URIThe redirect URI for interactive sign-in.--redirect-uri

Organization and space​

VariableUsed forBeaten by
PERPETUAL_ORG_IDThe organization a command runs in. It beats org_id in .perpetual.toml and the profile's stored organization.--org-id
PERPETUAL_SPACE_IDThe 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​

VariableUsed for
XDG_CONFIG_HOMEThe CLI keeps its configuration in perpetual/ under this directory. Without it, the CLI uses ~/.config/perpetual.
XDG_STATE_HOMEThe 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.

VariableUse instead
PERPETUAL_ENDPOINT, PERPETUAL_<PROFILE>_ENDPOINTA profile for each endpoint, or endpoint in .perpetual.toml.
PERPETUAL_<PROFILE>_ORG_IDperpetual org use, PERPETUAL_ORG_ID, or org_id in .perpetual.toml.

Perpetual CLI 0.5.0