Namespace on Bash Tools Framework Documentation

Namespace src/Args

Sun, 01 Mar 2026 00:00:00 +0000

src/Args

Overview

Directory src/Args

file source src/Args/defaultHelp.sh

Args::defaultHelp

display help and exits if one of args is -h|–help

Options

-h

short help option
–help

long help option

Arguments

$1 (helpArg:String|Function): the help string to display or the function to call to display the help
… (args:String[]): list of options

Exit codes

0: displays help and exit with code 0 if -h or –help option is in the args list

Output on stdout

displays help if -h or –help option is in the args list

src/Args/defaultHelpNoExit.sh

file source src/Args/defaultHelpNoExit.sh

Namespace src/Array

Sun, 01 Mar 2026 00:00:00 +0000

src/Array

Overview

Directory src/Array

file source src/Array/clone.sh

Array::clone

clone the array passed as parameter

Arguments

$1 (arrayToClone:String): name of the array to clone
$2 (clonedArray:String): name of the cloned array

Variables set

clonedArray (containing): the values of arrayToClone

src/Array/contains.sh

file source src/Array/contains.sh

Array::contains

check if an element is contained in an array

Example

Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}"

Arguments

$1 needle:String
$@ array:String[]

Exit codes

0: if found
1: otherwise

src/Array/join.sh

file source src/Array/join.sh

Namespace src/Assert

Sun, 01 Mar 2026 00:00:00 +0000

src/Assert

Overview

Directory src/Assert

file source src/Assert/bashFile.sh

Assert::bashFile

ensure that file begin with a bash shebang

Arguments

$1 file:String

Exit codes

1: if file doesn’t have a bash shebang
2: if file doesn’t exist

src/Assert/bashFrameworkFunction.sh

file source src/Assert/bashFrameworkFunction.sh

Assert::bashFrameworkFunction

assert that first arg respects this bash framework naming convention

Arguments

$1 (bashFrameworkFunction:String): the function’s name to assert

Exit codes

1: if bashFrameworkFunction arg doesn’t respect this bash framework naming convention

src/Assert/commandExists.sh

file source src/Assert/commandExists.sh

Namespace src/Aws

Sun, 01 Mar 2026 00:00:00 +0000

src/Aws

Overview

Directory src/Aws

file source src/Aws/imageExists.sh

Aws::imageExists

Checks if image exists with tags provided on AWS ecr best practice: provide tags ’tagPrefix_shortSha’ ’tagPrefix_branchName' so image will be tagged with

tagPrefix_shortSha
tagPrefix_branchName

Arguments

$1 (repositoryName:String): eg:889859566884.dkr.ecr.eu-west-1.amazonaws.com/bast-tools-dev-env
… (tags:String[]): list of tags used to check if image exists on AWS ECR

Exit codes

1: if no tag provided
2: if at least one tag does not exist

Output on stderr

diagnostics information is displayed

Requires

Aws::requireAwsCommand

src/Aws/requireAwsCommand.sh

file source src/Aws/requireAwsCommand.sh

Namespace src/Backup

Sun, 01 Mar 2026 00:00:00 +0000

src/Backup

Overview

Directory src/Backup

file source src/Backup/dir.sh

Backup::dir

Backup given directory in the base directory or in BACKUP_DIR directory backup directory name is composed by following fields separated by _:

if BACKUP_DIR is not empty then escaped full dir name separated by @
date with format %Y%m%d_%H:%M:%S (Eg: 20240326_14:45:08)
.tgz extension

Arguments

$1 (string): the base directory
$2 (string): the directory to backup from base directory

Environment variables

BACKUP_DIR (String): variable referencing backup directory
FRAMEWORK_ROOT_DIR (String): used to remove this project directory from displayed backup path
SUDO (String): allows to use custom sudo prefix command

Exit codes

1: if directory to backup does not exist, 0 if everything is OK
2: on backup failure

Output on stderr

message about where the directory is backed up

Requires

