CLI 选项

您可以使用命令行选项直接从终端配置 Antora CLI 和各种 playbook 键的行为。本页列出了这些选项、如何指定它们以及如何使用它们。

优先级

CLI 选项将覆盖 playbook 文件中定义的相应键的值以及任何环境变量。

全局选项

下表中的选项适用于 antora 基本调用，并影响整个 antora CLI 的行为。

选项 默认值 值 详解

-h, --help

不适用

不适用

显示有关命令使用情况及其选项和参数的信息。请参见 Display Antora CLI 帮助。

-r, --require

未设置

Node.js包(即模块)名称或脚本的文件系统路径

可以指定多次。参见 预加载Asciidoctor扩展。

--stacktrace

false

Boolean

如果应用程序失败，将堆栈跟踪打印到控制台。请参阅 激活布尔选项 和 显示错误堆栈跟踪。

-v, --version

不适用

不适用

显示 CLI 和默认站点生成器的版本。

生成命令选项

下表中的选项仅适用于 generate 命令。

选项 默认值 值 详解

--asciidoc-sourcemap

false

Boolean

请 参阅文件和行号信息。

--attribute

未设置

<name> 或 <name=value> 形式 AcciiDoc 属性

可以指定多次。请参阅 将属性分配给站点 和将 https://docs.antora.org/antora/latest/cli/options/#ex-name-value-pair。

--cache-dir

随操作系统变化

文件系统路径

参见 缓存目录 和 ANTORA_CACHE_DIR 变量。

--clean

false

Boolean

此选项擦除 整个文件夹及其文件;小心使用!参见 clean key, Pass多个选项到CLI，以及 Activate一个布尔选项。

--extension

未设置

文件系统路径或者扩展ID

可以多次指定。请参见 注册扩展。

--fetch

false

Boolean

查看 fetch Updates

--generator

@antora/site-generator

Node.js包(即模块)名称或脚本的文件系统路径

用指定模块或脚本导出的替代实现替换 Antora 的默认站点生成器。专为高级用户舒适的使用 Antora。

--git-credentials-path

$HOME/.git-credentials 或 $XDG_CONFIG_HOME/git/credentials

文件系统路径

参见 git凭据文件路径 和 GIT_CREDENTIALS_PATH 变量。

-h, --help

不适用

不适用

显示有关命令使用情况及其选项和参数的信息。请参见 Display Antora CLI 帮助。

--html-url-extension-style

default

default

drop

indexify

面向用户的 URL 扩展 Antora 用于 HTML 页面。参见 HTML 扩展样式。

--http-proxy

未设置

由协议、域和端口组成的URL。

向 HTTP URL 请求时要使用的代理网址。请参阅 http_proxy 。

--https-proxy

未设置

由协议、域和端口组成的URL。

向 HTTPS URL 请求时要使用的代理网址。请参阅https://docs.antora.org/antora/latest/playbook/network-proxy/#https-proxy[https_proxy]。

--key

未设置

API密钥，格式为<name=value>

可以多次指定。请参见 帐户和API密钥 ，并 多次指定一个选项。

--log-failure-level

fatal

fatal

error

warn

none

查看 日志失败层级 和 ANTORA_LOG_FAILURE_LEVEL

--log-file

如果格式是 pretty，则是 stderr ;否则是 stdout

stdout (or 1)

stderr (or 2)

文件系统路径

查看 file key 和 ANTORA_LOG_FILE

--log-format

如果 CI=true 或者交互式终端，则是 pretty ，否则是 json

json

pretty

查看 format key 和 ANTORA_LOG_FORMAT 变量

--log-level

warn

fatal

error

warn

info

debug

all

silent

查看 Log Severity Level 和 ANTORA_LOG_LEVEL 变量

--log-level-format

label

label

number

查看 level_format key 和 ANTORA_LOG_LEVEL_FORMAT 变量。当日志格式是 json 时才应用

--noproxy

未设置

逗号分开域列表或 *

不应该被代理的 HTTP 或 HTTPS 请求的域，查看 no_proxy。

--quiet

false

Boolean

消息不会写入标准输出。

--redirect-facility

static

disabled

gitlab

httpd

netlify

nginx

static

查看 redirect Facility Key 和 传递多个选项到CLI

--silent

false

Boolean

抑制所有消息，包括警告和错误。

--start-page

未设置

Antora 页面ID

查看 站点开始页

--title

未设置

站点标题

查看 站点标题 和 赋包含空格的值到选项

--to-dir

build/site

文件系统路径

请小心指定此选项与 --clean。查看 输出目录 和 选项赋值

--ui-bundle-url

未设置

URL或文件系统路径

查看 UI包路径 和 传递多个选项到CLI

--url

未设置

站点的绝对 URL 或基础 URL 的相对路径

查看 站点URL 和 URL变量

传递选项给CLI

可以为命令指定多个选项。命令必须以 antora 基本调用开始，以 playbook 文件参数结束。如果不存在，则暗示生成命令，因此不必显式指定它。请记住，您键入的命令相对于当前工作目录执行。

Example 1. Pass multiple options to the CLI
antora --ui-bundle-url ./../ui-bundle.zip --redirect-facility nginx --clean antora-playbook

在将多个选项传递给 CLI 中，为选项 --ui-bundle-url 分配了一个值，该值指定了相对于工作目录的本地文件系统路径。--redirect-facility 被赋值为内置值 nginx 。布尔选项 --clean 通过输入不带值的名称来启用。

有些选项可以多次指定。这些键对应于值的映射。示例包括 --key 和 --attribute 。每个值之前必须有选项标志。

Example 2. Specify an option multiple times
antora --key support=587tyr999 --key tracer=ID-${spawn} antora-playbook

在多次指定一个选项中，--key 选项以 name=value 的形式被分配了两个值。

值类型

有两种方法可以为选项赋值。选项标志和其值之间可以用单个空格进行分隔：--option value 。或者，可以使用选项标志和值之间的等号（=）进行分隔：--option=value 。选择哪种形式是个人喜好。

在“为选项分配值”中，选项 --to-dir 被赋值为 prod 。当 Antora 运行时，将在相对于工作目录创建名为 prod 的文件夹，并将站点文件写入其中。

Example 3. Assign a value to an option
antora --to-dir prod antora-playbook

包含空格的值必须用引号括起来: --option 'Value with spaces' 或 --option='Value with spaces' 。在将包含空格的值赋给选项中，将选项 title 赋值为 My Docs 。生成的站点的标题将是 My Docs 。

Example 4. Assign a value containing spaces to an option
antora --title 'My Docs' antora-playbook

Name=value

--attribute 和 --key 选项接受 name=value 形式的值，其中 name 分别表示 AsciiDoc 属性或 API 密钥的名称。在“Assign a name=value value”中，为属性 page-team 分配的值为 Coco B。值后面的 @ 表示该属性为软设置。

Example 5. Assign a name=value value to an option
antora --attribute page-team='Coco B@' antora-playbook

布尔值

布尔选项打开或关闭一个行为。要激活布尔选项，请在命令行中键入它。

Example 6. Activate a boolean option
antora --stacktrace antora-playbook

当一个布尔选项在剧本文件中被激活时，它不能从命令行取消激活。