Install Antora


    Install System Prerequisites

    Antora runs on all Linux distributions, macOS, and Windows. If you’ve never used Antora, you may first need to instal Node using nvm. Follow the instructions below that correspond to 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.

    1. Open a terminal and install the Antora CLI:

      $ npm i -g @antora/cli
    2. Verify the antora command is available on your PATH:

      $ antora -v

      If installation was successful, you should see the Antora version number displayed in the console.

    3. Install the Antora site generator:

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