Linux::requireTarCommand

src/Backup/file.sh

file source src/Backup/file.sh

Namespace src/Bash

Sun, 01 Mar 2026 00:00:00 +0000

src/Bash

Overview

Directory src/Bash

file source src/Bash/handlePipelineFailure.sh

Bash::handlePipelineFailure

ignore exit code 141 from simple command pipes

Example

 local resultingStatus=0
 local -a originalPipeStatus=()
 cmd1 | cmd2 || Bash::handlePipelineFailure resultingStatus originalPipeStatus || true
 [[ "${resultingStatus}" = "0" ]]
@arg $1 resultingStatusCode:&int (passed by reference) (optional) resulting status code
@arg $2 originalStatus:int[] (passed by reference) (optional) copy of original PIPESTATUS array
@env PIPESTATUS assuming that this function is called like in the example provided
@see https://unix.stackexchange.com/a/709880/582856
@see https://gitlab.alpinelinux.org/alpine/aports/-/issues/11152
@warning alpine does not support PIPESTATUS very well as execution order of piped process is
not guaranteed

Namespace src/Bats

Sun, 01 Mar 2026 00:00:00 +0000

src/Bats

Overview

Directory src/Bats

file source src/Bats/installRequirementsIfNeeded.sh

Bats::installRequirementsIfNeeded

install requirements to execute bats

Environment variables

BASH_FRAMEWORK_BATS_DEPENDENCIES_CHECK_TIMEOUT (int): default value 86400 (86400 seconds = 1 day)

Variables set

BASH_FRAMEWORK_BATS_DEPENDENCIES_INSTALLED (String): the file created when all git shallow clones have succeeded

Output on stderr

diagnostics information is displayed

Features

Git::shallowClone

Warnings

the following repositories are shallow cloned
cloning is skipped if vendor/.batsInstalled file exists
a new check is done everyday
repository is not updated if a change is detected

Namespace src/Cache

Sun, 01 Mar 2026 00:00:00 +0000

src/Cache

Overview

Directory src/Cache

file source src/Cache/getFileContentIfNotExpired.sh

Cache::getFileContentIfNotExpired

get file content if file not expired

Arguments

$1 (file:String): the file to get content from
$2 (maxDuration:int): number of seconds after which the file is considered expired

Exit codes

1: if file does not exists
2: if file expired

Output on stdout

{String} the file content if not expired

src/Cache/getPropertyValue.sh

file source src/Cache/getPropertyValue.sh

Cache::getPropertyValue

get property value from file if not present compute it using propertyNotFoundCallback (if provided) and store it in property file

Namespace src/Command

Sun, 01 Mar 2026 00:00:00 +0000

src/Command

Overview

Directory src/Command

file source src/Command/captureOutputAndExitCode.sh

Command::captureOutputAndExitCode

ability to call a command capturing output and exit code but displaying it also to error output to follow command’s progress command output is sent to COMMAND_OUTPUT and stderr as well in realtime using tee

Arguments

… (command:String[]): the command to execute

Variables set

COMMAND_OUTPUT (String): stdout of the command is returned in global variable COMMAND_OUTPUT

Exit codes

- exit code of the command

Output on stderr

command output

Namespace src/Conf

Sun, 01 Mar 2026 00:00:00 +0000

src/Conf

Overview

Directory src/Conf

file source src/Conf/getAbsoluteFile.sh

Conf::getAbsoluteFile

get absolute conf file from specified conf folder deduced using these rules

from absolute file (ignores and )
relative to where script is executed (ignores and )
from home/.bash-tools/
from framework conf/

Arguments

$1 (confFolder:String): the directory name (not the path) to list
$2 (conf:String): file to use without extension
$3 (extension:String): the extension (.sh by default)

Exit codes

1: if file is not found in any location

Output on stdout

absolute conf filename

src/Conf/getMergedList.sh

file source src/Conf/getMergedList.sh

Namespace src/Crypto

Sun, 01 Mar 2026 00:00:00 +0000

