使用 PicoCLI 显示子命令的选项

display options for subcommands using PicoCLI

我正在使用 PicoCLI v4.0.0-beta-1b。我正在使用从父命令链接的不同子命令。启动 CLI 时会显示父命令的可选参数,但不会显示子命令。子命令仅出现在命令下方(但没有选项)。 如何确保子命令的选项也出现在 CLI 中?

Options:
  -a, --autocomplete   Generate sample autocomplete
  -h, --help           Display this help message.
  -v, --verbose        Verbose mode. Helpful for troubleshooting.
  -V, --version        Show version info and exit.
Commands:
  abc
  def 

默认情况下,picocli 仅显示命令子命令的概览,不显示详细信息。这遵循其他命令套件的约定,例如 git。这个想法是,最终用户总是可以通过请求特定子命令的帮助来获取另一个子命令的详细信息,例如 git commit --helpgit help commit

虽然这是一个有用的默认设置,但如果这不是您想要的,picocli 使用帮助非常重要 customizable

picocli 用法消息包含以下部分:

  • header 标题
  • header
  • 概要标题
  • 剧情简介
  • 描述标题
  • 描述
  • 位置参数列表标题
  • 位置参数列表
  • 选项列表标题
  • 选项列表
  • 命令列表标题
  • 命令列表
  • 退出代码列表标题(自 4.0 起)
  • 退出代码列表(自 4.0 起)
  • 页脚标题
  • 页脚

每个部分都有自己的 IHelpSectionRenderer,您可以通过删除、重新排序或替换这些帮助部分呈现器来更改使用帮助。

这里有一个帮助您入门的示例: https://github.com/remkop/picocli/blob/master/picocli-examples/src/main/java/picocli/examples/customhelp/ShowAll.java

上面的例子有一个命令列表的自定义 IHelpSectionRenderer,显示命令、子命令和 sub-subcommands 等的完整层次结构。您可能想做类似的事情,但显示改为子命令的选项。

您需要熟悉 picocli Help API, like TextTable, Layout, IOptionRenderer 等的一些细节