Interface: CommandLine

January 18, 2022 · View on GitHub

Kui API Documentation - v11.0.0 / @kui-shell/core / CommandLine

Interface: CommandLine<Options>

@kui-shell/core.CommandLine

This information represents a command line, but split out in various useful ways.

Type parameters

NameType
OptionsParsedOptions

Hierarchy

Table of contents

Properties

Properties

argv

argv: string[]

the result of a whitespace split applied to the command string that pays attention to backslash escaping and quotations

Defined in

packages/core/src/models/command.ts:146


argvNoOptions

argvNoOptions: string[]

the residual of argv without parsedOptions

Defined in

packages/core/src/models/command.ts:151


command

command: string

the raw command string, as given by the user

Defined in

packages/core/src/models/command.ts:141


parsedOptions

parsedOptions: Options

the dash options parsed out in a way that pays attention to n-ary options such as --option key value

Defined in

packages/core/src/models/command.ts:167


pipeStages

pipeStages: Object

pipeline stages, e.g. if command='a b --foo|c', the pipeStages=[['a','b, '--foo'],'c']

Type declaration

NameType
prefix?string
redirect?string
redirector?">" | ">>" | "2>&1" | ">&" | ">>&"
stagesstring[][]

Defined in

packages/core/src/models/command.ts:156