src/Crypto

Overview

Directory src/Crypto

file source src/Crypto/uuidV4.sh

Crypto::uuidV4

generate a UUID in version 4 format

Exit codes

1: if neither /proc/sys/kernel/random/uuid nor uuidgen are available

Output on stderr

diagnostics information is displayed

Namespace src/Database

Sun, 01 Mar 2026 00:00:00 +0000

src/Database

Overview

Directory src/Database

file source src/Database/checkDsnFile.sh

Database::checkDsnFile

check if dsn file has all the mandatory variables set Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT

Arguments

$1 (dsnFileName:String): dsn absolute filename

Variables set

HOSTNAME (loaded): from dsn file
PORT (loaded): from dsn file
USER (loaded): from dsn file
PASSWORD (loaded): from dsn file

Exit codes

0: on valid file
1: if one of the properties of the conf file is invalid or if file not found

Output on stderr

log output if error found in conf file

src/Database/createDb.sh

file source src/Database/createDb.sh

Namespace src/Dns

Sun, 01 Mar 2026 00:00:00 +0000

src/Dns

Overview

Directory src/Dns

file source src/Dns/addHost.sh

Dns::addHost

add the line ip hostname at the end of /etc/hosts only if hostname does not exists yet in this file if wsl do the same in ${BASE_MNT_C}/Windows/System32/drivers/etc/hosts

Arguments

$1 hostName:String
$2 (ip:String): optional, default value: 127.0.0.1

Environment variables

BASE_MNT_C (String):
SUDO (String): allows to use custom sudo prefix command

Output on stderr

diagnostics information is displayed

Requires

Git::requireGitCommand
Linux::requireSudoCommand

Features

Retry::default

Warnings

files are backup before being updated

src/Dns/checkHostname.sh

file source src/Dns/checkHostname.sh

Namespace src/Docker

Sun, 01 Mar 2026 00:00:00 +0000

src/Docker

Overview

checkout usage doc below

DockerNamespace usage

file source src/Docker/_.sh

Docker::buildImage

try to docker build image from eventual tagged image cache

Using DOCKER_BUILDKIT=1
Using BUILDKIT_INLINE_CACHE in order to use the resulting image as a cache source

You can specify cacheFrom options using the method Docker::getBuildCacheFromArg

Example

## notice that there is no double quotes around $(Docker::getBuildCacheFromArg bash-tools:tag1 bash-tools:tag2)
Docker::buildImage "." "Dockerfile" "bash-tools" $(Docker::getBuildCacheFromArg bash-tools:tag1 bash-tools:tag2)

Arguments

