Skip to main content

Environment Variable

Specify the same environment variables cross shell.

Syntaxโ€‹

env:
- name: ALIAE_CONFIG
value: /Users/Jan/configs/aliae.yaml

Variableโ€‹

NameTypeDescription
namestringthe variable name
valueanythe variable value, supports templating
delimiterstringif you want to join an array of string values (separated by newlines), supports templating
ifstringgolang template conditional statement, see if
persistbooleanif you want to persist the environment variable into the registry for the current user (Windows only)
typestringtype to export to, possible values are string (default) and array

Shell specific configurationโ€‹

caution

description, force, option, and scope only exist on PowerShell's Variable provider, not its Environment provider. Setting any one of them switches that entry from a real environment variable ($env:NAME, visible to child processes) to a PowerShell-only variable ($NAME, set via Set-Variable, not visible to child processes). Leave them unset if the variable needs to be seen by anything other than the PowerShell session itself.

NameTypeDescription
descriptionstringspecifies a description of the variable
forcebooleanuse the force parameter to change or delete a variable that has the option parameter set to ReadOnly. The force parameter cannot change or delete a variable with the option parameter set to Constant
optionstringsee the PowerShell documentation
scopestringsee the PowerShell documentation