CLI入门
如果您对命令行界面不熟悉，以下部分提供了关于命令行和终端概念的一些基本信息，这些概念在本文档中使用。
命令输入和结构
Antora CLI接受命令输入的形式为基本调用、命令（用于程序）、选项和参数。一旦在终端中输入，命令将使用指定的输入执行。
$ antora <command> [options] <arguments>
- 基本调用
-
Antora CLI命令以程序名称（即
antora）开头。这告诉命令解释器执行Antora CLI。如果系统无法自行找到程序名称，则必须指定antorabin脚本的路径（例如，npx antora）。 - 命令
-
命令告诉Antora要执行的操作。一次只能指定一个命令。
- 选项
-
在命令后可以指定一个或多个选项。选项的全名以两个连字符（
--）为前缀；简写名以一个连字符（-）为前缀。一些选项用于切换行为，另一些接受值。接受值的选项可以使用选项名称和值之间的单个空格（
--option value）或使用名称和值之间的等号（--option=value）。 - 参数
-
参数在基本调用和任何选项之后输入。您可以将参数视为匿名选项。
generate命令仅接受一个参数，即playbook文件的路径。 - 环境变量
-
环境变量（不包含在命令本身中）从终端的状态中读取。环境变量会覆盖playbook文件中的相应键，但会被相应的CLI选项覆盖。
终端约定
如果您是终端应用程序的新手，本文档中使用的常见约定表示终端并描述您将如何与其交互。
-
提示符（
$） -
终端命令提示符在本文档中的示例中显示为美元符号（
$）。您打开终端时看到的提示符取决于您使用的终端应用程序。在键入或复制命令时，请不要包含$提示符。 - 工作目录
-
每个命令都是从当前工作目录运行的。与命令输入相关的进程是相对于工作目录解释的。您当前的工作目录通常直接显示在终端命令提示符（
$）的左侧，但这取决于您使用的终端应用程序及其配置方式。本文档中的一些示例在提示符前显示工作目录的名称，作为一个有用的提示。
工作目录名称 $ antora antora-playbook
在复制命令时，请不要包含此文本或提示符。
- 可替换输入
-
许多选项根据您的内容、环境和站点要求进行定义。本文档中的一些命令行示例标出您用一组尖括号（
< >）定义的输入。尖括号内的文本描述输入或表示常见的输入格式，例如，--require <path/to/library-script>，--title '<站点标题>'。在终端中组合命令时，请用您的输入替换代表性文本，并不要用尖括号（< >）括起来。 - 命令输出
-
如果命令返回信息，输出将显示在终端中执行命令下方的行上。输出行上不显示命令提示符（
$）。