Imperative constants

export

### Hierarchy

- Constants

## Index

### Properties

- AUTH_GROUP
- AUTO_INIT_ACTION
- COMMAND_PROF_TYPE_PROPS
- COMMAND_SEGMENT
- CREATE_ACTION
- DEFAULT_EXPERIMENTAL_COMMAND_EXPLANATION
- DEFAULT_HIGHLIGHT_COLOR
- DEFAULT_LIST_GROUP
- DEFAULT_LIST_PROFILE_OBJECT
- DEFAULT_LIST_PROFILE_OBJECT_ALIAS
- DEFAULT_MASK_OUTPUT
- DEFAULT_PROMPT_PHRASE
- DEFAULT_SET_GROUP
- DEFAULT_SET_PROFILE_OBJECT
- DEFAULT_SET_PROFILE_OBJECT_ALIAS
- DEFAULT_SHOW_SECURE
- DEFAULT_SOCKET_CONNECT_TIMEOUT
- DELETE_ACTION
- DETAILS_ACTION
- DISABLE_DEFAULTS_OPTION
- ERROR_EXIT_CODE
- FRAMEWORK_DISPLAY_NAME
- GLOBAL_GROUP
- GROUP_SEGMENT
- GROUP_SEGMENT_NUMBER
- HELP_EXAMPLES
- HELP_OPTION
- HELP_OPTION_ALIAS
- HELP_WEB_OPTION
- HELP_WEB_OPTION_ALIAS
- IMPERATIVE_DEFAULT_HOME
- IMPERATIVE_DIRECTORY
- JSON_OPTION
- JSON_OPTION_ALIAS
- LIST_ACTION
- LOGIN_ACTION
- LOGIN_ACTION_ALIAS
- LOGOUT_ACTION
- LOGOUT_ACTION_ALIAS
- OPTIONS_SEGMENT
- OPT_LONG_DASH
- OPT_SHORT_DASH
- OVERWRITE_OPTION
- PRIMARY_COMMAND
- PRIMARY_SEGMENT_NUMBER
- PROFILES_DIR
- PROFILE_ALIASES
- PROFILE_DELETE_PROFILE_DEPS
- PROFILE_DELETE_PROFILE_DEPS_ALIAS
- PROFILE_GROUP
- PROFILE_NAME_OPTION
- PROFILE_NAME_OPTION_ALIAS
- PROFILE_OBJECT
- PROFILE_SET_OPTION_ALIAS
- SET_ACTION
- SHOW_DEPS_ACTION
- STDIN_CONTENT_KEY
- STDIN_DEFAULT_DESCRIPTION
- STDIN_OPTION
- STDIN_OPTION_ALIAS
- UPDATE_ACTION
- VALIDATE_ACTION
- VERSION_OPTION
- VERSION_OPTION_ALIAS
- WEB_DIFF_DIR
- WEB_HELP_DIR

## Properties

### Static Readonly AUTH_GROUP

AUTH_GROUP: "auth" = "auth"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:117

Auth group constants

### Static Readonly AUTO_INIT_ACTION

AUTO_INIT_ACTION: "auto-init" = "auto-init"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:126

Auto Init constants

### Static Readonly COMMAND_PROF_TYPE_PROPS

COMMAND_PROF_TYPE_PROPS: string[] = ["optionDefinition", "optionDefinitions", "includeInTemplate"]

- Defined in @zowe/imperative/src/constants/src/Constants.ts:132

ICommandProfileTypeConfiguration properties (used to omit from schemas registered via ProfileInfo)

### Static Readonly COMMAND_SEGMENT

COMMAND_SEGMENT: string = "[command]"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:31

Syntax diagram

### Static Readonly CREATE_ACTION

CREATE_ACTION: "create" = "create"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:85

Create profile constants

### Static Readonly DEFAULT_EXPERIMENTAL_COMMAND_EXPLANATION

DEFAULT_EXPERIMENTAL_COMMAND_EXPLANATION: string = "Experimental commands are commands that are not ready for general availability. If you " +"decide to use these commands, you might encounter bugs, incompatibilities with your system, " +"or incomplete help text. "

- Defined in @zowe/imperative/src/constants/src/Constants.ts:39

Explanation of experimental features to be used in various places around the CLI

