Interface: CommandOptions
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/core / CommandOptions
Interface: CommandOptions
@kui-shell/core.CommandOptions
Hierarchy
-
CapabilityRequirements↳
CommandOptions
Table of contents
Properties
- docs
- flags
- fullscreen
- height
- hidden
- hide
- incognito
- isDirectory
- isExperimental
- listen
- needsUI
- noArgs
- noAuthOk
- noCoreRedirect
- okOptions
- outputOnly
- override
- plugin
- preferReExecute
- requiresLocal
- semiExpand
- synonymFor
- usage
- viewName
- viewTransformer
- width
Properties
docs
• Optional docs: string
Defined in
packages/core/src/models/command.ts:85
flags
• Optional flags: YargsParserFlags
Defined in
packages/core/src/models/command.ts:64
fullscreen
• Optional fullscreen: boolean
Inherited from
CapabilityRequirements.fullscreen
Defined in
packages/core/src/models/command.ts:262
height
• Optional height: number
Defined in
packages/core/src/models/command.ts:79
hidden
• Optional hidden: boolean
Defined in
packages/core/src/models/command.ts:67
hide
• Optional hide: boolean
Defined in
packages/core/src/models/command.ts:87
incognito
• Optional incognito: "popup"[]
Defined in
packages/core/src/models/command.ts:70
isDirectory
• Optional isDirectory: boolean
is this an interior node ("directory", versus a leaf-node with a command handler
Defined in
packages/core/src/models/command.ts:82
isExperimental
• Optional isExperimental: boolean
Is the command experimental? e.g. initial release, lack of test coverage
Defined in
packages/core/src/models/command.ts:102
listen
• Optional listen: CommandListener
Defined in
packages/core/src/models/command.ts:84
needsUI
• Optional needsUI: boolean
Inherited from
CapabilityRequirements.needsUI
Defined in
packages/core/src/models/command.ts:259
noArgs
• Optional noArgs: boolean
does this command accept no arguments of any sort (neither positional nor optional)?
Defined in
packages/core/src/models/command.ts:55
noAuthOk
• Optional noAuthOk: boolean | string[]
Inherited from
CapabilityRequirements.noAuthOk
Defined in
packages/core/src/models/command.ts:261
noCoreRedirect
• Optional noCoreRedirect: boolean
controller wants to handle redirect
Defined in
packages/core/src/models/command.ts:93
okOptions
• Optional okOptions: string[]
Defined in
packages/core/src/models/command.ts:90
outputOnly
• Optional outputOnly: boolean
Is the command only want to show output and hide input?
Defined in
packages/core/src/models/command.ts:108
override
• Optional override: CommandHandler<KResponse<any>, ParsedOptions>
Defined in
packages/core/src/models/command.ts:88
plugin
• Optional plugin: string
Defined in
packages/core/src/models/command.ts:89
preferReExecute
• Optional preferReExecute: boolean
When this command is being replayed, prefer to re-execute if possible
Defined in
packages/core/src/models/command.ts:111
requiresLocal
• Optional requiresLocal: boolean
Inherited from
CapabilityRequirements.requiresLocal
Defined in
packages/core/src/models/command.ts:260
semiExpand
• Optional semiExpand: boolean
Semicolon-expand the command line? Default: true
Defined in
packages/core/src/models/command.ts:58
synonymFor
• Optional synonymFor: Command<KResponse<any>, ParsedOptions>
Defined in
packages/core/src/models/command.ts:86
usage
• Optional usage: UsageModel
Defined in
packages/core/src/models/command.ts:61
viewName
• Optional viewName: string
Defined in
packages/core/src/models/command.ts:73
viewTransformer
• Optional viewTransformer: ViewTransformer<KResponse<any>, ParsedOptions>
model to view transformer
Defined in
packages/core/src/models/command.ts:96
width
• Optional width: number