Skip to content

Installation Functions

Install software as root or superuser.

🛠️ Tools · ⬅ Home

awsInstall

aws Command-Line install

Usage

awsInstall

aws Command-Line install Installs x86 or aarch64 binary based on HOSTTYPE.

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Requires

packageInstall urlFetch

Usage

dockerComposeInstall [ package ]

Install docker-compose If this fails it will output the installation log. When this tool succeeds the docker-compose binary is available in the local operating system.

Arguments

  • package - Additional packages to install (using pipInstall)

Return codes

  • 1 - If installation fails
  • 0 - If installation succeeds

Usage

dockerComposeUninstall

Uninstalls docker-compose

Writes to standard error

Upon failure error log is output

Arguments

  • none

Return codes

  • 1 - If installation fails
  • 0 - If installation succeeds

Usage

gitInstall [ package ]

Installs the git binary

Arguments

  • package - Additional packages to install

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

mariadbInstall

Install mariadb When this tool succeeds the mariadb binary is available in the local operating system.

Arguments

  • none

Return codes

  • 1 - If installation fails
  • 0 - If installation succeeds

Usage

npmInstall [ --version versionCode ]

Install NPM in the build environment If this fails it will output the installation log. When this tool succeeds the npm binary is available in the local operating system.

Arguments

  • --version versionCode - String. Optional. Install this version of python.

Return codes

  • 1 - If installation of npm fails
  • 0 - If npm is already installed or installed without error

Environment

  • BUILD_NPM_VERSION - String. Version of npm to install using native npm binary.
  • Read-only. Default version. If not specified, uses latest.
    • BUILD_NPM_VERSION - String. Default to latest. Used to install npm -i npm@$BUILD_NPM_VERSION on install.

Usage

phpInstall [ package ]

Install php If this fails it will output the installation log. When this tool succeeds the php binary is available in the local operating system.

Arguments

  • package - Additional packages to install

Return codes

  • 1 - If installation fails
  • 0 - If installation succeeds

Usage

pythonInstall [ --help ]

Install python When this tool succeeds the python binary is available in the local operating system.

Arguments

  • --help - Flag. Optional. Display this help.

Return codes

  • 1 - If installation fails
  • 0 - If installation succeeds

Usage

terraformInstall [ package ... ]

Install terraform binary

Arguments

  • package ... - String. Optional. Additional packages to install using packageInstall

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

gitUninstall [ package ]

Uninstalls the git binary

Arguments

  • package - Additional packages to uninstall

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

mariadbUninstall

Uninstall mariadb When this tool succeeds the mariadb binary will no longer be available in the local operating system.

Arguments

  • none

Return codes

  • 1 - If uninstallation fails
  • 0 - If uninstallation succeeds

Usage

npmUninstall

Core as part of some systems - so this succeeds and it still exists

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

phpUninstall [ package ]

Uninstall php If this fails it will output the installation log. When this tool succeeds the php binary is no longer available in the local operating system.

Arguments

  • package - Additional packages to install

Return codes

  • 1 - If uninstallation fails
  • 0 - If uninstallation succeeds

Usage

pythonUninstall

Uninstall python

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

Usage

terraformUninstall [ package ... ]

Remove terraform binary

Arguments

  • package ... - String. Optional. Additional packages to uninstall using packageUninstall

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error