Namespace Linux on Bash Tools Framework Documentation

Namespace src/Linux/Apt

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

src/Linux/Apt

Overview

Directory src/Linux/Apt

file source src/Linux/Apt/addRepository.sh

Linux::Apt::addRepository

add apt repository followed by an apt-get update

Environment variables

SKIP_APT_GET_UPDATE

Output on stdout

diagnostics logs

Requires

Linux::requireUbuntu

Features

Retry::default

src/Linux/Apt/install.sh

file source src/Linux/Apt/install.sh

Linux::Apt::install

apt-get install

Arguments

… (softwares:String[]): list of softwares to install

Output on stdout

diagnostics logs

Requires

Linux::requireUbuntu

Features

Retry::default

src/Linux/Apt/installIfNecessary.sh

file source src/Linux/Apt/installIfNecessary.sh

Linux::Apt::installIfNecessary

apt-get install if package is not installed yet

Namespace src/Linux/Sudo

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

src/Linux/Sudo

Overview

Directory src/Linux/Sudo

file source src/Linux/Sudo/asUser.sh

Linux::Sudo::asUser

execute command passed as arguments using sudo if current user is not already the targeted user

Arguments

… (args:String[]): the command to execute as sudo

Environment variables

USERNAME (String): sudo as this user (root by default)

Exit codes

1: exit code of command

Requires

Linux::requireSudoCommand

src/Linux/Sudo/asUserInheritEnv.sh

file source src/Linux/Sudo/asUserInheritEnv.sh

Linux::Sudo::asUserInheritEnv

execute command passed as arguments using sudo with environment inherited if current user is not already the targeted user

Namespace src/Linux/Wsl

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

src/Linux/Wsl

Overview

Directory src/Linux/Wsl

file source src/Linux/Wsl/assertWindowsEtcHost.sh

Linux::Wsl::assertWindowsEtcHost

Check if Host is defined in etc/hosts of windows

Arguments

$1 host:String

Exit codes

1: if hostname not found

src/Linux/Wsl/cachedWslpath.sh

file source src/Linux/Wsl/cachedWslpath.sh

Linux::Wsl::cachedWslpath

retrieve wslpath using cache (cache is refreshed every day)

Arguments

… (args:String[]): arguments to pass to wslpath

Environment variables

WSL_TMPDIR (String): temp directory to store the wslpath cache (default value: TMPDIR), you can use PERSISTENT_TMPDIR instead

Exit codes

- if Linux::Wsl::originalWslpath cannot find the path

Output on stderr

diagnostics information is displayed

Requires

Linux::Wsl::requireWsl

Features

cache

src/Linux/Wsl/cachedWslpath2.sh

file source src/Linux/Wsl/cachedWslpath2.sh