Predefined variable that will be populated with a miniature API that can be used to query Clipanion and forward commands.
Predefined variable that will be populated with the context of the application.
Predefined that will be set to true if -h,--help has been used, in which case Command#execute shouldn't be called.
The path that got used to access the command being executed.
A list of useful semi-opinionated command entries that have to be registered manually.
They cover the basic needs of most CLIs (e.g. help command, version command).
A command that prints the usage of all commands.
Paths: -h, --help
A command that prints the version of the binary (cli.binaryVersion).
Paths: -v, --version
The schema used to validate the Command instance.
Contains the usage information for the command. If undefined, the command will be hidden from the general listing.
Standard error handler which will simply rethrow the error. Can be used to add custom logic to handle errors from the command or simply return the parent class error handling.
Register a listener that looks for an option and its followup argument. When Clipanion detects that this argument is present, the value will be pushed into the array represented in the property.
Register a boolean listener for the given option names. When Clipanion detects that this argument is present, the value will be set to false. The value won't be set unless the option is found, so you must remember to set it to an appropriate default value.
the option names.
Register a boolean listener for the given option names. Each time Clipanion detects that this argument is present, the counter will be incremented. Each time the argument is negated, the counter will be reset to 0. The counter won't be set unless the option is found, so you must remember to set it to an appropriate default value.
A comma-separated list of option names.
Wrap the specified command to be attached to the given path on the command line. The first path thus attached will be considered the "main" one, and all others will be aliases.
The command path.
Register a listener that takes all the arguments remaining (including options and such) and store them into the selected property. Note that all methods affecting positional arguments are evaluated in the definition order; don't mess with it (for example sorting your properties in ascendent order might have adverse results).
Register a listener that takes all the positional arguments remaining and store them into the selected property. Note that all methods affecting positional arguments are evaluated in the definition order; don't mess with it (for example sorting your properties in ascendent order might have adverse results).
Register a listener that takes all the positional arguments remaining and store them into the selected property. Note that all methods affecting positional arguments are evaluated in the definition order; don't mess with it (for example sorting your properties in ascendent order might have adverse results).
The minimal number of arguments required for the command to be successful.
Register a listener that looks for an option and its followup argument. When Clipanion detects that this argument is present, the value will be set to whatever follows the option in the input. The value won't be set unless the option is found, so you must remember to set it to an appropriate default value. Note that all methods affecting positional arguments are evaluated in the definition order; don't mess with it (for example sorting your properties in ascendent order might have adverse results).
The option names.
Register a listener that looks for positional arguments. When Clipanion detects that an argument isn't an option, it will put it in this property and continue processing the rest of the command line. Note that all methods affecting positional arguments are evaluated in the definition order; don't mess with it (for example sorting your properties in ascendent order might have adverse results).
Whether or not filling the positional argument is required for the command to be a valid selection.
Generated using TypeDoc
Command to be executed when running
tscmonoortscmono generate