# Imperative CLI Framework

Imperative CLI Framework is a command processing system that lets you quickly build customized command-line interfaces. Focus on adding functionality for your users rather than creating CLI infrastructure. We provide you with all the tools to get started building your own CLI plug-ins.

## Software Requirements

- Install Node.js package manager on your computer. Node.js® is a JavaScript runtime environment on which we architected Imperative CLI Framework.

- You must have a means to execute ".sh" (bash) scripts to run integration tests. On Windows, you can install "Git Bash", which is bundled with the standard Git installation - (choose the "Use Git and Unix Tools from Windows Command Prompt" installation option). When you run the integration tests on Windows, you must have Administrative authority to enable the integration tests to create symbolic links.

Note: Broadcom Inc. does not maintain the prerequisite software that Imperative CLI Framework requires. You are responsible for updating Node.js and other prerequisites on your computer. We recommend that you update Node.js regularly to the latest Long Term Support (LTS) version.

## Install Imperative as a Dependency

Issue the following commands to install Imperative CLI Framework as a dependency.

- Install `@latest` version:

  Be aware that if you update via `@latest`, you accept breaking changes into your project.

      npm install @zowe/imperative

- Install `@zowe-v2-lts` version:

  This is a Long Term Support release that is guaranteed to have no breaking changes.

      npm install @zowe/imperative@zowe-v2-lts

Note: If you want to install the bleeding edge version of Imperative, you can append `--@zowe:registry=https://zowe.jfrog.io/zowe/api/npm/npm-release/` to the install command to get it from a staging registry. It is not recommended to use this registry for production dependencies.

### Build and Install Imperative CLI Framework from Source

To build and install the Imperative CLI Framework, follow these steps:

1. Clone the `zowe/imperative` project to your PC.
2. From the command line, issue `cd [relative path]/imperative`
3. Issue `npm install`
4. Issue `npm run build`
5. Issue `npm run test`

To build the entire project (including test stand-alone CLIs): `npm run build`

To build only imperative source: `npm run build:packages`

### Run Tests

Command | Description
--- | ---
`npm run test` | Run all automated tests (unit & integration)
`npm test:unit` | Run unit tests
`npm test:integration` | Run integration tests
`npm test:system` | Run system tests (requires IPv6 connection)

Note: To build and install the test CLIs used by the integration tests:

1. `node scripts/sampleCliTool.js build`
2. `node scripts/sampleCliTool.js install`

### Sample Applications

We provide a sample plug-in that you can use to get started developing your own plug-ins. See the Zowe CLI Sample Plug-in.

## Documentation

We provide documentation that describes how to define commands, work with user profiles, and more! For more information, see the Imperative CLI Framework wiki.

## Contribute

For information about how you can contribute code to Imperative CLI Framework, see CONTRIBUTING.

## Submit an Issue

To report a bug or request an enhancement, please submit an issue.

## Versioning

Imperative CLI Framework uses Semantic Versioning (SemVer) for versioning. For more information, see the Semantic Versioning website.

## Licensing Imperative CLI Framework

For Imperative CLI Framework licensing rules, requirements, and guidelines, see LICENSE.

## Index

### Enumerations

- ConvertMsgFmt
- DeferredPromiseStatus
- EventTypes
- GuiResult
- IProcessorTypes
- IssueSeverity
- ItemId
- ProfLocType
- PropUse
- TaskStage
- ZoweSharedEvents
- ZoweUserEvents

### Classes

- AbstractAuthHandler
- AbstractCommandBuilder
- AbstractCommandYargs
- AbstractCredentialManager
- AbstractHelpGenerator
- AbstractHelpGeneratorFactory
- AbstractPluginLifeCycle
- AbstractRestClient
- AbstractSession
- AppSettings
- AuthCommandBuilder
- AuthLoginCommandBuilder
- AuthLogoutCommandBuilder
- AuthOrder
- AutoInitCommandBuilder
- AutoInitConstants
- BadCredentialManagerError
- BaseAuthHandler
- BaseAutoInitHandler
- BufferBuilder
- Censor
- ChainedHandlerService
- CliUtils
- CommandPreparer
- CommandProcessor
- CommandResponse
- CommandUtils
- CommandYargs
- CompleteAuthGroupBuilder
- CompleteAutoInitCommandBuilder
- CompressionUtils
- Config
- ConfigApi
- ConfigAutoStore
- ConfigBuilder
- ConfigConstants
- ConfigLayers
- ConfigManagementFacility
- ConfigPlugins
- ConfigProfiles
- ConfigSchema
- ConfigSecure
- ConfigUtils
- ConfigurationLoader
- ConfigurationValidator
- ConnectionPropsForSessCfg
- Console
- Constants
- ConvertMsg
- ConvertProfilesHandler
- ConvertV1Profiles
- CredentialManagerFactory
- CredentialManagerOverride
- DaemonRequest
- DefaultCredentialManager
- DefaultHelpGenerator
- DefaultRootCommandHandler
- DeferredPromise
- DefinitionTreeResolver
- DiffUtils
- EditHandler
- EnvFileUtils
- EnvQuery
- EnvironmentalVariableSettings
- Event
- EventOperator
- EventProcessor
- EventUtils
- ExecUtils
- FailedCommandHandler
- FirststepsHandler
- GroupCommandYargs
- HandlerResponse
- Headers
- HelpConstants
- HelpGeneratorFactory
- IO
- Imperative
- ImperativeApi
- ImperativeConfig
- ImperativeError
- ImperativeExpect
- ImperativeHelpGeneratorFactory
- ImportHandler
- InitHandler
- InstallHandler
- InvalidCredentialManager
- JSONSettingsFilePersistence
- JSONUtils
- JsUtils
- ListHandler
- Logger
- LoggerConfigBuilder
- LoggerManager
- LoggerUtils
- LoggingConfigurer
- NextVerFeatures
- NpmRegistryUtils
- Operation
- Operations
- OptionConstants
- OverridesLoader
- PMFConstants
- PluginIssues
- PluginManagementFacility
- PluginRequireAlreadyCreatedError
- PluginRequireNotCreatedError
- PluginRequireProvider
- ProcessUtils
- ProfInfoErr
- ProfileCredentials
- ProfileInfo
- ProfileUtils
- ProfilesConstants
- ProfilesHandler
- ProxySettings
- ReportEnvHandler
- RestClient
- RestClientError
- RestConstants
- RestStandAloneUtils
- SchemaHandler
- SecureHandler
- Session
- SetHandler
- SettingsAlreadyInitialized
- SettingsNotInitialized
- SharedOptions
- SyntaxValidator
- TaskProgress
- TextUtils
- UninstallHandler
- UpdateHandler
- UpdateImpConfig
- UpdateSchemasHandler
- V1ProfileRead
- ValidateHandler
- WebDiffManager
- WebHelpGenerator
- WebHelpManager
- YargsConfigurer
- YargsDefiner

### Interfaces

