此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Shell 3.3.3！spring-doc.cn

帮助

运行 shell 应用程序通常意味着用户处于图形受限的环境。此外，虽然在手机时代我们几乎总是保持连接，访问 Web 浏览器或任何其他富 UI 应用程序（如 PDF 查看器）可能并不总是是可能的。这就是为什么 shell 命令必须正确地自我记录很重要的原因，这就是命令的用武之地。helpspring-doc.cn

键入 + 列出 shell 已知的所有命令（包括不可用的命令）以及他们工作的简短描述，类似于以下内容：helpENTERspring-doc.cn

my-shell:>help
AVAILABLE COMMANDS

Built-In Commands
       exit: Exit the shell.
       help: Display help about available commands
       stacktrace: Display the full stacktrace of the last error.
       clear: Clear the shell screen.
       quit: Exit the shell.
       history: Display or save the history of previously run commands
       completion bash: Generate bash completion script
       version: Show version info
       script: Read and execute commands from a file.

键入 API 可显示有关命令的更多详细信息，包括可用参数、其类型、是否为必填项以及其他详细信息。help <command>spring-doc.cn

下面的清单显示了应用于自身的命令：helpspring-doc.cn

my-shell:>help help
NAME
       help - Display help about available commands

SYNOPSIS
       help --command String

OPTIONS
       --command or -C String
       The command to obtain help for.
       [Optional]

帮助是模板化的，如果需要，可以进行自定义。设置位于可用于禁用命令、获取或希望通过展平来隐藏组的位置结构，用于定义命令帮助输出的模板，用于定义命令列表的输出。spring.shell.command.helpenabledgrouping-modegroupflatcommand-templatecommands-templatespring-doc.cn

如果已设置，则 help 将显示：spring.shell.command.help.grouping-mode=flatspring-doc.cn

my-shell:>help help
AVAILABLE COMMANDS

exit: Exit the shell.
help: Display help about available commands
stacktrace: Display the full stacktrace of the last error.
clear: Clear the shell screen.
quit: Exit the shell.
history: Display or save the history of previously run commands
completion bash: Generate bash completion script
version: Show version info
script: Read and execute commands from a file.

输出和都使用默认实现进行模板化可以更改。helphelp <commmand>spring-doc.cn

Option 默认为 model 并作为模型传递。spring.shell.command.help.commands-templateclasspath:template/help-commands-default.stgGroupsInfoModelspring-doc.cn

Option 默认为 model 并作为模型传递。spring.shell.command.help.command-templateclasspath:template/help-command-default.stgCommandInfoModelspring-doc.cn

表 1.GroupsInfoModel 变量
钥匙	描述
`showGroups`spring-doc.cn	`true`如果启用了 Showing Groups。否则为 false。spring-doc.cn
`groups`spring-doc.cn	commands 变量（请参阅 GroupCommandInfoModel 变量）。spring-doc.cn
`commands`spring-doc.cn	commands 变量（请参阅 CommandInfoModel 变量）。spring-doc.cn
`hasUnavailableCommands`spring-doc.cn	`true`如果有不可用的命令。否则为 false。spring-doc.cn

表 2.GroupCommandInfoModel 变量
钥匙	描述
`group`spring-doc.cn	组的名称（如果已设置）。否则为空。spring-doc.cn
`commands`spring-doc.cn	命令（如果已设置）。否则为空。Type 是多值，请参阅 CommandInfoModel 变量。spring-doc.cn

表 3.CommandInfoModel 变量
钥匙	描述
`name`spring-doc.cn	命令的名称（如果已设置）。否则为 null。类型为 string 并包含 full 命令。spring-doc.cn
`names`spring-doc.cn	命令的名称（如果已设置）。否则为 null。类型是多值，基本上是拆分的。`name`spring-doc.cn
`aliases`spring-doc.cn	可能的别名（如果已设置）。类型是带字符串的多值。spring-doc.cn
`description`spring-doc.cn	命令的描述（如果已设置）。否则为 null。spring-doc.cn
`parameters`spring-doc.cn	parameters 变量（如果已设置）。否则为空。Type 是多值，请参阅 CommandParameterInfoModel 变量。spring-doc.cn
`availability`spring-doc.cn	可用性变量（请参阅 CommandAvailabilityInfoModel 变量）。spring-doc.cn

表 4.CommandParameterInfoModel 变量
钥匙	描述
`type`spring-doc.cn	参数的类型（如果已设置）。否则为 null。spring-doc.cn
`arguments`spring-doc.cn	参数（如果已设置）。否则为 null。类型是带字符串的多值。spring-doc.cn
`required`spring-doc.cn	`true`如果需要。否则为 false。spring-doc.cn
`description`spring-doc.cn	参数的描述（如果已设置）。否则为 null。spring-doc.cn
`defaultValue`spring-doc.cn	参数的默认值（如果已设置）。否则为 null。spring-doc.cn
`hasDefaultValue`spring-doc.cn	`true`如果存在 defaultValue。否则为 false。spring-doc.cn

表 5.CommandAvailabilityInfoModel 变量
钥匙	描述
`available`spring-doc.cn	`true`如果可用。否则为 false。spring-doc.cn
`reason`spring-doc.cn	如果设置了 not available （如果已设置），则为原因。否则为 null。spring-doc.cn