kotlin-vscode/vscode/TerminalShellExecution

TerminalShellExecution

interface TerminalShellExecution(source)

A command that was executed in a terminal.

Properties

abstract val commandLine: TerminalShellExecutionCommandLine

The command line that was executed. The confidence of this value depends on the specific shell's shell integration implementation. This value may become more accurate after window.onDidEndTerminalShellExecution is fired.

cwd

abstract val cwd: Uri?

The working directory that was reported by the shell when this command executed. This Uri may represent a file on another machine (eg. ssh into another machine). This requires the shell integration to support working directory reporting.

Functions

read

abstract fun read(): AsyncIterable<JsString>

Creates a stream of raw data (including escape sequences) that is written to the terminal. This will only include data that was written after read was called for the first time, ie. you must call read immediately after the command is executed via TerminalShellIntegration.executeCommand or window.onDidStartTerminalShellExecution to not miss any data.