Interface TerminalWidgetOptions

Terminal attributes. Can be useful to apply some implementation specific information.

Current working directory.

In case destroyTermOnClose is true - terminal process will be destroyed on close terminal widget, otherwise will be kept alive.

Environment variables for terminal.

When enabled the terminal will run the process as normal but not be surfaced to the user until Terminal.show is called.

icon class with or without color modifier

Terminal id. Should be unique for all DOM.

Whether it is a pseudo terminal where an extension controls its input and output.

When enabled, the terminal will not be persisted across window reloads.

Terminal kind that indicates whether a terminal is created by a user or by some extension for a user

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

The nonce to use to verify shell integration sequences are coming from a trusted source. An example impact of UX of this is if the command line is reported with a nonce, it will not need to verify with the user that the command line is correct before rerunning it via the shell integration command decoration.

This should be used if the terminal includes custom shell integration support. It should be set to a random GUID which will then set the VSCODE_NONCE environment variable. Inside the shell, this should then be removed from the environment so as to protect it from general access. Once that is done it can be passed through in the relevant sequences to make them trusted.

Path to the executable shell. For example: /bin/bash, bash, sh.

Whether the terminal process environment should be exactly as provided in env.

Human readable terminal representation on the UI.

Terminal server side can send to the client terminal title to display this value on the UI. If useServerTitle = true then display this title, otherwise display title defined by 'title' argument.