: The api object.
Retrieve the command line.
Set the command line (needed for daemon where command changes and is not static)
Returns the default console object to be used for messaging for imperative fails to initialize or to be used before logging is initialized.
: an instance of the default console object
Get the configured environmental variable prefix for the user's CLI
Get the complete full command tree
Get log instance
Retrieve the root command name.
Append any auto generated commands to the root command document depending on configuration.
the root command as built so far
Construct the API object for return to caller of init()
: The API object
Build the Logger API object for the app using the framework
: returns the app Logger API object
Build the default console API object for the framework
: returns the default console Logger API object
Build the imperative API object for the app using the framework
: returns the imperative Logger API object
Define to yargs for main CLI and plugins
The Root of the imperative host CLI which has already prepared by ImperativeConfig.getPreparedCmdTree.
Get the configured help generator for your CLI. If you have not specified a custom generator, the DefaultHelpGenerator will be used. You probably won't need to call this from your CLI, but it is used internally.
parameters to the help generator including command definition
Get imperative's host CLI command tree after final preparation.
The imperative command tree returned by Imperative.getResolvedCmdTree()
An optional base profile to add to command definitions
the profile type to search for configuration for
The profile configuration if found, otherwise, undefined.
Get imperative's host CLI command tree with all module globs resolved.
The resolved command tree
Highlight text with your configured (or default) primary color
the text to highlight
Highlight text with your configured (or default) secondary color
the text to highlight
Initialize the configuration for your CLI. Wipes out any existing config that has already been set.
A promise indicating that we are done here.
Load the correct AppSettings instance from values located in the cli home folder.
Init log object such that subsequent calls to the Logger.getImperativeLogger() (or other similar calls), will contain all necessary categories for logging.
TODO(Kelosky): handle level setting via global config (trace enabling and such)
Initialize the profiles directory with types and meta files. This can be called every startup of the CLI without issue, but if the meta files or configuration changes, we'll have to re-initialize. TODO: Determine the re-initialize strategy.
The configuration document passed to init.
Parse command line arguments and issue the user's specified command
this, for chaining syntax
Generated using TypeDoc
Returns the imperative API object containing various framework API methods for usage in your CLI implemenation.