# @antora/cli

> The command line interface for Antora.

Latest version **3.2.0** (published 2026-08-29) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install @antora/cli
pnpm add @antora/cli
yarn add @antora/cli
bun add @antora/cli
```

Provides the command `antora`.

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 3.2.0 |
| Published | 2026-08-29 |
| First published | 2018-01-12 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=20.0.0 |
| Dependencies | 4 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | OpenDevise Inc. |
| Maintainers | mojavelinux, graphitefriction |
| Keywords | antora, cli, generator, documentation, static site, web publishing |

## Links

- npm: https://www.npmjs.com/package/@antora/cli
- Repository: https://gitlab.com/antora/antora
- Homepage: https://antora.org
- Issues: https://gitlab.com/antora/antora/issues
- npm.io page: https://npm.io/package/@antora/cli

## Dependencies (4)

- [commander](https://npm.io/package/commander.md) ~14.0
- [@antora/logger](https://npm.io/package/@antora/logger.md) 3.2.0
- [@antora/playbook-builder](https://npm.io/package/@antora/playbook-builder.md) 3.2.0
- [@antora/user-require-helper](https://npm.io/package/@antora/user-require-helper.md) ~3.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 3.2.0 (latest) — 2026-08-29
- 3.2.0-rc.3 (testing) — 2026-08-12
- 3.2.0-rc.2 — 2026-06-20
- 3.2.0-rc.1 — 2026-06-19
- 3.1.15 — 2026-05-26
- 3.2.0-alpha.12 — 2026-05-12
- 3.2.0-alpha.11 — 2025-11-27
- 3.2.0-alpha.10 — 2025-10-03
- 3.1.14 — 2025-10-03
- 3.1.13 — 2025-09-30
- 3.2.0-alpha.9 — 2025-08-11
- 3.1.12 — 2025-08-06
- 3.1.11 — 2025-08-06
- 3.1.10 — 2024-12-05
- 3.2.0-alpha.8 — 2024-12-05
- … 85 more at https://npm.io/package/@antora/cli/versions

## README

# Antora CLI

The command line interface (CLI) for Antora.
This package provides the `antora` command (i.e., bin script) to run Antora.
It does not include the site generator, which must be installed separately.

[Antora](https://antora.org) is a modular static site generator designed for creating documentation sites from AsciiDoc documents.
Its site generator aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).

To run Antora, you need both the CLI and a site generator.
Once these packages are installed, you can use the `antora` command to generate your site.

## How to Install

Let’s start by installing the CLI.

```sh
npm i -g @antora/cli
```

This package adds the `antora` command to your PATH.
You can check by running:

```sh
antora -v
```

Next, install a site generator.
The site generator provided by Antora will be sufficient for most users.

```sh
npm i -g @antora/site-generator
```

The `antora` command (specifically the implicit `generate` subcommand) will look for this package by default.

## How to Use

To run Antora, you’ll need a playbook file and at least one content (source) repository.
Consult the [quickstart](https://docs.antora.org/antora/latest/install-and-run-quickstart/) to find an example.

Once you have your content sources set up, point the `antora` command at your playbook file:

```sh
antora antora-playbook.yml
```

The `antora` command will output the generated site to the _build/site_ folder by default.

## Copyright and License

Copyright (C) 2017-present [OpenDevise Inc.](https://opendevise.com) and the [Antora Project](https://antora.org).

Use of this software is granted under the terms of the [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0).

---
_Source: https://npm.io/package/@antora/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._