Install Antora


  • You’ve installed the base build tools on your Linux or macOS machine (not applicable for Windows).

  • You’ve installed Node 8 on your Linux, Windows, or macOS machine.

On this page, you’ll learn:

  • How to install the Antora CLI.

  • How to install the default Antora site generator.

To generate documentation sites with Antora, you need the Antora command line interface (CLI) and an Antora site generator pipeline. Once these packages are installed, you can use the antora command to publish a site.

Install the Antora CLI

We’ll begin by installing the Antora CLI using the base call for Node’s package manager, npm. This package manager was installed when you installed Node.

You should install (i) the CLI globally (-g) so the antora command is available on your PATH.

Open a terminal and type:

$ npm i -g @antora/cli
When we say “globally” here, it does not imply system-wide. It means the location where Node is installed. If you used nvm to install Node, this location will be inside your home directory (thus not requiring elevated permissions).
If you prefer Yarn over npm, you can install Antora using yarn global add @antora/cli.

Verify the antora command is available on your PATH by running:

$ antora -v

If the installation worked, this command should report the version of Antora.

$ antora -v

Install the default Antora site generator

Next, install the default site generator.

To install the generator globally, type:

$ npm i -g @antora/site-generator-default

If you don’t want to install the generator globally, you can opt to install it inside the playbook project (the project that contains the playbook file(s) for your site).

Switch to the playbook project and type:

$ npm i @antora/site-generator-default
If you’re on Linux and get an error message about, you’ll need to patch or recompile nodegit.

What’s next?

Now that the Antora CLI and default site generator are installed, you are ready to: