TerminalOptions$Typings extension

on

Properties

color ↔ ThemeColor?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

The icon {@link ThemeColor} for the terminal. The terminal.ansi* theme keys are recommended for the best contrast and consistency across themes.
getter/setter pair
cwd ↔ Object?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

A path or Uri for the current working directory to be used for the terminal.
getter/setter pair
env ↔ Object?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

Object with environment variables that will be added to the editor process.
getter/setter pair
hideFromUser ↔ bool?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

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.
getter/setter pair
iconPath ↔ Object?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

The icon path or {@link ThemeIcon} for the terminal.
getter/setter pair
isTransient ↔ bool?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

Opt-out of the default terminal persistence on restart and reload. This will only take effect when terminal.integrated.enablePersistentSessions is enabled.
getter/setter pair
location ↔ Object?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

The {@link TerminalLocation} or {@link TerminalEditorLocationOptions} or {@link TerminalSplitLocationOptions} for the terminal.
getter/setter pair
message ↔ String?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

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.
getter/setter pair
name ↔ String?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

A human-readable string which will be used to represent the terminal in the UI.
getter/setter pair
shellArgs ↔ Object?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

Args for the custom shell executable. A string can be used on Windows only which allows specifying shell args in command-line format.
getter/setter pair
shellPath ↔ String?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

A path to a custom shell executable to be used in the terminal.
getter/setter pair
strictEnv ↔ bool?

Available on TerminalOptions, provided by the TerminalOptions$Typings extension

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.env.windows on top. When this is true, the complete environment must be provided as nothing will be inherited from the process or any configuration.
getter/setter pair