CLI Options :: Antora Docs

优先级

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

全局选项

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

选项默认值取值备注

选项	默认值	取值	备注
`-h`, `--help`	不适用	不适用	显示有关命令用法及其选项和参数的信息。参见显示Antora CLI帮助。
`-r`, `--require`	未设置	Node.js包（即模块）名称或脚本的文件系统路径	在加载Antora之前需要额外的代码（Node.js模块或本地JavaScript文件）。可以多次指定。参见预加载Asciidoctor扩展。
`--stacktrace`	`false`	布尔值	如果应用程序失败，则将堆栈跟踪打印到控制台。参见激活布尔选项和显示错误堆栈跟踪。
`-v`, `--version`	不适用	不适用	显示CLI和默认站点生成器的版本。

-h, --help

不适用

显示有关命令用法及其选项和参数的信息。参见显示Antora CLI帮助。

-r, --require

未设置

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

在加载Antora之前需要额外的代码（Node.js模块或本地JavaScript文件）。可以多次指定。参见预加载Asciidoctor扩展。

--stacktrace

false

布尔值

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

-v, --version

不适用

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

生成命令选项

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

选项默认值数值注释

选项	默认值	数值	注释
`--asciidoc-sourcemap`	`false`	布尔值	查看文件和行号信息。
`--attribute`	未设置	AsciiDoc属性的形式为 `<name>` 或 `<name=value>`	可以多次指定。查看为站点分配属性和为选项分配名称=值。
`--cache-dir`	根据操作系统变化	文件系统路径	查看缓存目录和 ANTORA_CACHE_DIR 变量。
`--clean`	`false`	布尔值	此选项擦除整个文件夹及其文件；请谨慎使用！查看 clean key，向CLI传递多个选项，以及激活布尔选项。
`--extension`	未设置	文件系统路径或扩展ID	可以多次指定。查看注册扩展。
`--fetch`	`false`	布尔值	查看获取更新。
`--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`	不适用	不适用	显示有关命令用法及其选项和参数的信息。查看显示Antora CLI帮助。
`--html-url-extension-style`	`default`	`default` `drop` `indexify`	Antora用于HTML页面的用户可见URL扩展。查看 HTML扩展样式。
`--http-proxy`	未设置	由协议、域和端口组成的URL	在向HTTP URL发出请求时使用的代理的URL。查看 http_proxy。
`--https-proxy`	未设置	由协议、域和端口组成的URL	在向HTTPS URL发出请求时使用的代理的URL。查看 https_proxy。
`--key`	未设置	形式为 `<name=value>` 的API密钥	可以多次指定。查看帐户和API密钥和多次指定选项。
`--log-failure-level`	`fatal`	`fatal` `error` `warn` `none`	查看日志失败级别和 ANTORA_LOG_FAILURE_LEVEL 变量。
`--log-file`	`stderr` 如果格式为 `pretty`，否则为 `stdout`	`stdout`（或 `1`） `stderr`（或 `2`）文件系统路径	查看文件键和 ANTORA_LOG_FILE 变量。
`--log-format`	`pretty` 如果CI=true或终端是交互式的，否则为 `json`	`json` `pretty`	查看格式键和 ANTORA_LOG_FORMAT 变量。
`--log-level`	`warn`	`fatal` `error` `warn` `info` `debug` `all` `silent`	查看日志严重级别和 ANTORA_LOG_LEVEL 变量。
`--log-level-format`	`标签`	`标签` `数字`	查看level_format键和ANTORA_LOG_LEVEL_FORMAT变量。仅在日志格式为`json`时适用。
`--noproxy`	未设置	一个逗号分隔的域名列表或`*`	不应代理的HTTP或HTTPS请求的域。查看no_proxy。
`--quiet`	`假`	布尔值	消息不会写入标准输出。
`--redirect-facility`	`静态`	`禁用` `gitlab` `httpd` `netlify` `nginx` `静态`	查看重定向设施键和向CLI传递多个选项。
`--silent`	`假`	布尔值	抑制所有消息，包括警告和错误。
`--start-page`	未设置	Antora页面ID	查看站点起始页面。
`--title`	未设置	站点标题	查看站点标题和为选项分配包含空格的值。
`--to-dir`	build/site	文件系统路径	在与`--clean`组合使用此选项时要小心。查看输出目录和为选项分配值。
`--ui-bundle-url`	未设置	URL或文件系统路径	查看UI Bundle URL和向CLI传递多个选项。
`--url`	未设置	站点的绝对或路径名基本URL	查看站点URL和URL变量。

