Class CliExecutionContext

constructor

• new CliExecutionContext(
      injector: Injector,
      terminal: Terminal,
      executor: CliCommandExecutorService,
      showPrompt: (options?: { newLine?: boolean; reset?: boolean }) => void,
      cliOptions?: CliOptions,
  ): CliExecutionContext

• Parameters

  • injector: Injector
  • terminal: Terminal
  • executor: CliCommandExecutorService
  • showPrompt: (options?: { newLine?: boolean; reset?: boolean }) => void
  • OptionalcliOptions: CliOptions

  Returns CliExecutionContext

Readonlyclipboard

OptionalcontextProcessor

executor

Readonlylogger

ReadonlyonAbort

Optional Readonlyoptions

Readonlyprocess

ReadonlyprogressBar

Readonlyservices

showPrompt

Readonlyspinner

Readonlystate

terminal

ReadonlytextAnimator

OptionaluserSession

Readonlywriter

abort

• abort(): void

• Aborts the current command

  Returns void

isProgressRunning

• isProgressRunning(): boolean

• Checks if there is a progress running

  Returns boolean

  true if there is a progress running

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

setSession

• setSession(session: ICliUserSession): void

• Parameters

  • session: ICliUserSession

  Returns void