checkExec

Check the existence and, optionally, the version of available executables or commands.

Parameters

checkExec: str

Executable to check. Additionally, an optional version check can be added with a test operator.

aliases: checkExec, CheckExec

desc: str (Optional)

The description for the check

substitute: bool (Optional)

Whether to substitute environment variables in check values

default: True

aliases: substitute, env_substitute

Example 1 (yaml)

The checkExec check in YAML format.

checks:
  Ls:
    desc: List files
    checkExec: "ls"

Example 2 (yaml)

The checkExec check with version checking in YAML format.

checks:
  Python:
    desc: Python interpreter (version 3.11 or higher)
    checkExec: "python3>=3.11"

Example 3 (toml)

The checkExec check with version checking in TOML format.

[checks.Executables.Python]
desc = "Python interpreter (version 3.11 or higher)"
checkExec = "python3>=3.11"

Example 4 (toml)

The checkExec check with version checking in abbreviated TOML format.

[checks.Executables]
Python = { checkExec = "python3>=3.11" }