- IApimlSvcAttrs
- IArgTeamConfigLoc
- IAuthCache
- IAuthHandlerApi
- ICensorOptions
- IChainedHandlerArgumentMapping
- IChainedHandlerEntry
- ICommandArguments
- ICommandDefinition
- ICommandDefinitionPassOn
- ICommandDefinitionPassOnIgnore
- ICommandExampleDefinition
- ICommandHandler
- ICommandHandlerRequire
- ICommandHandlerResponseChecker
- ICommandHandlerResponseValidator
- ICommandOptionAllowableValues
- ICommandOptionDefinition
- ICommandOptionValueImplications
- ICommandOutputFormat
- ICommandPositionalDefinition
- ICommandProcessorParms
- ICommandProfile
- ICommandProfileAuthConfig
- ICommandProfileAutoInitConfig
- ICommandProfileLoaderParms
- ICommandProfileProperty
- ICommandProfileSchema
- ICommandProfileTypeConfiguration
- ICommandResponse
- ICommandResponseApi
- ICommandResponseParms
- ICommandTreeEntry
- ICommandValidatorError
- ICommandValidatorResponse
- IConfig
- IConfigAutoStoreFindActiveProfileOpts
- IConfigAutoStoreFindAuthHandlerForProfileOpts
- IConfigAutoStoreStoreSessCfgPropsOpts
- IConfigBuilderOpts
- IConfigLayer
- IConfigLogging
- IConfigMergeOpts
- IConfigOpts
- IConfigProfile
- IConfigSchema
- IConfigSchemaInfo
- IConfigUpdateSchemaHelperOptions
- IConfigUpdateSchemaOptions
- IConfigUpdateSchemaPaths
- IConfigVault
- IConsole
- IConvertV1ProfOpts
- IConvertV1ProfResult
- ICredentialManagerInit
- ICredentialManagerNameMap
- IDaemonContext
- IDaemonRequest
- IDaemonResponse
- IDiffNameOptions
- IDiffOptions
- IEmitter
- IEmitterAndWatcher
- IEventDisposable
- IEventJson
- IExplanationMap
- IGetAllProfilesOptions
- IGetItemOpts
- IGetItemVal
- IHTTPSOptions
- IHandlerFormatOutputApi
- IHandlerParameters
- IHandlerProgressApi
- IHandlerResponseApi
- IHandlerResponseConsoleApi
- IHandlerResponseDataApi
- IHeaderContent
- IHelpGenerator
- IHelpGeneratorFactory
- IHelpGeneratorFactoryParms
- IHelpGeneratorParms
- IImperativeApi
- IImperativeAuthGroupConfig
- IImperativeConfig
- IImperativeEnvironmentalVariableSetting
- IImperativeEnvironmentalVariableSettings
- IImperativeError
- IImperativeErrorParms
- IImperativeLoggingConfig
- IImperativeLogsConfig
- IImperativeVersions
- IInvokeCommandParms
- ILog4jsAppender
- ILog4jsConfig
- ILog4jsLayout
- IMessageDefinition
- IMetaProfile
- INewFirstAuthsOnDiskOpts
- INewFirstAuthsOpts
- INpmInstallArgs
- INpmRegistryInfo
- IOperationResult
- IOptionFormat
- IOptionsForAddConnProps
- IOptionsFullResponse
- IOverridePromptConnProps
- IPartialCommandDefinition
- IPluginCfgProps
- IPluginIssue
- IPluginIssues
- IPluginJson
- IPluginJsonObject
- IPluginPeerDepends
- IProbTest
- IProfArgAttrs
- IProfAttrs
- IProfInfoErrParms
- IProfInfoRemoveKnownPropCommonOpts
- IProfInfoRemoveKnownPropOpts
- IProfInfoUpdateKnownPropOpts
- IProfInfoUpdatePropCommonOpts
- IProfInfoUpdatePropOpts
- IProfLoc
- IProfLocOsLoc
- IProfLocOsLocLayer
- IProfMergeArgOpts
- IProfMergedArg
- IProfOpts
- IProfile
- IProfileDependency
- IProfileLoaded
- IProfileManager
- IProfileProperty
- IProfileSchema
- IProfileTypeConfiguration
- IProgressBarParms
- IPromiseWithProgress
- IPromptOptions
- IPropsToPromptFor
- IQueuedMessage
- IRestClientError
- IRestClientResponse
- IRestOptions
- ISession
- ISettingsFile
- ISettingsFilePersistence
- ISystemInfo
- ITaskWithStatus
- ITreeNode
- IWatcher
- IWebDiffGenerator
- IWebDiffManager
- IWebHelpManager
- IWebHelpPackageMetadata
- IWebHelpTreeNode
- IYargsParms
- IYargsResponse
- ProxyVariables

### Type aliases

- AUTH_TYPE_CHOICES
- AppenderWithPatternLayout
- AppenderWithType
- CLIENT_PROPERTY
- COMMAND_RESPONSE_FORMAT
- CommandOptionType
- CommandSegment
- ConsoleLevels
- ContentEncoding
- EventCallback
- HTTP_PROTOCOL_CHOICES
- HTTP_VERB
- IAddProfTypeResult
- ICommandHandlerConstructor
- ICommandNodeType
- IConfigSecure
- IConfigSecureProperties
- IConstructor
- ICredentialManagerConstructor
- IExtenderTypeInfo
- IExtendersJsonOpts
- IImperativeOverrides
- IOperationCompleted
- IOperationResultReady
- IOperationUndoCompleted
- IProfArgValue
- IProfDataType
- ImperativeReject
- ImperativeYargsCommandAction
- OUTPUT_FORMAT
- PatternLayout
- RestClientResolve
- RestErrorSource
- SecureCredential
- SecureOperationFunction
- TOKEN_TYPE_CHOICES
- YargsCommandCompleted

### Variables

- ALL_TOKEN_TYPES
- AUTH_TYPE_BASIC
- AUTH_TYPE_BEARER
- AUTH_TYPE_CERT_PEM
- AUTH_TYPE_NONE
- AUTH_TYPE_TOKEN
- ClipboardJS
- HTTPS_PROTOCOL
- HTTP_PROTOCOL
- TOKEN_TYPE_APIML
- TOKEN_TYPE_JWT
- TOKEN_TYPE_LTPA
- aliasList
- clipboard
- completionTimeoutErrorMessage
- currentNodeId
- currentView
- footerStr
- headerStr
- isInIframe
- links
- loggerUtilsRequire
- probTests
- sameOrigin
- scrollIntoView
- searchTimeout
- treeNodes
- urlParams

### Functions

- arrayFrom
- changeView
- compareCommands
- defaultPrintfFormat
- findCurrentCmdAnchor
- findNpmOnPath
- flattenNodes
- getJstreeThemeName
- getPackageInfo
- hasPatternLayout
- install
- installPackages
- isAppenderWithType
- isPatternLayout
- loadTree
- log4jsConfigToWinstonConfig
- mapLog4jsToDayjsFormat
- onDocsPageChanged
- onSearchTextChanged
- onTreeContextMenu
- onTreeLoaded
- onTreeSearch
- onTreeSelectionChanged
- permuteSearchStr
- runValidatePlugin
- setTooltip
- toggleTree
- translateLog4jsPattern
- uninstall
- update
- updateAndGetRemovedTypes
- updateCurrentNode
- updateExtendersJson

### Object literals

- MOCKED_COMMAND_TREE
- ReportEnvDefinition
- apiErrorHeader
- authCategoryDesc
- authCategorySummary
- authLoginCommandDesc
- authLoginGroupDesc
- authLoginGroupSummary
- authLoginShowTokenDesc
- authLogoutCommandDesc
- authLogoutGroupDesc
- authLogoutGroupSummary
- autoInitCommandDesc
- autoInitCommandSummary
- convertProfilesDefinition
- couldNotInstantiateCommandHandler
- customLevels
- editDefinition
- errorDetailsHeader
- firststepsDefinition
- importDefinition
- initDefinition
- installDefinition
- listDefinition
- onlyForTesting
- profilesDefinition
- schemaDefinition
- secureDefinition
- setDefinition
- syntaxErrorHeader
- unexpectedCommandError
- unexpectedCommandPreparationError
- uninstallDefinition
- updateDefinition
- updateSchemasDefinition
- validateDefinition

## Type aliases

### AUTH_TYPE_CHOICES

AUTH_TYPE_CHOICES: typeof AUTH_TYPE_NONE | typeof AUTH_TYPE_BASIC | typeof AUTH_TYPE_BEARER | typeof AUTH_TYPE_TOKEN | typeof AUTH_TYPE_CERT_PEM

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:69

type that specifies the choice of authentication types

### AppenderWithPatternLayout

AppenderWithPatternLayout: { layout: PatternLayout }

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:149

#### Type declaration

- ##### layout: PatternLayout

### AppenderWithType

AppenderWithType: { filename?: string; type: string }

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:273

#### Type declaration

- ##### Optional filename?: string

- ##### type: string

### CLIENT_PROPERTY

CLIENT_PROPERTY: "requestSuccess" | "requestFailure" | "data" | "dataString" | "response" | "session" | "log"

- Defined in @zowe/imperative/src/rest/src/client/types/AbstractRestClientProperties.ts:19

String type definition for properties of abstractRestClient that has a getter set. This can be safely used in a getter call as a variable for the abstractRestClient object.

export

### COMMAND_RESPONSE_FORMAT

COMMAND_RESPONSE_FORMAT: "json" | "default"

- Defined in @zowe/imperative/src/cmd/src/doc/response/api/processor/ICommandResponseApi.ts:18

The command response format type definition - currently only JSON or default (stdout/stderr) are supported.

export

### CommandOptionType

CommandOptionType: "array" | "boolean" | "count" | "existingLocalFile" | "json" | "number" | "string" | "stringOrEmpty"

- Defined in @zowe/imperative/src/cmd/src/doc/option/ICommandOptionDefinition.ts:26

The type of value that should be specified for an option by the user. "array": an array of space delimited strings "boolean": a switch - the user specifies: true "--option-name" or false: "--option-name false" "count" : accepting only whole numbers as input value "existingLocalFile": a file for which fs.existsSync returns true "json": a parseable JSON string "number" : accepting integers as input value "string" : string input that does not allow "" as a valid input value "stringOrEmpty" : allow string to be empty when defined

### CommandSegment

CommandSegment: "group" | "command"

- Defined in @zowe/imperative/src/cmd/src/utils/CommandUtils.ts:32

The command segment represents the "level" you are at in the command (for help generation)

### ConsoleLevels

ConsoleLevels: "trace" | "debug" | "info" | "warn" | "error" | "fatal" | "off"

- Defined in @zowe/imperative/src/console/src/Console.ts:23

### ContentEncoding

ContentEncoding: typeof CONTENT_ENCODING_TYPES[number]

- Defined in @zowe/imperative/src/rest/src/client/Headers.ts:27

### EventCallback

EventCallback: () => void | PromiseLike<void>

- Defined in @zowe/imperative/src/events/src/EventConstants.ts:23

#### Type declaration

