帮助选项

Spring Shell 内置功能帮助但并非所有人都倾向于从指令中获得指令帮助因为你总是需要调用它并带参数支持目标指令。 它 在许多CLI框架中，每个命令都带有选项 --help 和 -h 来打印命令帮助。spring-doc.cadn.net.cn

默认功能是每个命令都会被修改为选项——help和-h，如果这些选项存在于某个命令中，会自动短路命令执行到现有的帮助命令不管还有哪些命令行选项被输入。spring-doc.cadn.net.cn

以下示例展示了其默认设置：spring-doc.cadn.net.cn

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

可以通过配置选项更改默认行为：spring-doc.cadn.net.cn

spring:
  shell:
    help:
      enabled: true
      long-names: help
      short-names: h
      command: help
通过程序化或注释定义的命令会自动添加帮助选项。使用注释模型时，你只能全局关闭这些功能，而在程序化模型中，你可以根据每个命令修改设置。