A hash of flags for the command
An array of aliases for this command.
An order-dependent array of arguments for the command
Emit deprecation warning when a command alias is used
A full description of how to use the command.
If no summary, the first line of the description will be used as the summary.
An array of examples to show at the end of the command's help.
IF only a string is provided, it will try to look for a line that starts with the cmd.bin as the example command and the rest as the description. If found, the command will be formatted appropriately.
A description of a particular use case.
$ <%= config.bin => command flags
Hide the command from help
A command ID, used mostly in error or verbose reporting.
instantiate and run the command
Mark the command as a given state (e.g. beta or deprecated) in help
When set to false, allows a variable amount of arguments
The tweet-sized description for your class, used in a parent-commands sub-command listing and as the header for the command help.
An override string (or strings) for the default usage documentation.
Optionaloptions: Input<F, G>
Optionalmessage: Record<string, unknown>
actual command run code goes here
Generated using TypeDoc