- - (): void | PromiseLike<void>

  - #### Returns void | PromiseLike<void>

### HTTP_PROTOCOL_CHOICES

HTTP_PROTOCOL_CHOICES: typeof HTTP_PROTOCOL | typeof HTTPS_PROTOCOL

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:30

type that specifies the choice of protocols

### HTTP_VERB

HTTP_VERB: "GET" | "PUT" | "POST" | "DELETE"

- Defined in @zowe/imperative/src/rest/src/client/types/HTTPVerb.ts:12

### IAddProfTypeResult

IAddProfTypeResult: { info: string; success: boolean }

- Defined in @zowe/imperative/src/config/src/doc/IExtenderOpts.ts:44

#### Type declaration

- ##### info: string

- ##### success: boolean

### ICommandHandlerConstructor

ICommandHandlerConstructor: {}

- Defined in @zowe/imperative/src/cmd/src/doc/handler/ICommandHandlerConstructor.ts:18

This type is here so that we can indicate an object from a require can be instantiated.

#### Type declaration

### ICommandNodeType

ICommandNodeType: "group" | "command"

- Defined in @zowe/imperative/src/cmd/src/doc/ICommandDefinition.ts:24

Command Segment type - either "group" or "command".

"group" implies no handler and should have children. Use groups to logically arrange portions of your CLI. "command" implies there is a handler and may or may not have children.

### IConfigSecure

IConfigSecure: {}

- Defined in @zowe/imperative/src/config/src/doc/IConfigSecure.ts:14

#### Type declaration

- ##### [path: string]: IConfigSecureProperties

### IConfigSecureProperties

IConfigSecureProperties: {}

- Defined in @zowe/imperative/src/config/src/doc/IConfigSecure.ts:12

#### Type declaration

- ##### [key: string]: any

### IConstructor

IConstructor<T>: {}

- Defined in @zowe/imperative/src/interfaces/src/doc/IConstructor.ts:15

An type that defines a class constructor

#### Type parameters

- #### T

#### Type declaration

### ICredentialManagerConstructor

ICredentialManagerConstructor: {}

- Defined in @zowe/imperative/src/security/src/doc/ICredentialManagerConstructor.ts:24

This interface defines the constructor for a credential manager. This is used by the TypeScript compiler to verify that any class that wishes to be a Credential Manager adheres to the constructor arguments sent to it.

Your class will satisfy this interface when all the following are true:

1. Your class extends AbstractCredentialManager
2. Your constructor has less than or equal to the number of parameters specified in the interface
3. Your constructor has matching parameter types for all parameters accepted

#### Type declaration

### IExtenderTypeInfo

IExtenderTypeInfo: { schema: IProfileSchema; sourceApp: string }

- Defined in @zowe/imperative/src/config/src/doc/IExtenderOpts.ts:52

#### Type declaration

- ##### schema: IProfileSchema

- ##### sourceApp: string

### IExtendersJsonOpts

IExtendersJsonOpts: { profileTypes: Record<string, { from: string[]; latestFrom?: string; version?: string }> }

- Defined in @zowe/imperative/src/config/src/doc/IExtenderOpts.ts:30

This type corresponds to the `extenders.json` file stored in the CLI home directory.

Here is an example structure of what `extenders.json` could look like on disk:

    {
        "profileTypes": {
            "banana": {
                "from": ["@zowe/banana-for-zowe-cli", "Zowe Explorer Banana Extension"],
                "version": "v1.1.0",
                "latestFrom": "Zowe Explorer Banana Extension"
            }
        }
    }

#### Type declaration

- ##### profileTypes: Record<string, { from: string[]; latestFrom?: string; version?: string }>

### IImperativeOverrides

IImperativeOverrides: ConstructorOrString<ImperativeOverrides>

- Defined in @zowe/imperative/src/imperative/src/doc/IImperativeOverrides.ts:182

All of the Default Imperative classes that can be changed by your Imperative CLI app.

A plugin can also define overrides through the same means as an Imperative CLI app. When additional overrides provided by plugins are present, Imperative will favor those classes over ones provided by your application.

Whether you are defining an Imperative Plugin or an Imperative CLI app, all keys in this object are expected to be a class constructor or of type string.

- A class constructor will be instantiated directly from imperative with no additional work by the provider. (Assuming it is properly defined for the specific key)
- A string will trigger imperative to load the module before instantiating it.
  - If the string is absolute, nothing special happens.
  - If the string is relative, then imperative will base the load on a well known location depending on if it is a plugin provided override or base cli provided override.
    - For Imperative Plugins: The module is located relative to the packages default import path (e.g `require('package-name')`)
    - For Imperative CLI Apps: The module is located relative to the main entry point of your application

When defining the location of an overrides as a string, it must adhere to the following format. Otherwise Imperative will not be able to load the class.

Exporting an Anonymous Class

    export = class {
      // Code goes here
    };

Exporting a Named Class

    export = class YourOverridesClass {
      // Code goes here
    };

Using `module.exports` (Not preferred for TypeScript Users)

    class YourOverridesClass {
      // Code goes here
    }

    module.exports = YourOverridesClass;

see

  {@link ImperativeOverrides} for documentation on the available keys.

### IOperationCompleted

IOperationCompleted<T>: (output: T) => void

- Defined in @zowe/imperative/src/operations/src/Operation.ts:22

#### Type parameters

- #### T

#### Type declaration

- - (output: T): void

  - #### Parameters

    - ##### output: T

    #### Returns void

### IOperationResultReady

IOperationResultReady<T>: (output: T, operationResults: IOperationResult<any>) => void

- Defined in @zowe/imperative/src/operations/src/Operation.ts:28

#### Type parameters

- #### T

#### Type declaration

- - (output: T, operationResults: IOperationResult<any>): void

  - #### Parameters

    - ##### output: T

    - ##### operationResults: IOperationResult<any>

    #### Returns void

### IOperationUndoCompleted

IOperationUndoCompleted: () => void

- Defined in @zowe/imperative/src/operations/src/Operation.ts:25

#### Type declaration

- - (): void

  - #### Returns void

### IProfArgValue

IProfArgValue: string | number | boolean | string[] | object

- Defined in @zowe/imperative/src/config/src/doc/IProfArgAttrs.ts:18

The value for the argument

### IProfDataType

IProfDataType: "string" | "number" | "boolean" | "array" | "object"

- Defined in @zowe/imperative/src/config/src/doc/IProfArgAttrs.ts:15

The type of data for this property

### ImperativeReject

ImperativeReject: (error: ImperativeError) => void

- Defined in @zowe/imperative/src/interfaces/src/types/ImperativeReject.ts:16

Definition for a promise rejection method that provides an ImperativeError (or subclass)

#### Type declaration

- - (error: ImperativeError): void

  - #### Parameters

    - ##### error: ImperativeError

    #### Returns void

### ImperativeYargsCommandAction

ImperativeYargsCommandAction: "syntax validation" | "command handler invoked" | "help invoked"

- Defined in @zowe/imperative/src/cmd/src/yargs/doc/IYargsResponse.ts:16

Indicates the action performed.

### OUTPUT_FORMAT

OUTPUT_FORMAT: "list" | "table" | "string" | "object"

- Defined in @zowe/imperative/src/cmd/src/doc/response/response/ICommandOutputFormat.ts:35

The available format types for formatting of output.

# list

Formats the output data as a list of strings. If an array of objects is present in the output, each is stringified and printed on a newline.

# table

Formats the output data as a table using the properties as the column headers. You must ensure that the array of objects is homogeneous for the table to print properly.

# string

Formats the output data as a string. If the output data is an object/array it is stringified.

# object

Formats the output a prettified JSON object.

### PatternLayout

PatternLayout: { pattern: string; type: "pattern" }

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:148

#### Type declaration

- ##### pattern: string

- ##### type: "pattern"

### RestClientResolve

RestClientResolve: (data: string) => void

- Defined in @zowe/imperative/src/rest/src/client/AbstractRestClient.ts:40

#### Type declaration

- - (data: string): void

  - #### Parameters

    - ##### data: string

    #### Returns void

### RestErrorSource

RestErrorSource: "client" | "http" | "timeout"

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:14

### SecureCredential

SecureCredential: string

- Defined in @zowe/imperative/src/security/src/abstract/AbstractCredentialManager.ts:17

String credential

### SecureOperationFunction

SecureOperationFunction: (propNamePath: string, propValue?: any, optional?: boolean) => Promise<any>

- Defined in @zowe/imperative/src/cmd/src/types/SecureOperationFunction.ts:17

This type defines the signature for a function taht calls the credential manager. This is used by the TypeScript compiler to verify that any function that wants to call the credential manager have the necessary arguments sent to it.

#### Type declaration

- - (propNamePath: string, propValue?: any, optional?: boolean): Promise<any>

  - #### Parameters

    - ##### propNamePath: string

      The path to a child property

    - ##### Optional propValue: any

      The value of said property

    - ##### Optional optional: boolean

      Set to true if failure to find credentials should be ignored

    #### Returns Promise<any>

    - The processed value after the secure operation function runs

