Appearance

Installation ​

Requirements ​

  • Node.js >=18
  • Windows, Linux or Mac OS X
  • Docker Engine >=17

Install Node.js ​

Linux and macOS ​

Node Package Manager (npm) recommends installing Node.js with Node Version Manager (nvm) to avoid permission errors when installing globally.

  1. Use curl or wget to install nvm:
Terminal
shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.2/install.sh | bash
Terminal
shell
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.2/install.sh | bash
  1. Make sure nvm is properly installed. You may need to reload the terminal for the command to take effect.
Terminal
shell
nvm --version
  1. Use nvm to install a compatible version of Node.js. For example, to install Node.js v18, run
Terminal
shell
nvm install 18
  1. Run node --version to confirm that Node.js has been properly installed.

Windows ​

TronBox recommends using the installer from the website of Node.js.

Make sure that you agree to automatically install the necessary tools during installation so that the required Visual Studio build tools, Python, and Chocolately package manager can be installed.

Install TronBox ​

You can install TronBox by executing the following command:

sh
npm install -g tronbox
sh
pnpm add -g tronbox
sh
yarn global add tronbox
sh
bun install -g tronbox

You may receive warnings during installation. Type tronbox version on the terminal to check whether TronBox has been properly installed.

Terminal
shell
tronbox version

For Windows users ​

If you are running TronBox on Windows, you may encounter naming conflicts that may prevent TronBox from executing properly. In this case, please see Resolve naming conflicts on Windows for any helpful information.