Class Help
- java.lang.Object
-
- com.github.rvesse.airline.examples.cli.commands.Help
-
- All Implemented Interfaces:
ExampleRunnable
@Command(name="help", description="A command that provides help on other commands") public class Help extends java.lang.Object implements ExampleRunnable
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<java.lang.String>
commandNames
private GlobalMetadata<ExampleRunnable>
global
private boolean
includeHidden
-
Constructor Summary
Constructors Constructor Description Help()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
run()
Runs the command and returns an exit code that the application should return
-
-
-
Field Detail
-
global
@AirlineModule private GlobalMetadata<ExampleRunnable> global
-
commandNames
@Arguments(description="Provides the name of the commands you want to provide help for") private java.util.List<java.lang.String> commandNames
-
includeHidden
@Option(name="--include-hidden", description="When set hidden commands and options are shown in help", hidden=true) private boolean includeHidden
-
-
Method Detail
-
run
public int run()
Description copied from interface:ExampleRunnable
Runs the command and returns an exit code that the application should return- Specified by:
run
in interfaceExampleRunnable
- Returns:
- Exit code
-
-