# @antora/cli 中文文档

规范地址：https://npmcn.com/package/%40antora/cli/

版本：3\.2\.2
npm 元数据更新时间：2026-10-30T20:28:41.497Z
中文译文更新时间：2026-11-06T07:07:48.424Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40antora/cli
原文对照：https://npmcn.com/package/%40antora/cli/?lang=original
项目主页：https://antora.org/
源码仓库：https://gitlab.com/antora/antora

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：12.9 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.0\.0
- 运行依赖：4 个
- 首次发布：2018-01-12T09:03:24.424Z
- 最新版本发布：2026-10-30T20:28:41.309Z
- 近 30 天下载量：162821（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：102（近 12 个月 9 个）

## 中文简介

安多拉的命令行界面.

## 安装

```sh
npm install @antora/cli
```

也可以使用：`pnpm add @antora/cli`、`yarn add @antora/cli`、`bun add @antora/cli`

## README

# 安托拉 CLI 语录

Antora 的命令行界面(CLI). 这个软件包提供了 `antora` 命令(即bin脚本)运行 Antora. 它不包括必须单独安装的站点生成器.

[安托拉语Name](https://antora.org/) 是一个模块化的静态站点生成器,用于从AsciiDoc文档创建文档站点. 其站点生成器从已版本的内容存储库汇总文件并使用 [辅助器](https://asciidoctor.org/)。 。 。 .

要运行Antora,你既需要CLI,也需要一个站点生成器. 这些软件包安装完毕后,就可以使用 `antora` 命令生成您的网站.

## 如何安装

让我们首先安装 CLI .

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

此软件包添加 `antora` 命令到您的路径. 您可以通过运行查看 :

```sh
antora -v
```

接下来,安装一个站点生成器. Antora提供的站点生成器将足以供大多数用户使用.

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

这个 `antora` 命令(特别是隐含的) `generate` 子命令)将默认查找此软件包.

## 如何使用

要运行 Antora , 您需要游戏本文件和至少一个内容( 来源) 寄存器 . 咨询 [快速启动](https://docs.antora.org/antora/latest/install-and-run-quickstart/) 找到一个例子.

一旦设置了内容源,请指出 `antora` 命令 :

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

这个 `antora` 命令将输出生成的站点到 _建筑/场地_ 默认文件夹.

## 版权和许可证

版权(C)2017年至今 [OpenDevise Inc. (英语).](https://opendevise.com/) 编辑 [Antora项目](https://antora.org/)。 。 。 .

该软件的使用按照下列规定进行: [Mozilla 公共许可版本 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0) (中文(简体) ).

## 常见问题

### @antora/cli 是什么？

安多拉的命令行界面\.

### 如何安装 @antora/cli？

在项目目录运行 npm install @antora/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 antora，可以用 npx antora 直接运行。

### @antora/cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/antora\_\_cli 是否存在。

### @antora/cli 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @antora/cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @antora/cli 可以商用吗？

@antora/cli 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @antora/cli 的下载量有多少？

根据 npm 官方下载统计，@antora/cli 在 2026/10/06 – 2026/11/04 这 30 天内被下载 162,821 次，日均约 5,427 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @antora/cli 还在维护吗？

最新版本 3\.2\.2 发布于 2026/10/31（7 天前）；至今共发布 102 个版本，其中过去 12 个月发布了 9 个；首次发布于 2018/01/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。