该版本仍在开发中,尚未被视为稳定。最新稳定版本请使用Spring Shell 3.4.1spring-doc.cadn.net.cn

帮助选项

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
通过程序或注释定义的命令会自动添加 帮助选项。使用注释模型时,你只能全局关闭,而 通过程序化模型,你可以根据每个命令修改设置。