the flag/arg name or tokens.
the description or config object.
the option's type.
the option's default value.
When true injects -- abort arg resulting in all arguments being added to result.__
enables/disables abort for command.
Creates long description about the command.
the text to be displayed about the command.
Binds an action to be called when parsed command or alias is matched.
the callback action.
Adds alias to command.
string or array of string aliases.
Adds alias(s) option by key.
the option key name.
the aliases to be added.
Adds an argument by parsable tokens.
the token to be parsed as an argument.
Adds an argument to command using config object.
the name of the argument to create.
the option configuration object.
Adds an argument to the command.
the argument name.
the description for the argument.
the argument's type.
a default value.
Adds multiple args to command from a string of arguments.
@ .args('
Adds multiple args to command from an array.
@ .args('
array of args to add for command.
Assigns option keys as type of array.
the option keys to assign.
Assigns option keys as type of boolean.
the option keys to assign.
Adds coercion method for option.
the name of the option.
a coerce handler function.
Sets custom completions for the specified option.
the option key name.
array of completion values.
Gets the command config object.
Gets a configuration for a flag or arg option on this command.
the name of the flag or arg option.
Sets a default value for the specified option.
the option key name.
a default value.
Sets demands for the specified option.
the option key name.
rest array of keys to demand.
Sets demands when matches handler criteria
the option key name.
array of keys to demand.
handler that returns if should demand keys.
Sets demands when matches handler criteria
the option key name.
array of keys to demand.
indicates how many keys should be demanded, 0 for all.
handler that returns if should demand keys.
Sets deny for the specified option.
the option key name.
rest array of keys to deny.
Sets deny when matches handler criteria
the option key name.
array of keys to deny.
handler that returns if should deny keys.
Sets deny when matches handler criteria
the option key name.
array of keys to deny.
indicates how many keys should be denied, 0 for all.
handler that returns if should deny keys.
Adds or updates the command's description.
the command description.
Sets a description for the specified option.
the option key name.
the option's description
Creates example for command.
the example text.
Creates example using namespace.
assign namespace to example.
the example text.
Executes a command's action handler manually.
a parsed result to pass to command action.
Loads a config at the parsed path specified in arguments.
the name of the option key.
Gets specific keys from loaded config.
the name of the option key.
specific keys to get on load.
Extends result with this static object at this option.
the name of the option key.
a static object to be extended to result.
Sets command as an external command using existing command name.
Sets command in path as an external command.
an external command to assign this command to.
Sets command using existing command name as an external command with spawn options.
spawn options to use when spawning command.
Sets command as an external command using specified command in path with options.
an external command in path to assign this command to.
spawn options to use when spawning command.
Adds a flag by parsable tokens.
the token to be parsed as flag option.
Adds a flag to command using config object.
the name of the option to create.
the option configuration object.
Adds a flag to the command.
the name of the option.
the description for the option.
Adds a flag to the command.
the name of the option.
the description for the option.
an action to call on flag option. (Default Command ONlY)
Adds a flag to the command.
the name of the option.
the description for the option.
the option's type.
an action to call on flag option. (Default Command ONlY)
Adds a flag to the command.
the name of the option.
the description for the option.
the option's type.
a default value.
an action to call on flag option. (Default Command ONlY)
Adds multiple args to command from an array.
@ .flags('force', 'status', ...); .flags('--tags [string]', '--age [number]');
Enables help for this command using defaults.
Enables command help by specifying custom help text overrides child help.
a custom help string to display for this command.
Enables or disables command help overrides child help.
enables/disables help for this option.
Enables help by specifying custom help text, optionally sets help for option. Passes the current command and instance, overrides child help.
synchronous function for generating help.
Enables help by specifying custom help text.
the option key to bind to.
a custom help string to display for this option.
Enables or disables help for the specifed option.
the option key to bind to.
enables/disables help for this option.
Enables help by specifying custom help text, optionally sets help for option.
the option key to bind to.
synchronous function for generating help.
The maximum args allowed for the command.
the count number.
The maximum flags allowed for the command.
the count number.
The minimum args allowed for the command.
the count number.
The minimum flags allowed for the command.
the count number.
Assigns option keys as type of number.
the option keys to assign.
Adds multiple options using map of key and KawkahOption objects. To specify an argument option set "index" to -1.
@ .options({ name: { type: 'string' } }); .options({ path: { type: 'string', index: true } });
object of KawkahOptions.
Sets specified option as required.
the option key name.
enable/disable required option.
Enables validation skip for this command.
Skips all validation for this command.
bool value to enable/disable.
Sets validation skip for the specified option.
the option key name.
Sets validation skip for the specified option.
the option key name.
enable/disable skip.
Toggles spreading action args in positional order, missing args are null.
@ { _: ['file', 'dir', null ]} >> .action(file, dir, null, result) {}
bool value indicating if should spread args.
Assigns option keys as type of string.
the option keys to assign.
Sets the type for an option.
the option name to be set.
the type to be set.
Sets validation for option using RegExp.
the option key name.
regular expression to validate with.
Sets validation for option using config object.
the option key name.
Sets validation for option using function.
the option key name.
function used to validate result.
Sets argument as variadic.
the option key name.
Sets argument as variadic by boolean or count of args.
the option key name.
boolean or a count of args.
Generated using TypeDoc
Creates option flag or option arg.
NOTE: if tokens are passed the name is parsed in this case --user.name will be seen as user with alias name when not using tokens e.g. user.name it is seen as a named config for a nested property.