Skip to main content

bash operation

Installs bash to be used by the current repository.

note

Omni uses mise in the background to manage that tool. The mise installation of omni is in its own directory, and won't conflict with any installation of mise you might have on your system.

caution

Bash is installed using a custom asdf plugin. There is no guarantee all versions of bash will be able to build on all systems, especially older ones. We recommend using the latest version of bash if your intent is to ensure that users of your repository can use certain bash features.

Parameters

The following parameters can be used:

ParameterTypeDescription
dirpathRelative path (or list of relative paths) to the directory in the project for which to use the node version
urlstringThe URL to download the tool from, in case the tool is not registered in the mise registry or if you want to use a custom version.
versionstringThe version of the tool to install; see version handling below for more details.
upgradebooleanwhether or not to always upgrade to the most up to date matching version, even if an already-installed version matches the requirements (default: false)

Version handling

The following strings can be used to specify the version:

VersionMeaning
1.2Accepts 1.2 and any version prefixed by 1.2.*
1.2.3Accepts 1.2.3 and any version prefixed by 1.2.3.*
~1.2.3Accepts 1.2.3 and higher patch versions (1.2.4, 1.2.5, etc. but not 1.3.0)
^1.2.3Accepts 1.2.3 and higher minor and patch versions (1.2.4, 1.3.1, 1.4.7, etc. but not 2.0.0)
>1.2.3Must be greater than 1.2.3
>=1.2.3Must be greater or equal to 1.2.3
<1.2.3Must be lower than 1.2.3
<=1.2.3Must be lower or equal to 1.2.3
1.2.xAccepts 1.2.0, 1.2.1, etc. but will not accept 1.3.0
*Matches any version (same as latest, except that when upgrade is false, will match any installed version)
latestLatest release (when upgrade is set to false, will only match with installed versions of the latest major)
autoLookup for any version files in the project directory (.tool-versions or .bash-version) and apply version parsing

The version also supports the || operator to specify ranges. This operator is not compatible with the latest and auto keywords. For instance, 1.2.x || >1.3.5 <=1.4.0 will match any version between 1.2.0 included and 1.3.0 excluded, or between 1.3.5 excluded and 1.4.0 included.

The latest version satisfying the requirements will be installed.

Examples

up:
# Will install the latest version of bash
- bash

# And also
- bash: latest

# Let omni lookup for version files in the project
- bash: auto

# Will install any version starting with 5.2, and containing
# only dots and numbers after
- bash: 5.2

# Will install any version starting with 5, and containing only
# dots and numbers after
- bash: 5

# Full specification of the parameter to identify the version;
# this will install any version starting with 5.2.15, and
# containing only dots and numbers after
- bash:
version: 5.2.15

# Use that version but only in the some/sub/dir directory
- bash:
version: 5.2.15
dir: some/sub/dir

Dynamic environment

The following variables will be set as part of the dynamic environment.

Environment variableOperationDescription
PATHprependThe bin directory for the loaded version of bash