Construct the yargs command instance for imperative. Provides the ability to define Imperative commands to Yargs.
Parameter object contains parms for Imperative/Yargs and command response objects
Parameter object contains parms for Imperative/Yargs and command response objects
TODO: REMOVE THIS, workaround for yargs.fail() problem
Accessor for the command line
Returns a copy of the definition.
: A copy of the definition.
Accessor for the Environmental variable prefix
Accessor for the help generator factory.
Get the array of parents.
: The array of parents.
Accessor for the profile manager factory
Accessor for the CLI prompt phrase
Accessor for the command response parms (for subclasses)
Accessor for the root command name for the CLI
Returns the Yargs instance.
: The Yargs instance.
Construct the positional argument string for Yargs. The positional arguments are always constructed as "optional" to yargs. This prevents yargs from "throwing errors" if the user requests --help and the positional parameters are not specified.
: The positional argument string used in the Yargs command definition.
Construct the Bright command definition "tree" - the full definition document including all parents.
: The command definition "tree".
Define the Imperative JSON command definition to Yargs. Once the command is defined, Yargs will parse and invoke its 'handler' (below). The handler can then invoke the potential "chain" of handlers in sequence and is notified when they complete via a promise.
Callback invoked when a command execution is complete.
Execute the help Command for the definition.
Execute the web help Command for the definition.
Get examples for all commands of a group
Build The Bright Yargs response for the callback. Includes the Bright command response and status info.
Invoke the "chain" of command handlers provided for this definition.
: The promise to be fulfilled when all handlers are complete.
Define the options to Yargs.
Generated using TypeDoc
Define an Imperative Command to Yargs. A command implies that an implementation is present (differs from a "group") and it does not have children.