Documentation
📦 Use core libraries
📂 system

📂 system

system::addToPath

Add the given path to the PATH environment variable for various shells, by adding the appropriate export command to the appropriate file.

Will also export the PATH variable in the current bash.

  • $1: path as string: the path to add to the PATH environment variable.
system::addToPath "/path/to/bin"

system::commandExists

Check if the given command exists.

  • $1: command name as string: the command name to check.

Returns:

  • $?
    • 0 if the command exists
    • 1 otherwise.
if system::commandExists "command1"; then
  printf 'The command exists.'
fi

system::date

Get the current date in the given format.

  • $1: format as string: (optional) the format of the date to return (defaults to %(%F_%Hh%Mm%Ss)T).

Returns:

  • RETURNED_VALUE: the current date in the given format.
system::date
local date="${RETURNED_VALUE}"

This function avoid to call $(date) in a subshell (date is a an external executable).

system::env

Get the list of all the environment variables. In pure bash, no need for env or printenv.

Returns:

  • RETURNED_ARRAY: An array with the list of all the environment variables.
system::env
for var in "${RETURNED_ARRAY[@]}"; do
  printf '%s=%s\n' "${var}" "${!var}"
done

This is faster than using mapfile on <(compgen -v).

system::exportTerminalSize

This function exports the terminal size.

Returns:

  • GLOBAL_COLUMNS: The number of columns in the terminal.
  • GLOBAL_LINES: The number of lines in the terminal.
system::exportTerminalSize
printf '%s\n' "The terminal has ⌜${GLOBAL_COLUMNS}⌝ columns and ⌜${GLOBAL_LINES}⌝ lines."

system::getNotExistingCommands

This function returns the list of not existing commands for the given names.

  • $@: command names as string: the list of command names to check.

Returns:

  • $?
    • 0 if there are not existing commands
    • 1 otherwise.
  • RETURNED_ARRAY: the list of not existing commands.
if system::getNotExistingCommands "command1" "command2"; then
  printf 'The following commands do not exist: %s' "${RETURNED_ARRAY[*]}"
fi

system::getUndeclaredVariables

This function returns the list of undeclared variables for the given names.

  • $@: variable names as string: the list of variable names to check.

Returns:

  • $?
    • 0 if there are variable undeclared
    • 1 otherwise.
  • RETURNED_ARRAY: the list of undeclared variables.
if system::getUndeclaredVariables "var1" "var2"; then
  printf 'The following variables are not declared: %s' "${RETURNED_ARRAY[*]}"
fi

system::isRoot

Check if the script is running as root.

Returns:

  • $?
    • 0 if the script is running as root
    • 1 otherwise.
if system::isRoot; then
  printf 'The script is running as root.'
fi

system::os

Returns the name of the current OS.

Returns:

  • RETURNED_VALUE: the name of the current OS: “darwin”, “linux” or “windows”.
system::os
local osName="${RETURNED_VALUE}"

system::windowsAddToPath

Add the given path to the PATH environment variable on Windows (current user only).

Will also export the PATH variable in the current bash.

  • $1: path as string: the path to add to the PATH environment variable. The path can be in unix format, it will be converted to windows format.
system::windowsAddToPath "/path/to/bin"

This function is only available on Windows, it uses powershell to directly modify the registry.

system::windowsGetEnvVar

Get the value of an environment variable for the current user on Windows.

  • $1: variable name as string: the name of the environment variable to get.

Returns:

  • RETURNED_VALUE: the value of the environment variable.
system::windowsGetEnvVar "MY_VAR"
echo "${RETURNED_VALUE}"

system::windowsSetEnvVar

Set an environment variable for the current user on Windows.

  • $1: variable name as string: the name of the environment variable to set.
  • $2: variable value as string: the value of the environment variable to set.
system::windowsSetEnvVar "MY_VAR" "my_value"

This function is only available on Windows, it uses powershell to directly modify the registry.

Documentation generated for the version 0.27.285 (2024-12-05).

📂 string📂 test