### TOKEN_TYPE_CHOICES

TOKEN_TYPE_CHOICES: typeof TOKEN_TYPE_LTPA | typeof TOKEN_TYPE_JWT | typeof TOKEN_TYPE_APIML

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:101

type that specifies the choice of token types

### YargsCommandCompleted

YargsCommandCompleted: (args: Arguments, response: IYargsResponse) => void

- Defined in @zowe/imperative/src/cmd/src/yargs/AbstractCommandYargs.ts:31

Callback that is invoked when a command defined to yargs completes execution.

#### Type declaration

- - (args: Arguments, response: IYargsResponse): void

  - #### Parameters

    - ##### args: Arguments

    - ##### response: IYargsResponse

    #### Returns void

## Variables

### Const ALL_TOKEN_TYPES

ALL_TOKEN_TYPES: string[] = [TOKEN_TYPE_APIML,TOKEN_TYPE_JWT,TOKEN_TYPE_LTPA]

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:92

list that specifies the choice of token types

### Const AUTH_TYPE_BASIC

AUTH_TYPE_BASIC: "basic" = "basic"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:41

Session type property value for basic authentication

### Const AUTH_TYPE_BEARER

AUTH_TYPE_BEARER: "bearer" = "bearer"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:46

Session type property value for bearer token authentication

### Const AUTH_TYPE_CERT_PEM

AUTH_TYPE_CERT_PEM: "cert-pem" = "cert-pem"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:58

Session type property value for certificate authentication, which uses a certificate file and key file.

### Const AUTH_TYPE_NONE

AUTH_TYPE_NONE: "none" = "none"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:36

Session type property value for no authentication

### Const AUTH_TYPE_TOKEN

AUTH_TYPE_TOKEN: "token" = "token"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:52

Session type property value for cookie token authentication, which uses a named token type.

### Const ClipboardJS

ClipboardJS: any

- Defined in @zowe/imperative/web-help/docs.ts:12

### Const HTTPS_PROTOCOL

HTTPS_PROTOCOL: "https" = "https"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:25

https protocol

### Const HTTP_PROTOCOL

HTTP_PROTOCOL: "http" = "http"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:20

http protocol

### Const TOKEN_TYPE_APIML

TOKEN_TYPE_APIML: "apimlAuthenticationToken" = "apimlAuthenticationToken"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:87

tokenType property value for an API Mediation Layer token

### Const TOKEN_TYPE_JWT

TOKEN_TYPE_JWT: "jwtToken" = "jwtToken"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:82

tokenType property value for a JWT token

### Const TOKEN_TYPE_LTPA

TOKEN_TYPE_LTPA: "LtpaToken2" = "LtpaToken2"

- Defined in @zowe/imperative/src/rest/src/session/SessConstants.ts:77

tokenType property value for IBM's LTPA2 token

### Const aliasList

aliasList: {}

- Defined in @zowe/imperative/web-help/tree.ts:25

#### Type declaration

- ##### [key: string]: string[]

### Const clipboard

clipboard: any = new ClipboardJS(".btn-copy")

- Defined in @zowe/imperative/web-help/docs.ts:71

### Const completionTimeoutErrorMessage

completionTimeoutErrorMessage: string = "The request exceeded the specified request completion timeout."

- Defined in @zowe/imperative/src/rest/src/client/doc/IRestClientError.ts:107

### Let currentNodeId

currentNodeId: string

- Defined in @zowe/imperative/web-help/tree.ts:29

### Let currentView

currentView: number = +(urlParams.get("v") === "1")

- Defined in @zowe/imperative/web-help/tree.ts:30

### Const footerStr

footerStr: string

- Defined in @zowe/imperative/web-help/tree.ts:23

### Const headerStr

headerStr: string

- Defined in @zowe/imperative/web-help/tree.ts:22

### Const isInIframe

isInIframe: boolean = window.location !== window.parent.location

- Defined in @zowe/imperative/web-help/docs.ts:26

### Const links

links: any = arrayFrom(document.getElementsByTagName("a"))

- Defined in @zowe/imperative/web-help/docs.ts:27

### Const loggerUtilsRequire

loggerUtilsRequire: any = (jest as any).requireActual("../LoggerUtils").LoggerUtils

- Defined in @zowe/imperative/src/logger/src/__mocks__/LoggerUtils.ts:15

### Const probTests

