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

帮助选项

Spring Shell 有一个内置命令，但并非所有人都喜欢获得命令帮助从它开始，因为您总是需要使用 Arguments for Target Command 调用它。它在许多 CLI 框架中，每个命令都有选项 --help 和 -h 来打印命令 help。helpspring-doc.cn

默认功能是每个命令都会被修改为具有选项 --help 和 -h，如果它们出现在给定的命令中，则会自动将命令执行短路到现有命令中，无论键入的其他命令行选项。helpspring-doc.cn

以下示例显示了其默认设置。spring-doc.cn

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

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

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

以编程方式或通过注释定义的命令将自动添加 help 选项。使用注释模型，您只能全局关闭，以编程方式 model 提供了修改每个命令的设置的选项。