Skip to content

Installation Functions

Install software as root or superuser.

awsInstall

aws Command-Line install

Usage

awsInstall

aws Command-Line install

Installs x86 or aarch64 binary based on HOSTTYPE.

Location: bin/build/tools/aws.sh

Arguments

  • none

Return codes

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

Requires

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.

Location: bin/build/tools/docker-compose.sh

Arguments

  • package - Additional packages to install (using pipInstall)

Return codes

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

See Also

dockerComposeUninstall

Uninstall docker-compose

Usage

dockerComposeUninstall

Uninstalls docker-compose

Location: bin/build/tools/docker-compose.sh

Arguments

  • none

Writes to standard error

Upon failure error log is output

Return codes

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

gitInstall

Install git if needed

Usage

gitInstall [ package ]

Installs the git binary

Location: bin/build/tools/git.sh

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.

Location: bin/build/tools/mariadb.sh

Arguments

  • none

Return codes

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

npmInstall

Install NPM in the build environment

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.

Location: bin/build/tools/npm.sh

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 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.

Location: bin/build/tools/php.sh

Arguments

  • package - Additional packages to install

Return codes

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

pythonInstall

Install python

Usage

pythonInstall [ --help ]

Install python

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

Location: bin/build/tools/python.sh

Arguments

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

Return codes

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

terraformInstall

Install terraform binary

Usage

terraformInstall [ package ... ]

Install terraform binary

Location: bin/build/tools/terraform.sh

Arguments

  • package ... - String. Optional. 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

Location: bin/build/tools/git.sh

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.

Location: bin/build/tools/mariadb.sh

Arguments

  • none

Return codes

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

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

Location: bin/build/tools/npm.sh

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.

Location: bin/build/tools/php.sh

Arguments

  • package - Additional packages to install

Return codes

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

pythonUninstall

Uninstall python

Usage

pythonUninstall

Uninstall python

Location: bin/build/tools/python.sh

Arguments

  • none

Return codes

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

terraformUninstall

Remove terraform binary

Usage

terraformUninstall [ package ... ]

Remove terraform binary

Location: bin/build/tools/terraform.sh

Arguments

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

Return codes

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

🛠️ Tools · ⬅ Top