installRequirements command

Summary:

Overview of the installRequirements command for installing required libraries and tools for the Bash Tools Framework

Tags:

Commands
Build

Created on: March 1, 2026

Last updated: March 2, 2026

1. Help

Command: bin/installRequirements --help

2. Usage

bin/installRequirements script will install the following libraries inside vendor folder:

bats-core/bats-core
bats-core/bats-support
bats-core/bats-assert
Flamefire/bats-mock
hadolint
shellcheck
shdoc

bin/doc script will install:

reconquest/shdoc
hadolint
shellcheck

Dependencies are automatically installed when first used. To avoid checking for libraries update and have an impact on performance, a file is created in vendor dir.

vendor/.shdocInstalled
vendor/.batsInstalled

You can remove these files to force the update of the libraries, or just wait 24 hours for the timeout to expire 😉

Or, if you want, you can alternatively use the GitHub discussion Q&A for feedback and questions.