--asciidoc-sourcemap

false

布尔值

查看文件和行号信息。

--attribute

未设置

AsciiDoc属性的形式为 <name> 或 <name=value>

可以多次指定。查看为站点分配属性和为选项分配名称=值。

--cache-dir

根据操作系统变化

文件系统路径

查看缓存目录和 ANTORA_CACHE_DIR 变量。

--clean

false

布尔值

此选项擦除整个文件夹及其文件；请谨慎使用！查看 clean key，向CLI传递多个选项，以及激活布尔选项。

--extension

未设置

文件系统路径或扩展ID

可以多次指定。查看注册扩展。

--fetch

false

布尔值

查看获取更新。

--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

不适用

显示有关命令用法及其选项和参数的信息。查看显示Antora CLI帮助。

--html-url-extension-style

default

default
drop
indexify

Antora用于HTML页面的用户可见URL扩展。查看 HTML扩展样式。

--http-proxy

未设置

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

在向HTTP URL发出请求时使用的代理的URL。查看 http_proxy。

--https-proxy

未设置

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

在向HTTPS URL发出请求时使用的代理的URL。查看 https_proxy。

--key

未设置

形式为 <name=value> 的API密钥

可以多次指定。查看帐户和API密钥和多次指定选项。

--log-failure-level

fatal

fatal
error
warn
none

查看日志失败级别和 ANTORA_LOG_FAILURE_LEVEL 变量。

--log-file

stderr 如果格式为 pretty，否则为 stdout

stdout（或 1）
stderr（或 2）
文件系统路径

查看文件键和 ANTORA_LOG_FILE 变量。

--log-format

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

json
pretty

查看格式键和 ANTORA_LOG_FORMAT 变量。

--log-level

warn

fatal
error
warn
info
debug
all
silent

查看日志严重级别和 ANTORA_LOG_LEVEL 变量。

--log-level-format

标签

标签
数字

查看level_format键和ANTORA_LOG_LEVEL_FORMAT变量。仅在日志格式为json时适用。

--noproxy

未设置

一个逗号分隔的域名列表或*

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

--quiet

假

布尔值

消息不会写入标准输出。

--redirect-facility

静态

禁用
gitlab
httpd
netlify
nginx
静态

查看重定向设施键和向CLI传递多个选项。

--silent

假

布尔值

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

--start-page

未设置

Antora页面ID

查看站点起始页面。

--title

未设置

站点标题

查看站点标题和为选项分配包含空格的值。

--to-dir

build/site

文件系统路径

在与--clean组合使用此选项时要小心。查看输出目录和为选项分配值。

--ui-bundle-url

未设置

URL或文件系统路径

查看UI Bundle URL和向CLI传递多个选项。

--url

未设置

站点的绝对或路径名基本URL

查看站点URL和URL变量。

将选项传递给CLI

您可以为命令指定多个选项。命令必须以antora基本调用开头，并以playbook文件参数结尾。如果不存在，则隐含执行generate command，因此不必显式指定。请记住，您键入的命令相对于当前工作目录执行。

将多个选项传递给CLI

$ antora --ui-bundle-url ./../ui-bundle.zip --redirect-facility nginx --clean antora-playbook

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

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

多次指定一个选项

$ antora --key support=587tyr999 --key tracer=ID-${spawn} antora-playbook

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

值类型

--option value。或者，可以使用等号（ =）将选项标志和值写在一起： --option=value。您选择哪种形式是个人偏好。

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

为选项分配值

$ antora --to-dir prod antora-playbook

包含空格的值必须用引号括起来：--option '带有空格的值'或--option='带有空格的值'。在为选项分配包含空格的值中，选项title被分配了值My Docs。生成的站点标题将是My Docs。

为选项分配包含空格的值

$ antora --title 'My Docs' antora-playbook

名称=值值

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

为选项分配名称=值值

$ antora --attribute page-team='Coco B@' antora-playbook

布尔值

布尔选项打开或关闭某种行为。要激活布尔选项，请在命令行上键入它。

激活布尔选项

$ antora --stacktrace antora-playbook