Class CliExecutionContext

Implements

ICliExecutionContext

Constructors

constructor

new CliExecutionContext(
    injector: Injector,
    terminal: Terminal,
    executor: CliCommandExecutorService,
    cliOptions?: CliOptions,
): CliExecutionContext
Parameters
- injector: Injector
- terminal: Terminal
- executor: CliCommandExecutorService
- OptionalcliOptions: CliOptions
Returns CliExecutionContext
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:80

Properties

`Readonly`clipboard

clipboard: ICliClipboard

The clipboard to use for copying/pasting

`Optional`contextProcessor

contextProcessor?: ICliCommandProcessor

cursorPosition

cursorPosition: number = 0

The cursor position within the current line.

executor

executor: CliCommandExecutorService

`Readonly`logger

logger: ICliLogger

The logger to use for logging

`Readonly`onAbort

onAbort: Subject<void> = ...

A subject that emits when the command is aborted

`Optional` `Readonly`options

options?: CliOptions

The options for the CLI

`Readonly`process

process: ICliExecutionProcess

The process to use for exiting the CLI

`Readonly`progressBar

progressBar: ICliPercentageProgressBar

The progress bar to use for showing progress

promptLength

promptLength: number = 0

The number of visible characters the prompt occupies on the current line.

`Readonly`services

services: ICliServiceProvider

The services to use for the CLI context

`Readonly`spinner

spinner: ICliSpinner

The spinner to use for showing/hiding the loader

`Readonly`state

state: ICliStateStore

The state store to use for storing state

terminal

terminal: Terminal

`Readonly`textAnimator

textAnimator: ICliTextAnimator

The text animator to use for showing/hiding text

`Optional`userSession

userSession?: ICliUserSession

The current user session

`Readonly`writer

writer: ICliTerminalWriter

The writer to use for writing to the terminal

Accessors

currentLine

get currentLine(): string
The current user input text on the active line.

Returns string
Implementation of ICliExecutionContext.currentLine
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:67

Methods

abort

abort(): void
Returns void
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:314

clearCurrentLine

clearCurrentLine(): void
Clears the current line content and reprints the prompt.

Returns void
Implementation of ICliExecutionContext.clearCurrentLine
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:243

clearLine

clearLine(): void
Clears the current terminal line, including content that wraps across multiple rows. Uses promptLength + currentLine.length to determine how many rows to clear.

Returns void
Implementation of ICliExecutionContext.clearLine
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:212

initializeTerminalListeners

initializeTerminalListeners(): void
Returns void
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:118

isProgressRunning

isProgressRunning(): boolean
Returns boolean
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:306

refreshCurrentLine

refreshCurrentLine(previousContentLength?: number): void
Refreshes the display of the current line (clears and redraws prompt + input).
Parameters
- OptionalpreviousContentLength: number
Returns void
Implementation of ICliExecutionContext.refreshCurrentLine
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:250

setContextProcessor

setContextProcessor(
processor: undefined | ICliCommandProcessor,
silent?: boolean,
): void
Set the current processor as the context processor, i.e. the processor that will handle the command
Parameters
- processor: undefined | ICliCommandProcessor
  The processor to set
- Optionalsilent: boolean
  Indicates if the setting should be silent, i.e. not write to the terminal
Returns void
Implementation of ICliExecutionContext.setContextProcessor
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:188

setCurrentLine

setCurrentLine(line: string): void
Sets the current line text.
Parameters
- line: string
  The new line content
Returns void
Implementation of ICliExecutionContext.setCurrentLine
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:208

setSession

setSession(session: ICliUserSession): void
Parameters
- session: ICliUserSession
Returns void
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:330

showPrompt

showPrompt(
    options?: {
        keepCurrentLine?: boolean;
        newLine?: boolean;
        reset?: boolean;
    },
): void
Prints the prompt to the terminal.
Parameters
- Optionaloptions: { keepCurrentLine?: boolean; newLine?: boolean; reset?: boolean }
Returns void
Implementation of ICliExecutionContext.showPrompt
- Defined in cli/src/lib/cli/context/cli-execution-context.ts:219

Class CliExecutionContext

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CliExecutionContext

Properties

Readonlyclipboard

OptionalcontextProcessor

cursorPosition

executor

Readonlylogger

ReadonlyonAbort

Optional Readonlyoptions

Readonlyprocess

ReadonlyprogressBar

promptLength

Readonlyservices

Readonlyspinner

Readonlystate

terminal

ReadonlytextAnimator

OptionaluserSession

Readonlywriter

Accessors

currentLine

Returns string

Methods

abort

Returns void

clearCurrentLine

Returns void

clearLine

Returns void

initializeTerminalListeners

Returns void

isProgressRunning

Returns boolean

refreshCurrentLine

Parameters

Returns void

setContextProcessor

Parameters

Returns void

setCurrentLine

Parameters

Returns void

setSession

Parameters

Returns void

showPrompt

Parameters

Returns void

Settings

On This Page

`Readonly`clipboard

`Optional`contextProcessor

`Readonly`logger

`Readonly`onAbort

`Optional` `Readonly`options

`Readonly`process

`Readonly`progressBar

`Readonly`services

`Readonly`spinner

`Readonly`state

`Readonly`textAnimator

`Optional`userSession

`Readonly`writer