Text of code.visualstudio.com › docs › reference › tasks-appendix as Styx crawled it on Nov 18, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

Appendix

AI agents: See llms.txt for documentation discovery and navigation. Documentation articles are also available as Markdown by appending .md to the article URL. Join VS Code at Microsoft Ignite or catch the sessions online. A year of VS Code, wrapped. Explore the highlights. Appendix View as Markdown Ask in VS Code Ask in VS Code Insiders This is additional information for Visual Studio Code tasks . Schema for tasks.json The following interfaces define the basic schema of the tasks.json file.

Note : Some task options are contributed by VS Code extensions. You can use tasks.json IntelliSense to find a complete list, using the Trigger Suggestions command ( ⌃Space (Windows, Linux Ctrl+Space ) ). interface TaskConfiguration extends BaseTaskConfiguration { /** * The configuration's version number */ version : '2.0.0' ; /** * Windows specific task configuration */ windows ?: BaseTaskConfiguration ; /** * macOS specific task configuration */ osx ?: BaseTaskConfiguration ; /** * Linux specific task configuration */ linux ?: BaseTaskConfiguration ; } interface BaseTaskConfiguration { /** * The type of a custom task.

Tasks of type "shell" are executed * inside a shell (e.g. bash, cmd, powershell, ...) */ type ?: 'shell' | 'process' ; /** * The command to be executed. Can be an external program or a shell * command. */ command ?: string ; /** * Specifies whether a global command is a background task. */ isBackground ?: boolean ; /** * The command options used when the command is executed. Can be omitted. */ options ?: CommandOptions ; /** * The arguments passed to the command.

Can be omitted. */ args ?: string []; /** * The presentation options. */ presentation ?: PresentationOptions ; /** * The problem matcher to be used if a global command is executed (e.g. no tasks * are defined). A tasks.json file can either contain a global problemMatcher * property or a tasks property but not both. */ problemMatcher ?: string | ProblemMatcher | ( string | ProblemMatcher )[]; /** * The configuration of the available tasks.

A tasks.json file can either * contain a global problemMatcher property or a tasks property but not both. */ tasks ?: TaskDescription []; } /** * Options to be passed to the external program or shell */ export interface CommandOptions { /** * The current working directory of the executed program or shell. * If omitted the current workspace's root is used. */ cwd ?: string ; /** * The environment of the executed program or shell.

If omitted * the parent process' environment is used. */ env ?: { [ key : string ]: string }; /** * Configuration of the shell when task type is `shell` */ shell : { /** * The shell to use. */ executable : 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). */ args ?: string []; }; } /** * The description of a task. */ interface TaskDescription { /** * The task's name */ label : string ; /** * The type of a custom task.

Tasks of type "shell" are executed * inside a shell (e.g. bash, cmd, powershell, ...) */ type ?: 'shell' | 'process' ; /** * The command to execute. If the type is "shell" it should be the full * command line including any additional arguments passed to the command. */ command ?: string ; /** * Whether the executed command is kept alive and runs in the background. */ isBackground ?: boolean ; /** * Additional arguments passed to the command.

Should be used if type * is "process". */ args ?: string []; /** * Defines the group to which this task belongs. Also supports to mark * a task as the default task in a group. */ group ?: 'build' | 'test' | { kind : 'build' | 'test' ; isDefault : boolean }; /** * The presentation options. */ presentation ?: PresentationOptions ; /** * The problem matcher(s) to use to capture problems in the tasks * output. */ problemMatcher ?: string | ProblemMatcher | ( string | ProblemMatcher )[]; /** * Defines when and how a task is run. */ runOptions ?: RunOptions ; } interface PresentationOptions { /** * Controls whether the task output is reveal in the user interface. * Defaults to `always`. */ reveal ?: 'never' | 'silent' | 'always' ; /** * Controls whether the command associated with the task is echoed * in the user interface.

Defaults to `true`. */ echo ?: boolean ; /** * Controls whether the panel showing the task output is taking focus. * Defaults to `false`. */ focus ?: boolean ; /** * Controls if the task panel is used for this task only (dedicated), * shared between tasks (shared) or if a new panel is created on * every task execution (new). Defaults to `shared`. */ panel ?: 'shared' | 'dedicated' | 'new' ; /** * Controls whether to show the `Terminal will be reused by tasks, * press any key to close it` message. */ showReuseMessage ?: boolean ; /** * Controls whether the terminal is cleared before this task is run. * Defaults to `false`. */ clear ?: boolean ; /** * Controls whether the task is executed in a specific terminal * group using split panes.

Tasks in the same group (specified by a string value) * will use split terminals to present instead of a new terminal panel. */ group ?: string ; } /** * A description of a problem matcher that detects problems * in build output. */ interface ProblemMatcher { /** * The name of a base problem matcher to use. If specified the * base problem matcher will be used as a template and properties * specified here will replace properties of the base problem * matcher */ base ?: string ; /** * The owner of the produced VS Code problem.

This is typically * the identifier of a VS Code language service if the problems are * to be merged with the one produced by the language service * or 'external'. Defaults to 'external' if omitted. */ owner ?: string ; /** * A human-readable string describing the source of this problem. * E.g. 'typescript' or 'super lint'. */ source ?: string ; /** * The severity of the VS Code problem produced by this problem matcher. * * Valid values are: * "error": to produce errors. * "warning": to produce warnings. * "info": to produce infos. * * The value is used if a pattern doesn't specify a severity match group. * Defaults to "error" if omitted. */ severity ?: string ; /** * Defines how filename reported in a problem pattern * should be read.

Valid values are: * - "absolute": the filename is always treated absolute. * - "relative": the filename is always treated relative to * the current working directory. This is the default. * - ["relative", "path value"]: the filename is always * treated relative to the given path value. * - "autodetect": the filename is treated relative to * the current workspace directory, and if the file * does not exist, it is treated as absolute. * - ["autodetect", "path value"]: the filename is treated * relative to the given path value, and if it does not * exist, it is treated as absolute. * - "search": performs a deep (and, possibly, heavy) file system * search within the directories. * - ["search", {include: ["${workspaceFolder}"]}]: performs * a deep search among the directories given in the "include" array. * - ["search", {include: ["${workspaceFolder}"], exclude: []}]: * performs a deep search among the directories given in the "include" * array, excluding those named in the "exclude" array. */ fileLocation ?: string | string [] | [ 'search' , { include ?: string []; exclude ?: string [] }]; /** * The name of a predefined problem pattern, the inline definition * of a problem pattern or an array of problem patterns to match * problems spread over multiple lines. */ pattern ?: string | ProblemPattern | ProblemPattern []; /** * Additional information used to detect when a background task (like a watching task in Gulp) * is active. */ background ?: BackgroundMatcher ; } /** * A description to track the start and end of a background task. */ interface BackgroundMatcher { /** * If set to true the watcher is in active mode when the task * starts.

This is equals of issuing a line that matches the * begin

The rest of this page is on the live site.