最新の安定バージョンについては、Spring Shell 4.0.0 を使用してください！

ヘルプオプション

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

プログラムまたはアノテーションで定義されたコマンドは、自動的にヘルプオプションを追加します。アノテーションモデルでは、グローバルにオフにすることしかできませんが、プログラムモデルではコマンドごとに設定を変更できます。