幫助選項

Spring Shell 有一個內建的 help 命令，但並非所有人都喜歡從中獲取命令幫助，因為您始終需要使用目標命令的引數來呼叫它。在許多 cli 框架中，每個命令都帶有 --help 和 -h 選項來列印命令幫助是很常見的。

預設功能是每個命令都將修改為具有 --help 和 -h 選項，如果給定命令中存在這些選項，無論鍵入了哪些其他命令列選項，它都會自動將命令執行短路到現有 help 命令。

下面的示例顯示了其預設設定。

@Bean
CommandRegistration commandRegistration() {
	return CommandRegistration.builder()
		.command("mycommand")
		.withHelpOptions()
			.enabled(true)
			.longNames("help")
			.shortNames('h')
			.command("help")
			.and()
		.build();
}

可以透過配置選項更改預設行為。

spring:
  shell:
    help:
      enabled: true
      long-names: help
      short-names: h
      command: help

以程式設計方式或透過註解定義的命令將自動新增幫助選項。使用註解模型，您只能全域性關閉這些選項，程式設計模型提供了修改每個命令的設定的選項。