### Static Readonly DEFAULT_HIGHLIGHT_COLOR

DEFAULT_HIGHLIGHT_COLOR: "yellow" = "yellow"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:104

### Static Readonly DEFAULT_LIST_GROUP

DEFAULT_LIST_GROUP: "list" = "list"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:55

### Static Readonly DEFAULT_LIST_PROFILE_OBJECT

DEFAULT_LIST_PROFILE_OBJECT: "loaded-profiles" = "loaded-profiles"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:53

### Static Readonly DEFAULT_LIST_PROFILE_OBJECT_ALIAS

DEFAULT_LIST_PROFILE_OBJECT_ALIAS: "lbp" = "lbp"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:54

### Static Readonly DEFAULT_MASK_OUTPUT

DEFAULT_MASK_OUTPUT: "TRUE" = "TRUE"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:106

### Static Readonly DEFAULT_PROMPT_PHRASE

DEFAULT_PROMPT_PHRASE: "PROMPT*" = "PROMPT*"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:105

### Static Readonly DEFAULT_SET_GROUP

DEFAULT_SET_GROUP: "set" = "set"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:51

### Static Readonly DEFAULT_SET_PROFILE_OBJECT

DEFAULT_SET_PROFILE_OBJECT: "default-profiles" = "default-profiles"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:49

### Static Readonly DEFAULT_SET_PROFILE_OBJECT_ALIAS

DEFAULT_SET_PROFILE_OBJECT_ALIAS: "dbp" = "dbp"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:50

### Static Readonly DEFAULT_SHOW_SECURE

DEFAULT_SHOW_SECURE: "FALSE" = "FALSE"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:107

### Static Readonly DEFAULT_SOCKET_CONNECT_TIMEOUT

DEFAULT_SOCKET_CONNECT_TIMEOUT: "60000" = "60000"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:108

### Static Readonly DELETE_ACTION

DELETE_ACTION: "delete" = "delete"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:93

### Static Readonly DETAILS_ACTION

DETAILS_ACTION: "detail" = "detail"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:94

### Static Readonly DISABLE_DEFAULTS_OPTION

DISABLE_DEFAULTS_OPTION: "disable-defaults" = "disable-defaults"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:92

### Static Readonly ERROR_EXIT_CODE

ERROR_EXIT_CODE: number = 1

- Defined in @zowe/imperative/src/constants/src/Constants.ts:22

### Static Readonly FRAMEWORK_DISPLAY_NAME

FRAMEWORK_DISPLAY_NAME: string = "Imperative"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:18

### Static GLOBAL_GROUP

GLOBAL_GROUP: string = "Global Options"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:57

### Static Readonly GROUP_SEGMENT

GROUP_SEGMENT: string = "[group]"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:32

### Static Readonly GROUP_SEGMENT_NUMBER

GROUP_SEGMENT_NUMBER: number = 2

- Defined in @zowe/imperative/src/constants/src/Constants.ts:47

### Static Readonly HELP_EXAMPLES

HELP_EXAMPLES: "help-examples" = "help-examples"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:64

### Static Readonly HELP_OPTION

HELP_OPTION: "help" = "help"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:60

### Static Readonly HELP_OPTION_ALIAS

HELP_OPTION_ALIAS: "h" = "h"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:61

### Static Readonly HELP_WEB_OPTION

HELP_WEB_OPTION: "help-web" = "help-web"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:65

### Static Readonly HELP_WEB_OPTION_ALIAS

HELP_WEB_OPTION_ALIAS: "hw" = "hw"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:66

### Static Readonly IMPERATIVE_DEFAULT_HOME

IMPERATIVE_DEFAULT_HOME: string = "IMPERATIVE_HOME"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:19

### Static Readonly IMPERATIVE_DIRECTORY

IMPERATIVE_DIRECTORY: string = ".imperative"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:20

### Static Readonly JSON_OPTION

JSON_OPTION: "response-format-json" = "response-format-json"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:58

### Static Readonly JSON_OPTION_ALIAS

JSON_OPTION_ALIAS: "rfj" = "rfj"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:59

### Static Readonly LIST_ACTION

LIST_ACTION: "list" = "list"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:98

### Static Readonly LOGIN_ACTION

LOGIN_ACTION: "login" = "login"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:118