probTests: IProbTest[] = [{itemId: ItemId.NODEJS_VER,probExpr: "semver.satisfies('{val}', '<18.x || 19.x || 21.x || >=23.x')",probMsg: "Only Node.js versions 18, 20, and 22 are supported."},{itemId: ItemId.NPM_VER,probExpr: "semver.satisfies('{val}', '8.11.0 || 8.12.0')",probMsg: "NPM versions 8.11.0 and 8.12.0 cause SCS errors in some situations."},{itemId: ItemId.ZOWE_APP_LOG_LEVEL,probExpr: logLevelExpr,probMsg: formatLogLevelMsg("ZOWE_APP_LOG_LEVEL")},{itemId: ItemId.ZOWE_IMPERATIVE_LOG_LEVEL,probExpr: logLevelExpr,probMsg: formatLogLevelMsg("ZOWE_IMPERATIVE_LOG_LEVEL")}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/report-env/EnvItems.ts:68

The tests to check for problems that we run for environmental items. One ItemId can have multiple entries in the array, to check for different problems. When the probExpr is true, we have a problem, and we print the probMsg.

### Const sameOrigin

sameOrigin: string = window.location.protocol !== "file:" ? window.location.origin : "*"

- Defined in @zowe/imperative/web-help/docs.ts:28

### Const scrollIntoView

scrollIntoView: any

- Defined in @zowe/imperative/web-help/tree.ts:12

### Let searchTimeout

searchTimeout: number = 0

- Defined in @zowe/imperative/web-help/tree.ts:31

### Const treeNodes

treeNodes: ITreeNode[]

- Defined in @zowe/imperative/web-help/tree.ts:24

### Const urlParams

urlParams: URLSearchParams = new URLSearchParams(window.location.search)

- Defined in @zowe/imperative/web-help/tree.ts:28

## Functions

### arrayFrom

- arrayFrom(items: any): any[]

- - Defined in @zowe/imperative/web-help/docs.ts:15

  #### Parameters

  - ##### items: any

  #### Returns any[]

### changeView

- changeView(newMode: number): void

- - Defined in @zowe/imperative/web-help/tree.ts:340

  Change display mode of page

  #### Parameters

  - ##### newMode: number

    0 = Tree View, 1 = Flat View

  #### Returns void

### Const compareCommands

- compareCommands(a: ICommandDefinition, b: ICommandDefinition): number

- - Defined in @zowe/imperative/src/cmd/src/doc/ICommandDefinition.ts:26

  #### Parameters

  - ##### a: ICommandDefinition

  - ##### b: ICommandDefinition

  #### Returns number

### Const defaultPrintfFormat

- defaultPrintfFormat(__namedParameters: { level: string; message: unknown; timestamp: unknown }): string

- - Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:173

  #### Parameters

  - ##### __namedParameters: { level: string; message: unknown; timestamp: unknown }

    - ##### level: string

    - ##### message: unknown

    - ##### timestamp: unknown

  #### Returns string

### findCurrentCmdAnchor

- findCurrentCmdAnchor(): any

- - Defined in @zowe/imperative/web-help/docs.ts:79

  Find the currently scrolled to command anchor in iframe

  #### Returns any

  Element with tag

### findNpmOnPath

- findNpmOnPath(): string

- - Defined in @zowe/imperative/src/imperative/src/plugins/utilities/NpmFunctions.ts:32

  Common function that returns npm command as a string.

  #### Returns string

  command with npm path

### flattenNodes

- flattenNodes(nestedNodes: ITreeNode[]): ITreeNode[]

- - Defined in @zowe/imperative/web-help/tree.ts:38

  Generate flattened list of tree nodes

  #### Parameters

  - ##### nestedNodes: ITreeNode[]

    Node list for command tree

  #### Returns ITreeNode[]

  Flattened node list

### getJstreeThemeName

- getJstreeThemeName(): string

- - Defined in @zowe/imperative/web-help/tree.ts:58

  Get the preferred theme name for JSTree (light or dark).

  #### Returns string

  Theme name

### getPackageInfo

- getPackageInfo(pkgSpec: string): Promise<{ name: string; version: string }>

- - Defined in @zowe/imperative/src/imperative/src/plugins/utilities/NpmFunctions.ts:98

  Fetch name and version of NPM package that was installed

  #### Parameters

  - ##### pkgSpec: string

    The package name as specified on NPM install

  #### Returns Promise<{ name: string; version: string }>

### hasPatternLayout

- hasPatternLayout(appender: unknown): appender is AppenderWithPatternLayout

- - Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:163

  Type guard for log4js appender with a pattern layout.

  #### Parameters

  - ##### appender: unknown

  #### Returns appender is AppenderWithPatternLayout

### install

- install(packageLocation: string, registryInfo: INpmRegistryInfo, installFromFile?: boolean, verbose?: boolean): Promise<string>

- - Defined in @zowe/imperative/src/imperative/src/plugins/utilities/npm-interface/install.ts:89

  Common function that abstracts the install process. This function should be called for each package that needs to be installed. (ex: `sample-cli plugin install a b c d` -> calls install 4 times)

  todo

    work needs to be done to support proper sharing of the plugins.json. As of now local plugins can only be reinstalled on the same machine. (due to how the conversion to an absolute URI happens)

  #### Parameters

  - ##### packageLocation: string

    A package name or location. This value can be a valid npm package name or the location of an npm tar file or project folder. Also, git URLs are also acceptable here (basically anything that `npm install` supports). If this parameter is a relative path, it will be converted to an absolute path prior to being passed to the `npm install` command.

  - ##### registryInfo: INpmRegistryInfo

    The npm registry to use.

  - ##### Default value installFromFile: boolean = false

  - ##### Default value verbose: boolean = false

  #### Returns Promise<string>

  The name of the plugin.

### installPackages

- installPackages(npmPackage: string, npmArgs: INpmInstallArgs, verbose?: boolean): string

- - Defined in @zowe/imperative/src/imperative/src/plugins/utilities/NpmFunctions.ts:47

  Common function that installs a npm package using the local npm cli.

  #### Parameters

  - ##### npmPackage: string

    The name of package to install.

  - ##### npmArgs: INpmInstallArgs

  - ##### Default value verbose: boolean = false

  #### Returns string

  command response

### isAppenderWithType

- isAppenderWithType(appender: unknown, type: string): appender is AppenderWithType

- - Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:278

  Type guard for log4js appender with a specific type.

  #### Parameters

  - ##### appender: unknown

  - ##### type: string

  #### Returns appender is AppenderWithType

### isPatternLayout

- isPatternLayout(layout: unknown): layout is PatternLayout

- - Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:151

  #### Parameters

  - ##### layout: unknown

  #### Returns layout is PatternLayout

### loadTree

- loadTree(): void

- - Defined in @zowe/imperative/web-help/tree.ts:271

  Load command tree components

  #### Returns void

### log4jsConfigToWinstonConfig

- log4jsConfigToWinstonConfig(log4jsConfig: any, level: string, includeAppenders: string[]): LoggerOptions

- - Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:196

  Translates a log4js-style config to a winston LoggerOptions config. Supports basic "console" and "file" appenders. Handles basic log4js pattern layouts.

  #### Parameters

  - ##### log4jsConfig: any

    The full log4js configuration object.

  - ##### level: string

    The desired log level for this specific logger configuration.

  - ##### includeAppenders: string[]

    An array of appender names to include in the returned transports.

  #### Returns LoggerOptions

### mapLog4jsToDayjsFormat

- mapLog4jsToDayjsFormat(log4jsFormat: string): string

- - Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:45

  Maps log4js date formatting specifiers to dayjs format

  #### Parameters

  - ##### log4jsFormat: string

    The log4js date formatting to convert to dayjs format.

  #### Returns string

  The corresponding dayjs format.

### onDocsPageChanged

- onDocsPageChanged(e: any): void

- - Defined in @zowe/imperative/web-help/tree.ts:261

  Update selected node in command tree after new page loaded in iframe

  #### Parameters

  - ##### e: any

    Event object sent by postMessage

  #### Returns void

### onSearchTextChanged

- onSearchTextChanged(noDelay?: boolean): void

- - Defined in @zowe/imperative/web-help/tree.ts:241

  Search command tree after text in search box has changed

  #### Parameters

  - ##### Default value noDelay: boolean = false

    If true, searches instantly rather than delaying 250 ms

  #### Returns void

### onTreeContextMenu

- onTreeContextMenu(node: ITreeNode): {} | { collapseAll: object; expandAll: object }

- - Defined in @zowe/imperative/web-help/tree.ts:155

  Generate list of context menu items for a node

  #### Parameters

  - ##### node: ITreeNode

    Node that was right clicked

  #### Returns {} | { collapseAll: object; expandAll: object }

  List of context menu items containing labels and actions

### onTreeLoaded

- onTreeLoaded(): void

- - Defined in @zowe/imperative/web-help/tree.ts:212

  Update current node and search bar after command tree (re)loaded

  #### Returns void

### onTreeSearch

- onTreeSearch(permutedSearchStr: string, node: any): boolean

- - Defined in @zowe/imperative/web-help/tree.ts:183

  Check if node is matched by a search string

  #### Parameters

  - ##### permutedSearchStr: string

    NUL-delimited list of search strings

  - ##### node: any

  #### Returns boolean

  True if the node matches

### onTreeSelectionChanged

- onTreeSelectionChanged(_: any, data: any): void

- - Defined in @zowe/imperative/web-help/tree.ts:230

  Update current node after new node selected in tree

  #### Parameters

  - ##### _: any

  - ##### data: any

    jsTree event data

  #### Returns void

### permuteSearchStr

- permuteSearchStr(searchStr: string): string

- - Defined in @zowe/imperative/web-help/tree.ts:70

  Find all possible combinations of a search string that exist with different aliases

  #### Parameters

  - ##### searchStr: string

    Search string input by user

  #### Returns string

  NUL-delimited list of search strings with all combinations of aliases

### runValidatePlugin

- runValidatePlugin(pluginName: string): string

- - Defined in @zowe/imperative/src/imperative/src/plugins/utilities/runValidatePlugin.ts:30

  Run another instance of the host CLI command to validate a plugin that has just been installed. We use a separate process instead of an API call because when the user re-installs an existing plugin we cannot validate if the plugin has conflicting command names because the plugin has already been incorporated into the Imperative command tree, and thus it could conflict with its own commands. However, if we run a validate command in a new process, we start with a clean slate and we get accurate results.

  #### Parameters

  - ##### pluginName: string

    The name of a plugin to be validated.

  #### Returns string

  - The text output of the validate plugin command.

### setTooltip

- setTooltip(btn: any, message: string): void

- - Defined in @zowe/imperative/web-help/docs.ts:60

  Show tooltip next to copy button that times out after 1 sec

  #### Parameters

  - ##### btn: any

    Button element the tooltip will show next to

  - ##### message: string

    Message to show in the tooltip

  #### Returns void

### toggleTree

- toggleTree(splitter: any): void

- - Defined in @zowe/imperative/web-help/tree.ts:318

  Toggle visibility of command tree

  #### Parameters

  - ##### splitter: any

    Split.js object

  #### Returns void

### translateLog4jsPattern

- translateLog4jsPattern(pattern: string): ReturnType

- - Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:88

  Translates a log4js pattern string into a Winston format object. Handles common tokens like %d, %p, %m, %c, %n, %h, %z, %%. Supports multiple %d tokens with different format specifiers (e.g., %d{yyyy/MM/dd}, %d{hh:mm:ss}). Strips color codes (%[ and %]).

  #### Parameters

  - ##### pattern: string

    The log4js pattern string.

  #### Returns ReturnType

  A Winston format object.

### uninstall

- uninstall(packageName: string): void

- - Defined in @zowe/imperative/src/imperative/src/plugins/utilities/npm-interface/uninstall.ts:75
  todo
    - allow multiple packages to be uninstalled? Common function that abstracts the uninstall process.

  #### Parameters

  - ##### packageName: string

    A package name. This value is a valid npm package name.

  #### Returns void

### update

- update(packageName: string, registryInfo: INpmRegistryInfo): Promise<string>

- - Defined in @zowe/imperative/src/imperative/src/plugins/utilities/npm-interface/update.ts:26
  todo
    - allow multiple packages to be updated? Common function that abstracts the update process.

  #### Parameters

  - ##### packageName: string

    A package name. This value is a valid npm package name.

  - ##### registryInfo: INpmRegistryInfo

    The npm registry to use.

  #### Returns Promise<string>

### Const updateAndGetRemovedTypes

- updateAndGetRemovedTypes(npmPackage: string): string[]

- - Defined in @zowe/imperative/src/imperative/src/plugins/utilities/npm-interface/uninstall.ts:32

  Updates `extenders.json` and returns a list of types to remove from the schema, if applicable.

  #### Parameters

  - ##### npmPackage: string

    The package name for the plug-in that's being uninstalled

  #### Returns string[]

  A list of types to remove from the schema

### updateCurrentNode

- updateCurrentNode(newNodeId: string, goto: boolean, expand: boolean, force?: boolean): void

- - Defined in @zowe/imperative/web-help/tree.ts:98

  Update node that docs are displayed for

  #### Parameters

  - ##### newNodeId: string

    Node ID to select

  - ##### goto: boolean

    Whether to load docs page for node

  - ##### expand: boolean

    Whether to expand tree node

  - ##### Default value force: boolean = false

    Whether to update node even if already selected

  #### Returns void

### Const updateExtendersJson

- updateExtendersJson(extendersJson: IExtendersJsonOpts, packageInfo: { name: string; version: string }, profile: IProfileTypeConfiguration): boolean

- - Defined in @zowe/imperative/src/imperative/src/plugins/utilities/npm-interface/install.ts:35

  #### Parameters

  - ##### extendersJson: IExtendersJsonOpts

  - ##### packageInfo: { name: string; version: string }

    - ##### name: string

    - ##### version: string

  - ##### profile: IProfileTypeConfiguration

  #### Returns boolean

## Object literals

### Const MOCKED_COMMAND_TREE

MOCKED_COMMAND_TREE: object

- Defined in @zowe/imperative/src/imperative/src/__mocks__/Imperative.ts:20

### children

children: { description: string; name: string; options: ({ description: string; name: string; type: "string" } | { description: string; name: string; type: "boolean" })[]; positionals: { description: string; name: string; required: false; type: "string" }[]; type: "command" }[] = [{name: "test-command-one",description: "test command one",type: "command",options: [{name: "test-option",description: "the option",type: "string"},{name: "test-boolean",description: "the boolean option",type: "boolean"}],positionals: [{name: "positional1",description: "the positional option",type: "string",required: false}]},{name: "test-command-two",description: "test command two",type: "command",options: [{name: "test-option",description: "the option",type: "string"},{name: "test-boolean",description: "the boolean option",type: "boolean"}],positionals: [{name: "positional1",description: "the positional option",type: "string",required: false}]}]

- Defined in @zowe/imperative/src/imperative/src/__mocks__/Imperative.ts:24

### description

description: string = "a test group"

- Defined in @zowe/imperative/src/imperative/src/__mocks__/Imperative.ts:22

### name

name: string = "test-group"

- Defined in @zowe/imperative/src/imperative/src/__mocks__/Imperative.ts:21

### type

type: "group" = "group"

- Defined in @zowe/imperative/src/imperative/src/__mocks__/Imperative.ts:23

### Const ReportEnvDefinition

ReportEnvDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts:19

Definition for the 'config report-env' command.

### aliases

aliases: string[] = ["re"]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts:21

### description

description: string = "Reports key items from your environment and identifies problem conditions."

- Defined in @zowe/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts:25

### examples

examples: { description: string; options: string }[] = [{description: "Report information and issues about your working environment",options: ""},{description: "Save the report about your working environment to a file",options: "> report.log"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts:26

### handler

handler: string = join(__dirname, "Report-env.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts:23

### name

name: string = "report-env"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts:20

### summary

summary: string = "Report the state of your working environment"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts:24

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts:22

### Const apiErrorHeader

apiErrorHeader: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:15

### message

message: string = `${Constants.FRAMEWORK_DISPLAY_NAME} API Error`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:16

### Const authCategoryDesc

authCategoryDesc: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:44

### message

message: string = `${authCategorySummary.message}.`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:45

### Const authCategorySummary

authCategorySummary: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:40

### message

message: string = `Connect to token-based authentication services`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:41

### Const authLoginCommandDesc

authLoginCommandDesc: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:56

### message

message: string = `Log in to {{type}} authentication service.`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:57

### Const authLoginGroupDesc

authLoginGroupDesc: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:52

### message

message: string = `${authLoginGroupSummary.message}.`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:53

### Const authLoginGroupSummary

authLoginGroupSummary: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:48

### message

message: string = `Log in to an authentication service`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:49

### Const authLoginShowTokenDesc

authLoginShowTokenDesc: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:60

### message

message: string = `Show the token when login is successful. If specified, does not save the token to a profile.`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:61

### Const authLogoutCommandDesc

authLogoutCommandDesc: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:72

### message

message: string = `Log out of {{type}} authentication service.`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:73

### Const authLogoutGroupDesc

authLogoutGroupDesc: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:68

### message

message: string = `${authLogoutGroupSummary.message}.`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:69

### Const authLogoutGroupSummary

authLogoutGroupSummary: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:64

### message

message: string = `Log out of an authentication service`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:65

### Const autoInitCommandDesc

autoInitCommandDesc: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:80

### message

message: string = `${autoInitCommandSummary.message}.`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:81

### Const autoInitCommandSummary

autoInitCommandSummary: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:76

### message

message: string = `Automatically generate a config from {{source}}`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:77

### Const convertProfilesDefinition

convertProfilesDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/convert-profiles/convert-profiles.definition.ts:20

Definition of the convert-profiles command.

### aliases

aliases: string[] = ["convert"]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/convert-profiles/convert-profiles.definition.ts:22

### description

description: string = `Convert v1 profiles to a global ${ImperativeConfig.instance.rootCommandName}.config.json file.`

- Defined in @zowe/imperative/src/imperative/src/config/cmd/convert-profiles/convert-profiles.definition.ts:26

### examples

examples: { description: string; options: string }[] = [{description: "Convert V1 profiles to a new Zowe client configuration without prompting",options: "--no-prompt"}, {description: "Convert V1 profiles to a new Zowe client configuration and delete the old V1 profiles",options: "--delete"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/convert-profiles/convert-profiles.definition.ts:37

### handler

handler: string = join(__dirname, "convert-profiles.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/convert-profiles/convert-profiles.definition.ts:24

### name

name: string = "convert-profiles"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/convert-profiles/convert-profiles.definition.ts:21

### options

options: ({ defaultValue: boolean; description: string; name: string; type: "boolean" } | { description: string; name: string; type: "boolean" })[] = [{name: "prompt",description: "Prompt for confirmation. Use --no-prompt to disable prompting.",type: "boolean",defaultValue: true}, {name: "delete",description: "Delete the existing profiles on disk and any securely stored secrets.",type: "boolean"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/convert-profiles/convert-profiles.definition.ts:27

### summary

summary: string = "Convert V1 profiles to a current Zowe client configuration"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/convert-profiles/convert-profiles.definition.ts:25

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/convert-profiles/convert-profiles.definition.ts:23

### Const couldNotInstantiateCommandHandler

couldNotInstantiateCommandHandler: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:19

### message

message: string = `Could not instantiate the handler {{commandHandler}} for ` +`command {{definitionName}}`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:20

### Const customLevels

customLevels: object

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:16

### colors

colors: object

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:27

### debug

debug: string = "blue"

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:33

### error

error: string = "red"

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:29

### fatal

fatal: string = "magenta"

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:28

### info

info: string = "green"

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:31

### mark

mark: string = "white"

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:32

### trace

trace: string = "gray"

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:34

### warn

warn: string = "yellow"

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:30

### levels

levels: object

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:17

### all

all: number = 7

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:25

### debug

debug: number = 5

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:23

### error

error: number = 1

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:19

### fatal

fatal: number = 0

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:18

### info

info: number = 3

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:21

### mark

mark: number = 4

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:22

### trace

trace: number = 6

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:24

### warn

warn: number = 2

- Defined in @zowe/imperative/src/logger/src/log4jsToWinston.ts:20

### Const editDefinition

editDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts:19

Definition of the edit command.

### description

description: string = `Edit an existing config file in your system's default text editor.\n\n` +`In a graphical environment, the application associated with JSON files will be launched. ` +`In a command-line environment, vi will be launched. To override the command-line editor used, specify it with the --editor option.`

- Defined in @zowe/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts:24

### examples

examples: { description: string; options: string }[] = [{description: "Edit global config file",options: "--global-config"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts:51

### handler

handler: string = join(__dirname, "edit.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts:22

### name

name: string = "edit"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts:20

### options

options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" } | { aliases: string[]; description: string; name: string; required: false; type: "string" })[] = [{name: "global-config",description: "Target the global config files.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Target the user config files.",aliases: ["uc"],type: "boolean",defaultValue: false},{name: "editor",description: `Editor that overrides the default editor for this file type. Set the option to the editor's executable file location ` +`or the program's name: ie "--editor notepad".`,aliases: ["ed"],type: "string",required: false},]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts:27

### summary

summary: string = "Edit config files"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts:23

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts:21

### Const errorDetailsHeader

errorDetailsHeader: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:24

### message

message: string = "Error Details:"

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:25

### Const firststepsDefinition

firststepsDefinition: object

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts:23

Definition of the firststeps command.

### aliases

aliases: string[] = ["fs"]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts:26

### description

description: string = "Show first steps required to set up plug-in for use."

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts:28

### examples

examples: { description: string; options: string }[] = [{description: `Show first steps for a plug-in called 'my-plugin'`,options: "my-plugin"}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts:40

### handler

handler: string = join(__dirname, "showfirststeps.handler")

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts:29

### name

name: string = "show-first-steps"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts:24

### positionals

positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin",type: "string",description: pluginDescription,required: false}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts:30

### summary

summary: string = "Show first steps for a plug-in"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts:27

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts:25

### Const importDefinition

importDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/import/import.definition.ts:21

Definition of the import command.

### description

description: string = "Import config files from another location on disk or from an Internet URL.\n\n" +"If the config `$schema` property points to a relative path, the schema will also be imported."

- Defined in @zowe/imperative/src/imperative/src/config/cmd/import/import.definition.ts:26

### examples

examples: { description: string; options: string }[] = [{description: "Import config from local file on disk",options: "~/Downloads/zowe.config.json"},{description: "Import global config from Internet URL",options: "https://example.com/zowe.config.json --global-config"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/import/import.definition.ts:83

### handler

handler: string = join(__dirname, "import.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/import/import.definition.ts:24

### name

name: string = "import"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/import/import.definition.ts:22

### options

options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" } | { aliases: string[]; description: string; group: string; implies: string[]; name: string; type: "string" } | { aliases: string[]; defaultValue: boolean; description: string; group: string; name: string; type: "boolean" })[] = [{name: "global-config",description: "Target the global config files.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Target the user config files.",aliases: ["uc"],type: "boolean",defaultValue: false},{name: "overwrite",description: "Overwrite config file if one already exists.",aliases: ["ow"],type: "boolean",defaultValue: false},{name: "user",aliases: ["u"],description: "User name if authentication is required to download the config from a URL.",type: "string",implies: ["password"],group: CONNECTION_OPTION_GROUP},{name: "password",aliases: ["pass", "pw"],description: "Password if authentication is required to download the config from a URL.",type: "string",implies: ["user"],group: CONNECTION_OPTION_GROUP},{name: "reject-unauthorized",aliases: ["ru"],description: "Reject self-signed certificates if config is downloaded from an HTTPS URL.",type: "boolean",defaultValue: true,group: CONNECTION_OPTION_GROUP}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/import/import.definition.ts:36

### positionals

positionals: { description: string; name: string; required: true; type: "string" }[] = [{name: "location",description: "File path or URL to import from.",required: true,type: "string"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/import/import.definition.ts:28

### summary

summary: string = "Import config files"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/import/import.definition.ts:25

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/import/import.definition.ts:23

### Const initDefinition

initDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.definition.ts:20

Definition of the init command.

### description

description: string = `Initialize config files. Defaults to initializing "${ImperativeConfig.instance.rootCommandName}.config.json" in the current ` +`working directory unless otherwise specified.\n\nUse "--user-config" to init ` +`"${ImperativeConfig.instance.rootCommandName}.config.user.json". Use "--global-config" to initialize the configuration files in your home ` +`"~/.zowe" directory.\n\nUse "--no-prompt" to skip prompting for values in a CI environment.`

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.definition.ts:25

### examples

examples: { description: string; options: string }[] = [{description: `Initialize configuration files in your home "~/.zowe" directory`,options: "--global-config"},{description: `Do a dry run of initializing configuration files in your home "~/.zowe" directory`,options: "--global-config --dry-run"},{description: "Initialize the user config files",options: "--user-config"},{description: "Initialize the user config files and do not prompt for secure values",options: "--user-config --prompt false"},{description: "Do a dry run of initializing the user config files and do not prompt for secure values",options: "--user-config --prompt false --dry-run"},{description: "Overwrite any existing global config files",options: "--global-config --overwrite --for-sure"},{description: "Overwrite any existing user config files",options: "--user-config --overwrite --for-sure"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.definition.ts:88

### handler

handler: string = join(__dirname, "init.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.definition.ts:23

### name

name: string = "init"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.definition.ts:21

### options

options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" } | { defaultValue: boolean; description: string; name: string; type: "boolean" } | { aliases: string[]; conflictsWith: string[]; description: string; implies: string[]; name: string; type: "boolean" } | { aliases: string[]; conflictsWith: string[]; description: string; name: string; type: "boolean" } | { aliases: string[]; description: string; implies: string[]; name: string; type: "string" })[] = [{name: "global-config",description: "Target the global config files.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Target the user config files.",aliases: ["uc"],type: "boolean",defaultValue: false},{name: "prompt",description: "Prompt for missing values in the base profile. Useful for disabling prompting in CI environments.",type: "boolean",defaultValue: true},{name: "overwrite",description: "Replace existing config files instead of merging the new changes.",aliases: ["ow"],type: "boolean",conflictsWith: ["dry-run"],implies: ["for-sure"]},{name: "for-sure",aliases: ["fs"],description: "Confirms the overwrite option.",type: "boolean",defaultValue: false},{name: "dry-run",description: "Display the outcome of the initialization without saving it.",aliases: ["dr", "dry"],type: "boolean",conflictsWith: ["edit", "overwrite", "prompt"]},{name: "edit",aliases: ["e"],description: "Open in editor after initializing the configuration.",type: "boolean",conflictsWith: ["dry-run"]},{name: "editor",description: `Editor that overrides the default editor for this file type. Set the option to the editor's executable file location ` +`or the program's name: ie "--editor notepad".`,aliases: ["ed"],type: "string",implies: ["edit"]}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.definition.ts:29

### summary

summary: string = "Init config files"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.definition.ts:24

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.definition.ts:22

### Const installDefinition

installDefinition: object

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/install/install.definition.ts:71

Definition of the install command.

### description

description: string = "Install plug-ins to an application."

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/install/install.definition.ts:75

### examples

examples: { description: string; options: string }[] = [{description: `Install plug-ins saved in ${PMFConstants.instance.PLUGIN_JSON}`,options: ""},{description: "Install plug-ins saved in a properly formatted config file",options: "--file /some/file/path/file_name.json"},{description: "Install a remote plug-in",options: "my-plugin"},{description: "Install a remote plug-in using semver",options: "my-plugin@\"^1.2.3\""},{description: "Install a remote plug-in from the specified registry",options: "my-plugin --registry https://registry.npmjs.org/"},{description: "Install a local folder, local TAR file, and a git URL",options: "./local-file /root/tar/some-tar.tgz git://github.com/project/repository.git#v1.0.0"},{description: "Install a remote plug-in from the registry which requires authorization" +"(don't need to use this flag if you have already logged in before)",options: "my-plugin --registry https://registry.npmjs.org/ --login"}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/install/install.definition.ts:113

### handler

handler: string = join(__dirname, "install.handler")

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/install/install.definition.ts:76

### name

name: string = "install"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/install/install.definition.ts:72

### options

options: ({ conflictsWith: string[]; description: string; name: string; required: false; type: "existingLocalFile" } | { description: string; name: string; required: false; type: "string" } | { description: string; implies: string[]; name: string; required: false; type: "boolean" } | { description: string; name: string; required: false; type: "boolean" })[] = [{name: "file",type: "existingLocalFile",description: fileDescription,required: false,conflictsWith: ["registry"]},{name: "registry",type: "string",description: registryDescription,required: false},{name: "login",type: "boolean",description: loginDescription,required: false,implies: ["registry"]},{name: "verbose",type: "boolean",description: verboseDescription,required: false}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/install/install.definition.ts:85

### positionals

positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin...",type: "string",description: pluginDescription,required: false}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/install/install.definition.ts:77

### summary

summary: string = "Install a plug-in"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/install/install.definition.ts:74

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/install/install.definition.ts:73

### Const listDefinition

listDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:15

### aliases

aliases: string[] = ["ls"]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:17

### description

description: string = "List config properties."

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:20

### examples

examples: { description: string; options: string }[] = [{description: "List property names for a specified config property",options: `"defaults"`},{description: "List only root level property names for a specified config property",options: `"defaults" --name-only`},{description: "List config properties by separating them by their respective config file locations",options: "--locations"},{description: "List only the root level configuration property names",options: "--name-only"},{description: "List only the root level configuration property names by separating them by their respective config file locations",options: "--locations --name-only"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:46

### handler

handler: string = join(__dirname, "list.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:21

### name

name: string = "list"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:16

### options

options: ({ description: string; name: string; type: "boolean" } | { aliases: string[]; description: string; name: string; type: "boolean" })[] = [{name: "locations",description: "Separate the config properties into their respective config file locations. " +"Helpful to determine where configuration value is specified.",type: "boolean"},{name: "name-only",description: "List only the names of root level property names. " +"For example, specify in addition to '--locations' to get a list of config file paths only.",type: "boolean",aliases: ["root"]}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:29

### positionals

positionals: { description: string; name: string; type: "string" }[] = [{name: "property",description: "The config property to list. Blank to list all properties.",type: "string"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:22

### summary

summary: string = "List config properties"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:19

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/list/list.definition.ts:18

### Const onlyForTesting

onlyForTesting: object

- Defined in @zowe/imperative/src/imperative/src/plugins/utilities/npm-interface/install.ts:287

### callPluginPostInstall

callPluginPostInstall: callPluginPostInstall = callPluginPostInstall

- Defined in @zowe/imperative/src/imperative/src/plugins/utilities/npm-interface/install.ts:288

### Const profilesDefinition

profilesDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts:19

Definition of the paths command.

### description

description: string = "Displays profile paths."

- Defined in @zowe/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts:24

### examples

examples: { description: string; options: string }[] = [{description: "Display profile paths",options: ""}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts:25

### handler

handler: string = join(__dirname, "profiles.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts:22

### name

name: string = "profiles"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts:20

### summary

summary: string = "Displays profile paths"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts:23

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts:21

### Const schemaDefinition

schemaDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts:19

Definition of the paths command.

### description

description: string = "Dumps the JSON schema for the config. " +"The schema is dynamically created based on your available plugins. " +"Direct the output of this command to a file and include in your config with '$schema' property to get editor completion."

- Defined in @zowe/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts:24

### examples

examples: { description: string; options: string }[] = [{description: "Display the JSON schema for the config",options: ""}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts:27

### handler

handler: string = join(__dirname, "schema.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts:22

### name

name: string = "schema"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts:20

### summary

summary: string = "Dumps the JSON schema for the config"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts:23

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts:21

### Const secureDefinition

secureDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts:15

### description

description: string = "Prompt for secure configuration properties."

- Defined in @zowe/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts:20

### examples

examples: { description: string; options: string }[] = [{description: "Secure the properties in global config",options: "--global-config"},{description: "Secure the properties in user config",options: "--user-config"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts:51

### handler

handler: string = join(__dirname, "secure.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts:18

### name

name: string = "secure"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts:16

### options

options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" } | { aliases: string[]; defaultValue: null; description: string; name: string; type: "string" })[] = [{name: "global-config",description: "Secure properties in global config.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Secure properties in user config.",aliases: ["uc"],type: "boolean",defaultValue: false},{name: "prune",description: "Delete properties stored in the vault for Zowe client config files that do not exist.",aliases: ["p"],type: "boolean",defaultValue: false},{name: "profile",description: "Specify the profile for which you want to configure secure values.",type: "string",aliases: ["pf"],defaultValue: null}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts:21

### summary

summary: string = "Secure configuration properties"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts:19

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts:17

### Const setDefinition

setDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/set/set.definition.ts:15

### description

description: string = "Create or update a configuration property."

- Defined in @zowe/imperative/src/imperative/src/config/cmd/set/set.definition.ts:20

### examples

examples: { description: string; options: string }[] = [{description: "Set the property in global config",options: `"profiles.host1.profiles.service1.properties.setting" "value" --global-config`},{description: "Set the property in user config",options: `"profiles.host1.profiles.service2.properties.setting" "value" --user-config`},{description: "Set property value to JSON",options: `"profiles.host1.profiles.service3.properties.setting" "{"property":"value"}" --json`},{description: "Store the property value",options: `"profiles.host1.profiles.service1.properties.setting" "value" --secure`},{description: "Set a default zosmf profile",options: `"defaults.zosmf" "zosmfProfileName"`},{description: "Set a default tso profile",options: `"defaults.tso" "tsoProfileName"`}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/set/set.definition.ts:62

### handler

handler: string = join(__dirname, "set.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/set/set.definition.ts:18

### name

name: string = "set"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/set/set.definition.ts:16

### options

options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; type: "boolean" } | { defaultValue: boolean; description: string; name: string; type: "boolean" } | { description: string; name: string; type: "boolean" })[] = [{name: "global-config",description: "Set the property in global config.",aliases: ["gc"],type: "boolean",defaultValue: false},{name: "user-config",description: "Set the property in user config.",aliases: ["uc"],type: "boolean",defaultValue: false},{name: "json",description: "The property value is JSON.",type: "boolean",defaultValue: false},{name: "secure",description: "Store the property value securely. " +"If omitted, any property named in the secure array of the config file will be saved securely.",type: "boolean"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/set/set.definition.ts:34

### positionals

positionals: ({ description: string; name: string; required: true; type: "string" } | { description: string; name: string; type: "string" })[] = [{name: "property",description: "The property to set. You may specify a path using dot notation (e.g. profiles.host1.profiles.service1.properties.setting).",required: true,type: "string"},{name: "value",description: "The property value to set. The value may be JSON. Use '--json' to indicate.",type: "string"}]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/set/set.definition.ts:21

### summary

summary: string = "Set configuration property"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/set/set.definition.ts:19

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/set/set.definition.ts:17

### Const syntaxErrorHeader

syntaxErrorHeader: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:36

### message

message: string = `\nSyntax Error`

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:37

### Const unexpectedCommandError

unexpectedCommandError: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:28

### message

message: string = "Unexpected Command Error"

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:29

### Const unexpectedCommandPreparationError

unexpectedCommandPreparationError: object

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:32

### message

message: string = "An unexpected command preparation error occurred:"

- Defined in @zowe/imperative/src/messages/src/CoreMessages.ts:33

### Const uninstallDefinition

uninstallDefinition: object

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/uninstall/uninstall.definition.ts:23

Definition of the uninstall command.

### description

description: string = "Uninstall plug-ins."

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/uninstall/uninstall.definition.ts:27

### examples

examples: { description: string; options: string }[] = [{description: "Uninstall a plug-in",options : "my-plugin"},]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/uninstall/uninstall.definition.ts:37

### handler

handler: string = join(__dirname, "uninstall.handler")

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/uninstall/uninstall.definition.ts:28

### name

name: string = "uninstall"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/uninstall/uninstall.definition.ts:24

### positionals

positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin...",type: "string",description: pluginDescription,required: false}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/uninstall/uninstall.definition.ts:29

### summary

summary: string = "Uninstall a plug-in"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/uninstall/uninstall.definition.ts:26

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/uninstall/uninstall.definition.ts:25

### Const updateDefinition

updateDefinition: object

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/update/update.definition.ts:39

Definition of the update command.

### description

description: string = "Update plug-ins."

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/update/update.definition.ts:43

### examples

examples: { description: string; options: string }[] = [{description: "Update a plug-in",options : "my-plugin"},{description: "Update a remote plug-in from the registry which requires authorization" +"(don't need to use this flag if you have already logged in before)",options: "my-plugin --registry https://registry.npmjs.org/ --login"}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/update/update.definition.ts:68

### handler

handler: string = join(__dirname, "update.handler")

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/update/update.definition.ts:44

### name

name: string = "update"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/update/update.definition.ts:40

### options

options: ({ description: string; name: string; required: false; type: "string" } | { description: string; implies: string[]; name: string; required: false; type: "boolean" })[] = [{name: "registry",type: "string",description: registryDescription,required: false},{name: "login",type: "boolean",description: loginDescription,required: false,implies: ["registry"]}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/update/update.definition.ts:53

### positionals

positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin...",type: "string",description: pluginDescription,required: false}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/update/update.definition.ts:45

### summary

summary: string = "Update a plug-in"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/update/update.definition.ts:42

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/update/update.definition.ts:41

### Const updateSchemasDefinition

updateSchemasDefinition: object

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:15

### aliases

aliases: string[] = ["us"]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:17

### description

description: string = "Update schema files by looking up the directory structure.\n\n" +"Schema files up in higher level directories will always be updated. " +"To also update schema files down in lower level directories, specify the `--depth` flag."

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:20

### examples

examples: { description: string; options: string }[] = [{description: "Update all schema files found in higher level directories",options: ``},{description: "Update all schema files found in higher level directories and 2 levels down the directory structure",options: `--depth 2`},]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:33

### handler

handler: string = join(__dirname, "update-schemas.handler")

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:23

### name

name: string = "update-schemas"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:16

### options

options: { defaultValue: number; description: string; name: string; type: "number" }[] = [{name: "depth",description: "Specifies how many levels down the directory structure should the schemas be updated.",type: "number",defaultValue: 0},]

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:25

### positionals

positionals: undefined[] = []

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:24

### summary

summary: string = "Update schema files"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:19

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts:18

### Const validateDefinition

validateDefinition: object

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts:24

Definition of the validate command.

### description

description: string = "Validate a plug-in that has been installed."

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts:28

### examples

examples: { description: string; options: string }[] = [{description: `Validate a plug-in named my-plugin`,options : "my-plugin"},{description: "Validate all installed plug-ins",options : ""},{description: "Validate a plug-in named my-plugin, and treat warnings as errors",options : "my-plugin --fail-on-warning"}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts:57

### handler

handler: string = join(__dirname, "validate.handler")

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts:29

### name

name: string = "validate"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts:25

### options

options: ({ aliases: string[]; defaultValue: boolean; description: string; name: string; required: false; type: "boolean" } | { aliases: string[]; defaultValue: boolean; description: string; implies: string[]; name: string; required: false; type: "boolean" })[] = [{name: "fail-on-error",aliases: ["foe"],type: "boolean",description: "Enables throwing an error and setting an error code if plugin validation detects an error.",required: false,defaultValue: true},{name: "fail-on-warning",aliases: ["fow"],type: "boolean",description: "Treat validation warnings as errors. Requires fail-on-error.",required: false,defaultValue: false,implies: ["fail-on-error"]}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts:38

### positionals

positionals: { description: string; name: string; required: false; type: "string" }[] = [{name: "plugin",type: "string",description: pluginDescription,required: false}]

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts:30

### summary

summary: string = "Validate a plug-in"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts:27

### type

type: "command" = "command"

- Defined in @zowe/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts:26

Generated using TypeDoc