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 Object
implements ExampleRunnable
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
run()
Runs the command and returns an exit code that the application should return
-
Field Details
-
global
-
commandNames
@Arguments(description="Provides the name of the commands you want to provide help for") private List<String> commandNames -
includeHidden
@Option(name="--include-hidden", description="When set hidden commands and options are shown in help", hidden=true) private boolean includeHidden
-
-
Constructor Details
-
Help
public Help()
-
-
Method Details
-
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
-