Installation

This guide goes through the various methods used to install Macao.

Pre-requisites

Before we begin, make sure you have a fresh version of Node.js installed. The current Long Term Support (LTS) release is an ideal starting point. You may run into a variety of issues with the older versions as they may be missing functionality Macao and/or its related packages require.

Local Installation

The latest Macao release is:

To install the latest release or a specific version, run one of the following commands:

npm install --save macao
npm install --save macao@<version>

Installing locally is what we recommend for most projects. This makes it easier to upgrade projects individually when breaking changes are introduced.

Global Installation

The following NPM installation will make Macao available globally:

npm install --global macao

Note that this is not a recommended practice. Installing globally locks you down to a specific version of Macao and could fail in projects that use a different version.