Install Antora

      +

      Install System Prerequisites

      Antora runs on all Linux distributions, macOS, and Windows. If you have never used Antora, you may first need to install Node using nvm. Follow the installation instructions for all Antora prerequisites for your operating system:

      Install the Antora CLI and Site Generator

      To generate the Couchbase documentation, you need the Antora command line interface (CLI) and the Antora site generator.

      To install the CLI and the site generator:

      1. Open a terminal window.

      2. Copy and paste the following command and press Enter:

        npm i -g @antora/cli@3.1 @antora/site-generator@3.1

        This installs the Antora CLI and site generator globally on your computer.

      3. Copy and paste the following command and press Enter:

         $ antora -v

        This checks that Antora is available on your PATH. If installation was successful, you should see the Antora version number displayed in your terminal window.