Skip to main content

Path

Specify the same PATH entries cross shell.

Syntaxโ€‹

path:
- value: |
{{ .Home }}/homebrew/bin
/usr/local/bin/
/opt/local/bin/
if: eq .OS "darwin"
- value: |
{{ .Home }}/go/bin/
{{ env "VOLTA_HOME" }}/bin
ifExists: true
force: true

Pathโ€‹

NameTypeDescription
valuestringthe path entires you want to add, separated by a newline. Supports templating
ifstringgolang template conditional statement, see if
persistbooleanif you want to persist the path entry into the registry for the current user (Windows only)
forcebooleanif you want to always export the path even if it already exists in your current shell
ifExistsbooleanif you want to add only entries that exist on disk (default: false)

Windows and MSYS pathsโ€‹

Set path.value entries using your OS-native path format.

On Windows, use Windows-style paths such as P:\tools\bin. When aliae renders output for MSYS shells at runtime (for example Git Bash), it converts those entries to MSYS style automatically.

Example:

path:
- value: |
P:\tools\bin
P:\scripts

Runtime output in Git Bash:

export PATH="/p/tools/bin:$PATH"
export PATH="/p/scripts:$PATH"

Expected output by shellโ€‹

The examples below use:

path:
- value: /usr/local/bin
export PATH="/usr/local/bin:$PATH"