### Static Readonly LOGIN_ACTION_ALIAS

LOGIN_ACTION_ALIAS: "li" = "li"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:119

### Static Readonly LOGOUT_ACTION

LOGOUT_ACTION: "logout" = "logout"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:120

### Static Readonly LOGOUT_ACTION_ALIAS

LOGOUT_ACTION_ALIAS: "lo" = "lo"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:121

### Static Readonly OPTIONS_SEGMENT

OPTIONS_SEGMENT: string = "[options]"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:33

### Static Readonly OPT_LONG_DASH

OPT_LONG_DASH: "--" = "--"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:72

### Static Readonly OPT_SHORT_DASH

OPT_SHORT_DASH: "-" = "-"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:73

### Static Readonly OVERWRITE_OPTION

OVERWRITE_OPTION: "overwrite" = "overwrite"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:91

### Static Readonly PRIMARY_COMMAND

PRIMARY_COMMAND: string = "imperative"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:24

### Static Readonly PRIMARY_SEGMENT_NUMBER

PRIMARY_SEGMENT_NUMBER: number = 1

- Defined in @zowe/imperative/src/constants/src/Constants.ts:46

Segments

### Static Readonly PROFILES_DIR

PROFILES_DIR: string = "/profiles"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:26

### Static Readonly PROFILE_ALIASES

PROFILE_ALIASES: string[] = ["profile", "pr"]

- Defined in @zowe/imperative/src/constants/src/Constants.ts:88

### Static Readonly PROFILE_DELETE_PROFILE_DEPS

PROFILE_DELETE_PROFILE_DEPS: "delete-dependent-profiles" = "delete-dependent-profiles"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:101

### Static Readonly PROFILE_DELETE_PROFILE_DEPS_ALIAS

PROFILE_DELETE_PROFILE_DEPS_ALIAS: "ddp" = "ddp"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:102

### Static Readonly PROFILE_GROUP

PROFILE_GROUP: "profiles" = "profiles"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:86

### Static Readonly PROFILE_NAME_OPTION

PROFILE_NAME_OPTION: "profileName" = "profileName"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:89

### Static Readonly PROFILE_NAME_OPTION_ALIAS

PROFILE_NAME_OPTION_ALIAS: "pn" = "pn"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:90

### Static Readonly PROFILE_OBJECT

PROFILE_OBJECT: "profile" = "profile"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:87

### Static Readonly PROFILE_SET_OPTION_ALIAS

PROFILE_SET_OPTION_ALIAS: "{{typeLetter}}n" = `{{typeLetter}}n`

- Defined in @zowe/imperative/src/constants/src/Constants.ts:99

### Static Readonly SET_ACTION

SET_ACTION: "set-default" = "set-default"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:100

### Static Readonly SHOW_DEPS_ACTION

SHOW_DEPS_ACTION: "show-dependencies" = "show-dependencies"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:95

### Static Readonly STDIN_CONTENT_KEY

STDIN_CONTENT_KEY: string = "stdin-content"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:80

If you use the stdin option, you will be able to access the contents buffer through this key on your Arguments object in your command

### Static Readonly STDIN_DEFAULT_DESCRIPTION

STDIN_DEFAULT_DESCRIPTION: "Pipe data into this command via stdin" = "Pipe data into this command via stdin"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:70

### Static Readonly STDIN_OPTION

STDIN_OPTION: "stdin" = "stdin"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:68

### Static Readonly STDIN_OPTION_ALIAS

STDIN_OPTION_ALIAS: "pipe" = "pipe"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:69

### Static Readonly UPDATE_ACTION

UPDATE_ACTION: "update" = "update"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:97

### Static Readonly VALIDATE_ACTION

VALIDATE_ACTION: "validate" = "validate"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:96

### Static Readonly VERSION_OPTION

VERSION_OPTION: "version" = "version"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:62

### Static Readonly VERSION_OPTION_ALIAS

VERSION_OPTION_ALIAS: "V" = "V"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:63

### Static Readonly WEB_DIFF_DIR

WEB_DIFF_DIR: "web-diff" = "web-diff"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:111

### Static Readonly WEB_HELP_DIR

WEB_HELP_DIR: "web-help" = "web-help"

- Defined in @zowe/imperative/src/constants/src/Constants.ts:110

Generated using TypeDoc