Skip to content

Installation Functions

Install software as root or superuser.

🛠️ Tools · ⬅ Top

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

dockerComposeInstall

Install docker-compose

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. Return Code: 1 - If installation fails Return Code: 0 - If installation succeeds

Arguments

  • package - Additional packages to install (using pipInstall)

Return codes

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

dockerComposeUninstall

Install docker-compose

Usage

dockerComposeUninstall [ 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. Return Code: 1 - If installation fails Return Code: 0 - If installation succeeds

Arguments

  • package - Additional packages to install (using apt)

Return codes

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

gitInstall

Install git if needed

Usage

gitInstall [ package ... ]

Installs the git binary

Arguments

  • package - Additional packages to install

Return codes

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

mariadbInstall

Install mariadb

Usage

mariadbInstall

Install mariadb

When this tool succeeds the mariadb binary is available in the local operating system. Return Code: 1 - If installation fails Return Code: 0 - If installation succeeds

Arguments

  • none

Return codes

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

npmInstall

Install NPM in the build environment

Usage

npmInstall version

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. Return Code: 1 - If installation of npm fails Return Code: 0 - If npm is already installed or installed without error

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument 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.

phpInstall

Install php

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. Return Code: 1 - If installation fails Return Code: 0 - If installation succeeds

Arguments

  • package - Additional packages to install

Return codes

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

pythonInstall

Install python

Usage

pythonInstall

Install python

When this tool succeeds the python binary is available in the local operating system. Return Code: 1 - If installation fails Return Code: 0 - If installation succeeds

Arguments

  • none

Return codes

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

terraformInstall

Install terraform binary

Usage

terraformInstall [ package ]

Install terraform binary

Arguments

  • package - Additional packages to install using packageInstall

Return codes

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

gitUninstall

Uninstall git

Usage

gitUninstall [ package ... ]

Uninstalls the git binary

Arguments

  • package - Additional packages to uninstall

Return codes

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

mariadbUninstall

Uninstall mariadb

Usage

mariadbUninstall

Uninstall mariadb

When this tool succeeds the mariadb binary will no longer be available in the local operating system. Return Code: 1 - If uninstallation fails Return Code: 0 - If uninstallation succeeds

Arguments

  • none

Return codes

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

npmUninstall

Core as part of some systems - so this 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

phpUninstall

Uninstall php

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. Return Code: 1 - If uninstallation fails Return Code: 0 - If uninstallation succeeds

Arguments

  • package - Additional packages to install

Return codes

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

pythonUninstall

Uninstall python

Usage

pythonUninstall

Uninstall python

Arguments

  • none

Return codes

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

terraformUninstall

Remove terraform binary

Usage

terraformUninstall [ package ]

Remove terraform binary

Arguments

  • package - Additional packages to uninstall using packageUninstall

Return codes

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