Sets abort status.
bool indicating aborting/exiting.
Gets actionable options for a command. Currently only supports default command.
the command name or command.
Gets array of argument option keys.
the command name.
Builds help menu by groups, when no groups specified builds default.
the groups to build help for.
Command to key finds a corresponding pirmary key from alias.
the alias to be mapped to primary command name.
a default value if alias is not defined.
Dispatches an error.
an error to be dispatched.
Dispatches a notify event using formatted message.
a message to be dispatch.
array of args for formatting the message.
Dispatches an event using formatted message.
the event type to dispatch.
the message or error to be dispatched.
an array of arguments to use in formatting.
Dispatches an error message.
the message to be logged.
optional array of arguments for formatting.
Exits the process.
the exit code if any.
Gets array of flag option keys.
the command name.
Gets a command using it's name or alias.
the name of the command or command alias to get.
a default command if fails to find primary.
Resolves completions returning matches.
an object containing the word, point and current line.
Gets a completions query from env vars or generated from line.
the optional line to build query from.
Gets example for default command.
the example name to lookup.
Gets the footer.
Normalizes namespaces for groups.
the name to lookup and normalize.
Gets the header.
Gets help if enabled.
a group or array of group strings.
Gets options by dot notation or lookup.
the name, alias or command.option key.
Gets an option from a command options.
the command the option belongs to if known.
the name or alias of the option to get.
Gets the current help theme object.
Gets/builds the usage string.
the command to build usage for.
Adds options to help groups by scheme set in options.
Adds command and options to help groups by scheme.
the command to be parsed/added to groups.
Adds collection of commands and options to help groups by scheme.
the commands to iterate and add to help groups.
Groupify example.
the name of the example.
Handles displaying help.
groups to display help for.
Default log handler.
the type of message to log.
the message to be logged.
Checks if command exists in collection.
the command name to check.
Checks if flag name conflicts with global flag.
the name of the flag option.
Lists groups and their contents.
the group names to be listed.
Listens for commands, parses specified args or uses process.argv.
string or array of args.
Logs an empty line.
Logs an error.
the error to be logged.
Logs a message with optional formatting.
a message to be logged.
rest param of arguments used in formatting.
Logs a message by type.
a log event type.
a message to be logged.
rest param of arguments used in formatting.
Merge command with update source.
the old command to merge from.
the new command to merge to.
Merge an and option with existing target.
the old options object.
the new options object.
the associated command.
Gets or sets the application name overwriting generated value.
the name of the application.
Normalizes object of AnsiStyles.
an object map of styles.
Normalizes to an AnsiStyles.
the style to normalize.
Dispatches a notification message.
the message to be logged.
optional array of arguments for formatting.
Dispatches an ok message.
the message to be logged.
optional array of arguments for formatting.
Iterates a collection of options mapping an alias to the primary key.
the key or alias to find.
the collection of options to inspect.
Parses arguments using specified args or uses process.argv.
string or arguments to parse.
Reindexes command args setting correct "index" for arg's config.
the command to reindex.
Removes a command from the collection.
the command to be removed.
Removes an example from the collection.
the name of the example to be removed.
Removes a group from the collection.
the name of the group to be removed.
Removes key from a group's items or all instances of key in any group.
the optional group to remove key from.
Purges any groups by name and cleans any groups which contain key in items.
the name of the group to be removed.
Remove an option from a command.
the command name.
the name of the option to remove.
Gets array of keys used to exclude result keys leaving only option keys.
Enables about option/feature with defaults.
Enables or disables about option/feature.
boolean enable/disables about.
Enables about feature optionally sets the option and description to be used.
the option name for displaying command about.
the option description to display in help.
Sets the catch handler when no command is found.
the function to use for handling catch.
Sets command using only usage tokens.
the usage tokens for the command.
Sets a command by configuration.
the name of the command to be updated.
a command configuration object.
Sets command by command name and usage string.
the name of the command.
the usage string.
Sets a value by key in command.
the name of the command setting to be updated.
the key in the command object to be updated.
the value to be updated.
Adds tab completions to your app using all defaults.
Adds tab completions with defaults or disables.
enables with defaults or disables completions.
Adds tab completions to app with custom name.
the name of the completions command.
Adds tab completions to app with name and custom handler function for generating completions.
the name of the completions command.
optional custom handler for building completions.
Adds tab completions to your app with named completions command, custom description, custom handler and bash script template.
the name of the completions command.
the help description for completions.
optional custom handler for building completions.
a custom template for generating completions script.
Stores example text.
the name of the example.
the example text.
Sets the footer.
the footer text.
Sets a group's visibility.
the name of the group to be set.
toggles visibility for the group.
Sets a group using configuration file.
the name of the group to be set.
the group's configuration.
Sets a group's items.
the name of the group to be set.
array of items to bind to the group.
Sets group by command binding options or filtered options.
the name of the group to be set.
true or array of option keys to include.
Sets the header.
the header text.
Enables help with defaults.
Toggles help option enabled or disabled.
bool value to enable/disable help.
Enables help with default option using custom help handler.
help handler callback function.
Enables help with custom option(s) names with optional help handler.
a string or array of string option names.
optional help handler method for displaying help.
Enables help with custom option(s) names with optional help handler.
a string or array of string option names.
the description for help option.
optional help handler method for displaying help.
Sets the log handler or uses default.
a log handler function.
Sets an option by usage.
the command which contains the option.
Sets an option by config object..
the command which contains the option.
the name of the option to update.
the configuration object to extend with.
Sets an option by using name and simple transform type.
the command which contains the option.
the name of the option to update.
the transform type to create the option with.
Sets an option value by key.
the command which contains the option.
the name of the option to update.
the key within the option to be updated.
the key's value to be updated.
Sets a theme for styling help.
the theme name or object containing styles.
When true and --trace is present in args enabled/disable stack tracing for errors.
Sets version option with all defaults.
Sets version with custom version value.
the value to set version to.
Enables or disables version.
bool value to enable/disable version.
Sets version with custom option keys with description and custom version.
the option keys to use for version.
the description for help.
a custom value to set version to.
Calls the catch handler which shows help.
Calls help handler if enabled.
optional group or groups to show help for.
Spawns a child process.
the command to spawn.
the arguments to apply to command.
the spawn options for the child process.
Takes a parsed result containing a command and then calls spawn.
the parsed result.
an action callback on child close.
Normalizes command ensuring correct values and defaults.
the command to normalize.
Normalize option ensuring correct values and defaults.
the option or name of new option to normalize.
the command the option belongs to.
Normalizes option when option is passed as a string name or type.
a string or option object.
Validates the event running middleware on the result.
the event containing result and command objects.
Runs validation middleware.
the current processed value.
the current key.
the active event.
Verifies the option and it's properties are valid.
the option to verify as valid.
the option's command.
Dispatches a warning message.
the message to be logged.
optional array of arguments for formatting.
Writes message to output stream with optional wrap.
the message to be output.
when true message is wrapped in new lines.
Generated using TypeDoc
Gets abort status