VS Code API
    Preparing search index...

    Interface TerminalOptions

    Value-object describing what options a terminal should use.

    interface TerminalOptions {
        color?: ThemeColor;
        cwd?: string | Uri;
        env?: { [key: string]: string | null | undefined };
        hideFromUser?: boolean;
        iconPath?: IconPath;
        isTransient?: boolean;
        location?:
            | TerminalEditorLocationOptions
            | TerminalSplitLocationOptions
            | TerminalLocation;
        message?: string;
        name?: string;
        shellArgs?: string
        | string[];
        shellIntegrationNonce?: string;
        shellPath?: string;
        strictEnv?: boolean;
    }
    Index

    Properties

    color? cwd? env? hideFromUser? iconPath? isTransient? location? message? name? shellArgs? shellIntegrationNonce? shellPath? strictEnv?

    Properties

    color?: ThemeColor

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

    cwd?: string | Uri

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

    env?: { [key: string]: string | null | undefined }

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

    hideFromUser?: boolean

    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. The hidden terminals will not be restored when the workspace is next opened.

    iconPath?: IconPath

    The icon path or ThemeIcon for the terminal.

    isTransient?: boolean

    Opt-out of the default terminal persistence on restart and reload. This will only take effect when terminal.integrated.enablePersistentSessions is enabled.

    location?:
        | TerminalEditorLocationOptions
        | TerminalSplitLocationOptions
        | TerminalLocation

    The TerminalLocation or TerminalEditorLocationOptions or TerminalSplitLocationOptions for the terminal.

    message?: 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.

    name?: string

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

    shellArgs?: 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.

    shellIntegrationNonce?: string

    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.

    shellPath?: string

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

    strictEnv?: boolean

    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.

    Settings

    Member Visibility

    On This Page

    Properties