createTerminal

fun createTerminal(name: String = definedExternally, shellPath: String = definedExternally, shellArgs: JsAny = definedExternally): Terminal(source)

Creates a Terminal with a backing shell process. The cwd of the terminal will be the workspace directory if it exists.

Parameters

name

Optional human-readable string which will be used to represent the terminal in the UI.

shellPath

Optional path to a custom shell executable to be used in the terminal.

shellArgs

Optional args for the custom shell executable. A string can be used on Windows only which allows specifying shell args in command-line format.

Throws

When

running in an environment where a new process cannot be started.

Online Documentation


Creates a Terminal with a backing shell process.

Parameters

options

A TerminalOptions object describing the characteristics of the new terminal.

Throws

When

running in an environment where a new process cannot be started.

Online Documentation


Creates a Terminal where an extension controls its input and output.

Parameters

options

An ExtensionTerminalOptions object describing the characteristics of the new terminal.