Properties

Property	Required	Type(s)	Default	Description
name	Y	string		Command name
command	N	string		Subcommand name
description	N	string		Command description
version	N	string		Command version
arguments	N	object/array		Argument handler
options	N	array		List of options
flags	N	array		List of flags
prompts	N	array		List of prompts
subcommands	N	array/object		List of subcommands
promptTypes	N	object		List of custom prompt types
autoHelp	N	boolean	false	Toggle for automated help menu
autoVersion	N	boolean	false	Toggle for automated version output
silent	N	boolean	false	Toggle for output suppression
transform	N	function		Method to transform data
action	N	function		Method to process data

name: string
command?: string
description?: string
version?: string
arguments?: CommandArgumentProps | CommandArgumentProps[]
options?: CommandOptionProps[]
flags?: CommandFlagProps[]
prompts?: CommandPromptProps[]
subcommands?: 
  Array<CommandProps | Command | typeof Command> 
  | {[key:string]: CommandProps | Command | typeof Command}
promptTypes?: {[key:string]: PromptConstructor}
autoHelp?: boolean
autoVersion?: boolean
silent?: boolean
transform?: (data: CommandData) => Promise<CommandData>
action?: (data: CommandData, details: CommandData) => Promise<any | void>

name

(required) The name of the command. Doubles as the subcommand if command is not set.

See Properties.name for more information

command

The callable command if set as a subcommand. Defaults to value of name.

See Properties.command for more information

description

Description of the command. Shows up in the --help menu.

See Properties.description for more information

version

Semantic version of the command. Shows up when user calls the command with the --version flag. Usually only set on primary command, but can be set on any command.

See Properties.version for more information

arguments

Handler for unnamed parameters. Can be an object or an array. Does not work with subcommands.

See Properties.arguments for more information

options

List of named parameters with values.

See Properties.options for more information

flags

List of flag parameters (named with no value).

See Properties.flags for more information

prompts

List of questions to ask the user. Can be tied to other parameters.

See Properties.prompts for more information

subcommands

List of subcommands that can be called as an argument. Does not work with arguments.

See Properties.subcommands for more information

promptTypes

List of plugins to create new types of prompts.

See Properties.promptTypes for more information

autoHelp

Toggle for automated --help flag.

See Properties.autoHelp for more information

autoVersion

Toggle for automated --version flag.

See Properties.autoVersion for more information

silent

Toggle for output functions like log(), out(), error(), heading() and spacer().

See Properties.silent for more information

transform

Method to transform data before calling action(). The data object is passed and must be returned with the final values.

See Properties.transform for more information

action

Method called to process data. Both data and details objects are passed.

See Properties.action for more information