Interface CommandOptions

interface CommandOptions {
    cwd?: string;
    env?: {
        [key: string]: string | undefined;
    };
    shell?: {
        args?: string[];
        executable: string;
    };
}

Properties

cwd? env? shell?

Properties

Optional cwd

cwd?: string

The 'current working directory' the task will run in. Can be a uri-as-string or plain string path. If the cwd is meant to be somewhere under the workspace, one can use the variable ${workspaceFolder}, which will be replaced by its path, at runtime. If not specified, defaults to the workspace root. ex: cwd: '${workspaceFolder}/foo'

Optional env

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

The environment of the executed program or shell. If omitted the parent process' environment is used.

Type declaration

  • [key: string]: string | undefined

Optional shell

shell?: {
    args?: string[];
    executable: string;
}

Configuration of the shell when task type is shell

Type declaration

  • Optional args?: string[]

    The arguments to be passed to the shell executable to run in command mode (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).

  • executable: string

    The shell to use.

Settings

Member Visibility

Theme

On This Page

cwdenvshell