macOS Installation Requirements

On this page, you’ll learn:

  • What tools you need in order to install Antora on macOS.

  • How to install the base build tools on macOS.

  • How to install Node 8.

If you’ve never installed Antora before, you need to complete the steps on this page before you can generate a documentation site.

To install Antora, you need the base build tools for macOS and Node 8.

Base Build Tools

The Xcode command line tools are required for installing the nodegit package, a dependency of Antora. This selection of tools provides other useful commands you’ll need in your workflow, such as git.

You can trigger installation using the following command:

$ xcode-select --install

Once you have these tools installed, you can expect the remaining installation to go smoothly.

Node 8

Antora requires Node 8, the current long term support (LTS) release of Node.

To check which version of Node you have installed, if any, open a terminal and type:

$ node --version

If this command fails with an error, you don’t have Node installed. The best way to install Node 8 is via your package manager. However, if the package manager doesn’t provide Node, skip directly to install nvm and Node for instructions.

If the command returns a version less than 8.0.0, upgrade to the latest Node 8 version using the package manager. Or, if the package manager doesn’t provide Node and you have nvm installed, go directly to upgrade Node with nvm for instructions.

If the command returns a Node 8 version, set Node 8 as the default by typing the following command in your terminal.

$ nvm alias default 8

Now you’re ready to install Antora.

While you can use Node 9, we don’t recommend it because there are no precompiled binaries for Node 9 of nodegit, a dependency of Antora. If you use Node 9, installation will take considerably longer.

Install nvm and Node

If your package manager doesn’t provide Node, we recommend using the Node Version Manager (nvm) to manage your Node installations. Follow these installation instructions to set up nvm on your machine.

Many CI environments use nvm to install the version of Node used for the build job. By using nvm, you can closely align your setup with the environment that is used to generate and publish your production site.

Once you’ve installed nvm, open a new terminal and install Node 8.

$ nvm install 8

The above command will install the latest version of Node 8 and automatically set it as your default alias.

Now that you have Node, you’re ready to install Antora.

Upgrade Node with nvm

If you have nvm installed but your Node version is less than 8.0.0, type the following command in your terminal:

$ nvm install 8

The above command will install the latest version of Node 8.

To set the latest version of Node 8 as the default for any new terminal, type:

$ nvm alias default 8

Now that you’ve upgraded Node, you’re ready to install Antora.

What’s next?

Once you’ve installed the base build tools and Node 8, it’s time to install Antora.