Automatically called by CLI.runFromArgs
The initialized logger for the CLI
A promise to be resolved once the command completes / fails
Command alias/es if applicable (alternative ways to invoke it)
The CLI run logger
The command name (this is the way to invoke it)
The completion promise to invoke when done
Command help text description
Command specific parameter parsing
The shared command args from CLI.addSharedOptions as passed from CLI.runFromArgs
Produces a string representation of the command arguments to be logged WARNING - if not overridden and adjusted, this may leak confidential data to the logs
The command parsed args
The string to report (return undefined to skip the report)
The actual command execution
The final command args from buildCommandArgs
The command result (will be propagated via {@see completionPromise})
Run post-command teardown Will be called even if pre-command throws and the main command execution is skipped Thrown errors will fail the command
The current execution phase
The error thrown by the command (if applicable)
Run pre-command setup Thrown errors will skip main command execution and fail the command
Automatically called by CLI.runFromArgs
Returns as yargs compliant command facade
A standard yargs command module
Generated using TypeDoc
Abstract CLI command construct
Extend this class to write your own commands