BaseCliktCommand
A base class for commands that want to define a custom type for their run
function.
Inheritors
Properties
If true, allow multiple of this command's subcommands to be called sequentially. This will disable allowInterspersedArgs
on the context of this command and its descendants.
The envvar to use to enable shell autocomplete script generation. Set to null to disable generation.
The name of this command, used in help output.
This command's context.
If true, don't display this command in help output when used as a subcommand.
Used when this command has subcommands, and this command is called without a subcommand. If true, run will be called. By default, a PrintHelpMessage is thrown instead.
If this command is called with no values on the command line, print a help message (by throwing PrintHelpMessage) if this is true
, otherwise run normally.
If true, any options on the command line whose names aren't valid will be parsed as an argument rather than reporting an error. You'll need to define an argument().multiple()
to collect these options, or an error will still be reported. Unknown short option flags grouped with other flags on the command line will always be reported as errors.
Functions
Return the parameters that should be sent to the help formatter when this command's getFormattedHelp is called.
Create a property delegate argument.
Configure this command's Context.
Echo the string returned by getFormattedHelp.
Find the closest object of type T, or null
Find the closest object of type T, setting context.obj
if one is not found.
Return the help string for this command, optionally with an error.
Help text to display at the end of the help output, after any parameters.
Add a message to be printed after parsing
Declare a set of two or more mutually exclusive options.
Create a property delegate option.
Register an argument with this command.
Get a read-only list of arguments registered in this command (e.g. via registerArgument or an argument delegate)
Get a read-only list of options registered in this command (e.g. via registerOption or an option delegate)
Get a read-only list of groups registered in this command (e.g. via registerOptionGroup or an OptionGroup delegate)
The names of all direct children of this command
Get a read-only list of commands registered as subcommands of this command.
Register an option with this command or group.
Register an option with this command.
Register a group with this command.
Find the closest object of type T, or throw a NullPointerException
Create a new context for this command and all its subcommands recursively.