Parameters to create an instance of the Command Processor. Contains the command definition (for the command being executed) and help, profiles, etc.

export
interface

  ICommandProcessorParms

### Hierarchy

- ICommandProcessorParms

## Index

### Properties

- commandLine
- config
- daemonContext
- definition
- envVariablePrefix
- fullDefinition
- helpGenerator
- promptPhrase
- rootCommandName

## Properties

### commandLine

commandLine: string

- Defined in @zowe/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts:48

The command line.

memberof

  ICommandProcessorParms

### Optional config

config: Config

- Defined in @zowe/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts:73

Config object used to load profiles from active config layers.

memberof

  ICommandProcessorParms

### Optional daemonContext

daemonContext: IDaemonContext

- Defined in @zowe/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts:79

The context object defined when in daemon mode.

memberof

  ICommandProcessorParms

### definition

definition: ICommandDefinition

- Defined in @zowe/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts:30

The command definition node for the command being executed. The command definition is assumed to have a handler (or handlers).

memberof

  ICommandProcessorParms

### envVariablePrefix

envVariablePrefix: string

- Defined in @zowe/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts:54

Environmental variable name prefix used to construct configuration environmental variables.

memberof

  ICommandProcessorParms

### Optional fullDefinition

fullDefinition: ICommandDefinition

- Defined in @zowe/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts:60

All ancestors (parents) of the command definition for the command being executed. Used in help generation.

memberof

  ICommandProcessorParms

### helpGenerator

helpGenerator: IHelpGenerator

- Defined in @zowe/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts:36

The help generator for the command being executed.

memberof

  ICommandProcessorParms

### promptPhrase

promptPhrase: string

- Defined in @zowe/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts:66

The phrase used to indicate the user wants to enter the value of an argument in a hidden text prompt

memberof

  ICommandProcessorParms

### rootCommandName

rootCommandName: string

- Defined in @zowe/imperative/src/cmd/src/doc/processor/ICommandProcessorParms.ts:42

The root command name for the CLI - used in help generation, etc.

memberof

  ICommandProcessorParms

Generated using TypeDoc