$1 (buildDirectory:String): base directory from where Dockerfile will take hits resources
$2 (dockerFilePath:String): docker file path
$3 (localImageName:String): the local image name of the resulting image (eg: in ubuntu:latest, ubuntu is the image name
… (dockerBuildParams:String[]): rest of the parameters to pass to docker build method

Exit codes

1: if buildDirectory does not exists
2: if dockerFilePath does not exists
3: if empty or invalid localImageName

Output on stdout

{String} the tag that has been successfully pulled, return 1 if no

Output on stderr

diagnostics information is displayed

Requires

Docker::requireDockerCommand

src/Docker/buildPushDockerImage.sh

file source src/Docker/buildPushDockerImage.sh

Namespace src/Env

Sun, 01 Mar 2026 00:00:00 +0000

src/Env

Overview

Directory src/Env

file source src/Env/createDefaultEnvFile.sh

Env::createDefaultEnvFile

default env file with all default values

Output on stdout

the default env filepath

src/Env/pathAppend.sh

file source src/Env/pathAppend.sh

Env::pathAppend

append directories to the PATH environment variable

Arguments

… (args:String[]): list of directories to append

Variables set

PATH (String): update PATH with the directories appended

src/Env/pathPrepend.sh

file source src/Env/pathPrepend.sh

Env::pathPrepend

prepend directories to the PATH environment variable

Arguments

… (args:String[]): list of directories to prepend

Variables set

PATH (update): PATH with the directories prepended

src/Env/requireLoad.sh

file source src/Env/requireLoad.sh

Namespace src/File

Sun, 01 Mar 2026 00:00:00 +0000

src/File

Overview

Directory src/File

file source src/File/concatenatePath.sh

File::concatenatePath

concatenate 2 paths and ensure the path is correct using realpath -m

Arguments

$1 basePath:String
$2 subPath:String

Requires

Linux::requireRealpathCommand

src/File/createOutputDir.sh

file source src/File/createOutputDir.sh

File::createOutputDir

Create an output directory, using a default if the provided path is empty

Example

File::createOutputDir "${optionOutputDir}" "${optionDefaultOutputDir}" || return 1

Arguments

$1 (outputDir:String): the output directory path (can be empty)
$2 (defaultOutputDir:String): the default directory to use if outputDir is empty

Variables set

outputDir (the): resolved output directory path

Exit codes

0: success - directory created or already exists
1: failure - failed to create directory

Output on stdout

none

src/File/detectBashFile.sh

file source src/File/detectBashFile.sh

Namespace src/Filters

Sun, 01 Mar 2026 00:00:00 +0000

src/Filters

Overview

Directory src/Filters

file source src/Filters/bashFrameworkFunctions.sh

Filters::bashFrameworkFunctions

allows to match a bash framework function based on the naming convention

Arguments

… (files:String[]): the files in which bash framework functions will be extracted

Environment variables

PREFIX (String): an eventual prefix you would like to match
FRAMEWORK_FUNCTIONS_IGNORE_REGEXP (String): this filter does not use this variable

Exit codes

0: if match or no match
2: if grep fails for other reasons

Input on stdin

you can alternatively provide content to filter via stdin

Output on stdout

the list of bash framework function detected

Warnings

this filter could extract bash framework functions that are actually commented in the source file
use FRAMEWORK_FUNCTIONS_IGNORE_REGEXP from .framework-config to filter unwanted functions

src/Filters/camel2snakeCase.sh

file source src/Filters/camel2snakeCase.sh

Namespace src/Format

Sun, 01 Mar 2026 00:00:00 +0000

src/Format

Overview

Directory src/Format

file source src/Format/duration.sh

Format::duration

format a duration in seconds to a human readable format

Arguments

$1 (duration:int): in seconds

Output on stdout

formatted duration

Namespace src/Framework

Sun, 01 Mar 2026 00:00:00 +0000

src/Framework

Overview

Directory src/Framework

file source src/Framework/createTempFile.sh

Framework::createTempFile

create a temp file using default TMPDIR variable

Arguments

$1 (templateName:String): template name to use(optional)

Environment variables

TMPDIR (String): (default value /tmp)

src/Framework/run.sh

file source src/Framework/run.sh

Framework::run

run command and store data in global variables

bash_framework_status
bash_framework_duration
bash_framework_output redirecting error output to stdout is not supported, you can instead redirect stderr to a file if needed

Arguments

… (command:String[]): command with arguments to execute

Variables set

bash_framework_status (the): exit status of the command
bash_framework_duration (the): duration of the command
bash_framework_output (the): output of the command

src/Framework/trapAdd.sh

file source src/Framework/trapAdd.sh

Namespace src/Git

Sun, 01 Mar 2026 00:00:00 +0000

src/Git

Overview

Directory src/Git

file source src/Git/cloneOrPullIfNoChanges.sh

Git::cloneOrPullIfNoChanges

clone the repository if not done yet, else pull it if no change in it

Arguments

$1 (dir:String): directory in which repository is installed or will be cloned
$2 (repo:String): repository url
$3 (cloneCallback:Function): callback on successful clone
$4 (pullCallback:Function): callback on successful pull

Environment variables

GIT_CLONE_OPTIONS:String (additional): options to pass to git clone command
SUDO (String): allows to use custom sudo prefix command

Exit codes

0: on successful pulling/cloning, 1 on failure

src/Git/pullIfNoChanges.sh

file source src/Git/pullIfNoChanges.sh

Namespace src/Github

Sun, 01 Mar 2026 00:00:00 +0000

src/Github

Overview

Directory src/Github

file source src/Github/defaultInstall.sh

Github::downloadReleaseVersion

download specified release software version from github

Arguments

$1 (releaseUrl:String): eg: https://github.com/kubernetes-sigs/kind/releases/download/v1.0.0/kind-linux-amd64

Environment variables

CURL_CONNECT_TIMEOUT (number): of seconds before giving up host connection

Exit codes

1: on failure

Output on stdout

the path to the downloaded release

src/Github/extractRepoFromGithubUrl.sh

file source src/Github/extractRepoFromGithubUrl.sh

Github::extractRepoFromGithubUrl

github repository eg: kubernetes-sigs/kind

Arguments

$1 (githubUrl:String): eg: https://github.com/kubernetes-sigs/kind/releases/download/@latestVersion@/kind-linux-amd64

Exit codes

1: if no matching repo found in provided url, 0 otherwise

Output on stdout

the repo in the form owner/repo

src/Github/getLatestRelease.sh

file source src/Github/getLatestRelease.sh

Namespace src/Install

Sun, 01 Mar 2026 00:00:00 +0000

src/Install

Overview

Directory src/Install

file source src/Install/dir.sh

Install::dir

install dir to given directory but backup it before

Arguments

$1 (fromDir:String): the source base directory
$2 (toDir:String): the target base directory
$3 (dirName:String): the directory relative to fromDir arg that will be copied
$4 (userName:String): (optional) (default: ${USERNAME}) the user name that will be used to set target files ownership
$5 (userGroup:String): (optional) (default: ${USERNAME}) the group name that will be used to set target files ownership

Environment variables

OVERWRITE_CONFIG_FILES (Boolean): (default:0) if 1 will overwrite existing directory
CHANGE_WINDOWS_FILES (Boolean): (default:0) if 1 and target directory is in windows file system, overwrite it
USERNAME ((default:): root) the user name that will be used to set target files ownership
USERGROUP ((default:): root) the group name that will be used to set target files ownership
BASE_MNT_C (String): windows C drive base PATH
FRAMEWORK_ROOT_DIR (used): to make paths relative to this directory to reduce length of messages
SUDO (String): allows to use custom sudo prefix command
BACKUP_BEFORE_INSTALL (Boolean): (default:1) backup directory before installing the dir

Exit codes

1: if source directory is not readable
2: if source directory backup failed
0: if copy successful or OVERWRITE_CONFIG_FILES=0 or
0: with warning message if OVERWRITE_CONFIG_FILES=0 and target directory exists
0: with warning message if CHANGE_WINDOWS_FILES=0 and target directory in C drive

Output on stderr

diagnostics information is displayed, skipped information if OVERWRITE_CONFIG_FILES or CHANGE_WINDOWS_FILES are set to 1

src/Install/file.sh

file source src/Install/file.sh

Namespace src/Log

Sun, 01 Mar 2026 00:00:00 +0000

src/Log

Overview

Log namespace provides 2 kind of functions

Log::display* allows to display given message with given display level
Log::log* allows to log given message with given log level Log::display* functions automatically log the message too

file source src/Log/_.sh

Log::computeDuration

compute duration since last call to this function the result is set in following env variables. in ss.sss (seconds followed by milliseconds precision 3 decimals)

Function has no arguments.

Environment variables

DISPLAY_DURATION (int): (default 0) if 1 display elapsed time information between 2 info logs

Variables set

LOG_LAST_LOG_DATE_INIT (int): (default 1) set to 0 at first call, allows to detect reference log
LOG_LAST_DURATION_STR (String): the last duration displayed
LOG_LAST_LOG_DATE (String): the last log date that will be used to compute next diff

src/Log/displayDebug.sh

file source src/Log/displayDebug.sh

Namespace src/Profiles

Sun, 01 Mar 2026 00:00:00 +0000

src/Profiles

Overview

Directory src/Profiles

file source src/Profiles/allDepsRecursive.sh

Profiles::allDepsRecursive

get recursively all the dependencies of each config from configs arg

The parent argument must be set to “your software selection” when you call it, then the value will change when this function will be called recursively with the parent dependency

Algorithm For each config in configs - load config definition - mark this config as seen to avoid to recompute it later, in the case where another definition depends on it - call installScripts_${config}_dependencies function if exists (skipped if not) - add these new dependencies if any to current dependencies list - call recursively Profiles::allDepsRecursive with these dependencies - add in allDepsResult the current config if it was not seen yet This has constructed a tree with the most deep dependency present in the first items

Namespace src/Retry

Sun, 01 Mar 2026 00:00:00 +0000

src/Retry

Overview

Directory src/Retry

file source src/Retry/default.sh

Retry::default

Retry a command 5 times with a delay of 15 seconds between each attempt

Arguments

… (command:String[]): the command to run

Environment variables

RETRY_MAX_RETRY (int): max retries
RETRY_DELAY_BETWEEN_RETRIES (int): delay between attempts

Exit codes

0: on success
1: if max retries count reached

src/Retry/parameterized.sh

file source src/Retry/parameterized.sh

Retry::parameterized

Retry a command several times depending on parameters

Arguments

$1 (maxRetries:int): $1 max retries
$2 (delay:int): between attempt
$3 (message:String): to display to describe the attempt
… (rest): of parameters, the command to run

Exit codes

0: on success
1: if max retries count reached
2: if maxRetries invalid value

Namespace src/ShellDoc

Sun, 01 Mar 2026 00:00:00 +0000

src/ShellDoc

Overview

Directory src/ShellDoc

file source src/ShellDoc/fixMarkdownToc.sh

ShellDoc::fixMarkdownToc

fix markdown TOC generated by Markdown all in one vscode extension to make TOC compatible with docsify

Arguments

$1 (file:String): file to fix

Exit codes

1: if awk fails

src/ShellDoc/generateMdFileFromTemplate.sh

file source src/ShellDoc/generateMdFileFromTemplate.sh

ShellDoc::generateMdFileFromTemplate

generates markdown file from template by replacing @@@command_help@@@ by the help of the command eg: @@@test_help@@@ will be replaced by the output of the command test --help in the directory provided

Namespace src/Softwares

Sun, 01 Mar 2026 00:00:00 +0000

src/Softwares

Overview

Directory src/Softwares

file source src/Softwares/installHadolint.sh

Softwares::installHadolint

install hadolint if necessary

Arguments

$1 targetFile:String

Features

Github::upgradeRelease

src/Softwares/installShellcheck.sh

file source src/Softwares/installShellcheck.sh

Softwares::installShellcheck

install hadolint if necessary

Arguments

$1 targetFile:String
$2 (maxAge:int): in seconds, default to 1 month

Features

Github::upgradeRelease

Namespace src/Ssh

Sun, 01 Mar 2026 00:00:00 +0000

src/Ssh

Overview

Directory src/Ssh

file source src/Ssh/checkAccess.sh

Ssh::checkAccess

check if host can accessed using ssh private key without requiring interactivity

Arguments

$1 (host:String): the host to join
… (args:String[]): other parameters to pass to the ssh command

Exit codes

1: if ssh fails
2: if missing host argument

Requires

Ssh::requireSshCommand

src/Ssh/fixAuthenticityOfHostCantBeEstablished.sh

file source src/Ssh/fixAuthenticityOfHostCantBeEstablished.sh

Ssh::fixAuthenticityOfHostCantBeEstablished

Fix ssh issues

The authenticity of host ‘www.host.net (140.82.121.4)’ can’t be established
And Offending key for IP

Arguments

$1 (host:String): the host to fix

Environment variables

HOME (String):

Exit codes

1: is ssh-keygen fails

Requires

Ssh::requireSshKeygenCommand
Ssh::requireSshKeyscanCommand

src/Ssh/requireSshCommand.sh

file source src/Ssh/requireSshCommand.sh

Namespace src/UI

Sun, 01 Mar 2026 00:00:00 +0000

src/UI

Overview

Directory src/UI

file source src/UI/askToContinue.sh

UI::askToContinue

ask the user if he wishes to continue a process

Input: user input y or Y characters Output: displays message

Are you sure, you want to continue (y or n)?

Exit: with error code 1 if y or Y, other keys do nothing

src/UI/askToIgnoreOverwriteAbort.sh

file source src/UI/askToIgnoreOverwriteAbort.sh

UI::askToIgnoreOverwriteAbort

ask the user to ignore(i), overwrite(o) or abort(a)

Input: user input any characters

Output:

Namespace src/Version

Sun, 01 Mar 2026 00:00:00 +0000

src/Version

Overview

Directory src/Version

file source src/Version/checkMinimal.sh

Version::checkMinimal

Check that command version is greater than expected minimal version display warning if command version greater than expected minimal version display error if command version less than expected minimal version and exit 1

Arguments

$1 (commandName:String): command path
$2 (argVersion:String): command line parameters to launch to get command version
$3 (minimalVersion:String): expected minimal command version
$4 parseVersionCallback:Function
$5 (help:String): optional help message to display if command does not exist

Exit codes

0: if command version greater or equal to expected minimal version
1: if command version less than expected minimal version
2: if command does not exist

src/Version/compare.sh

file source src/Version/compare.sh

Namespace src/Web

Sun, 01 Mar 2026 00:00:00 +0000

src/Web

Overview

Directory src/Web

file source src/Web/getReleases.sh

Web::getReleases

Retrieve the latest version number of a web release

Arguments

$1 (releaseListUrl:String): the url from which version list can be retrieved

Environment variables

CURL_CONNECT_TIMEOUT (number): of seconds before giving up host connection

Output on stdout

log messages about retry

src/Web/upgradeRelease.sh

file source src/Web/upgradeRelease.sh

Web::upgradeRelease

upgrade given binary to latest release using retry

releasesUrl argument : the placeholder @latestVersion@ will be replaced by the latest release version

Namespace on Bash Tools Framework Documentation

Namespace src/Args

src/Args

Overview

Args::defaultHelp

Options

Arguments

Exit codes

Output on stdout

src/Args/defaultHelpNoExit.sh

Namespace src/Array

src/Array

Overview

Array::clone

Arguments

Variables set

src/Array/contains.sh

Array::contains

Example

Arguments

Exit codes

src/Array/join.sh

Namespace src/Assert

src/Assert

Overview

Assert::bashFile

Arguments

Exit codes

src/Assert/bashFrameworkFunction.sh

Assert::bashFrameworkFunction

Arguments

Exit codes

src/Assert/commandExists.sh

Namespace src/Aws

src/Aws

Overview

Aws::imageExists

Arguments

Exit codes

Output on stderr

Requires

src/Aws/requireAwsCommand.sh

Namespace src/Backup

src/Backup

Overview

Backup::dir

Arguments

Environment variables

Exit codes

Output on stderr

Requires

src/Backup/file.sh

Namespace src/Bash

src/Bash

Overview

Bash::handlePipelineFailure

Example

Namespace src/Bats

src/Bats

Overview

Bats::installRequirementsIfNeeded

Environment variables

Variables set

Output on stderr

Features

Warnings

See also

Namespace src/Cache

src/Cache

Overview

Cache::getFileContentIfNotExpired

Arguments

Exit codes

Output on stdout

src/Cache/getPropertyValue.sh

Cache::getPropertyValue

Namespace src/Command

src/Command

Overview

Command::captureOutputAndExitCode