View source

typedef TerminalOptions

package vscode

Value-object describing what options a terminal should use.

Fields

@:optionaloptionalstrictEnv:Null<Bool>

Whether the terminal process environment should be exactly as provided in TerminalOptions.env. When this is false (default), the environment will be based on the window's environment and also apply configured platform settings like terminal.integrated.windows.env on top. When this is true, the complete environment must be provided as nothing will be inherited from the process or any configuration.

@:optionaloptionalshellPath:Null<String>

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

@:optionaloptionalshellArgs:Null<EitherType<Array<String>, String>>

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

@:optionaloptionalname:Null<String>

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

@:optionaloptionalmessage:Null<String>

A message to write to the terminal on first launch, note that this is not sent to the process but, rather written directly to the terminal. This supports escape sequences such a setting text style.

@:optionaloptionaliconPath:Null<EitherType<Uri, EitherType<{light:Uri, dark:Uri}, ThemeIcon>>>

The icon path or {@link ThemeIcon} for the terminal.

@:optionaloptionalhideFromUser:Null<Bool>

When enabled the terminal will run the process as normal but not be surfaced to the user until Terminal.show is called. The typical usage for this is when you need to run something that may need interactivity but only want to tell the user about it when interaction is needed. Note that the terminals will still be exposed to all extensions as normal.

@:optionaloptionalenv:Null<DynamicAccess<Null<String>>>

Object with environment variables that will be added to the editor process.

@:optionaloptionalcwd:Null<EitherType<String, Uri>>

A path or Uri for the current working directory to be used for the terminal.

@:optionaloptionalcolor:Null<ThemeColor>

The icon {@link ThemeColor} for the terminal. The terminal.ansi* theme keys are recommended for the best contrast and consistency across themes.