<!doctype html>
< html class = "default no-js" lang = "zh-CN" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > ShellExecution | VS Code API 中文文档< / title >
< meta name = "description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API， >
< meta name = "author" content = "洛竹" >
< meta name = "copyright" content = "洛竹" >
< meta property = "og:title" content = "Vscode Api 中文文档" / >
< meta property = "og:type" content = "docs" >
< meta property = "og:image" content = "https://code.visualstudio.com/favicon.ico" / >
< meta property = "og:url" content = "https://vscode-api-cn.js.org/index.html" >
< meta property = "og:site_name" content = "Vscode Api 中文文档" >
< meta property = "og:description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API， >
< meta property = "article:tag" content = "vscode api" >
< meta property = "article:tag" content = "vscode api 中文文档" >
< meta property = "article:tag" content = "vscode 插件" >
< meta property = "article:tag" content = "vscode 插件开发" >
< meta property = "article:tag" content = "vscode VS Code API 中文文档" >
< meta property = "article:tag" content = "vscode ShellExecution" >
< meta name = "viewport" content = "width=device-width, initial-scale=1, viewport-fit=cover" >
< link rel = "shortcut icon" href = "https://code.visualstudio.com/favicon.ico" sizes = "128x128" >
< link rel = 'canonical' href = 'https://vscode-api-cn.js.org/classes/vscode.ShellExecution.html' / >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< meta name = "baidu-site-verification" content = "codeva-3X25ouCcqY" / >
< script async src = "https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin = "anonymous" > < / script >
<!-- Google tag (gtag.js) -->
< script async src = "https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-T4TRRS1LB1');
< / script >
< style >
.container-main {
padding-bottom: 50px;
}
< / style >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > VS Code API 中文文档< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../modules.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "../modules/vscode.html" > vscode< / a >
< / li >
< li >
< a href = "vscode.ShellExecution.html" > ShellExecution< / a >
< / li >
< / ul >
< h1 > Class ShellExecution< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< ins class = "adsbygoogle" style = "display:block; text-align:center;" data-ad-layout = "in-article" data-ad-format = "fluid" data-ad-client = "ca-pub-7962287588031867" data-ad-slot = "1993549381" > < / ins > < script > ( adsbygoogle = window . adsbygoogle || [ ] ) . push ( { } ) ; < / script >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > 层级< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > ShellExecution< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > 索引< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Constructors（ ） < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < a href = "vscode.ShellExecution.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Properties（ ） < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.ShellExecution.html#commandLine" class = "tsd-kind-icon" > command< wbr > Line< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.ShellExecution.html#command" class = "tsd-kind-icon" > command< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.ShellExecution.html#args" class = "tsd-kind-icon" > args< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "vscode.ShellExecution.html#options" class = "tsd-kind-icon" > options< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Constructors（ ） < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class" >
< a name = "constructor" class = "tsd-anchor" > < / a >
< h3 > constructor< / h3 >
< ul class = "tsd-signatures tsd-kind-constructor tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > new < wbr > Shell< wbr > Execution< span class = "tsd-signature-symbol" > (< / span > commandLine< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/vscode.ShellExecutionOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellExecutionOptions< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.ShellExecution.html" class = "tsd-signature-type" data-tsd-kind = "Class" > ShellExecution< / a > < / li >
< li class = "tsd-signature tsd-kind-icon" > new < wbr > Shell< wbr > Execution< span class = "tsd-signature-symbol" > (< / span > command< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.ShellQuotedString.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellQuotedString< / a > , args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.ShellQuotedString.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellQuotedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > []< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../interfaces/vscode.ShellExecutionOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellExecutionOptions< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.ShellExecution.html" class = "tsd-signature-type" data-tsd-kind = "Class" > ShellExecution< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/6d6f43c/vscode.d.ts#L6602" > vscode.d.ts:6602< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Creates a shell execution with a full command line.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > commandLine: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The command line to execute.< / p >
< / div >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < a href = "../interfaces/vscode.ShellExecutionOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellExecutionOptions< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Optional options for the started the shell.< / p >
< / div >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "vscode.ShellExecution.html" class = "tsd-signature-type" data-tsd-kind = "Class" > ShellExecution< / a > < / h4 >
< / li >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/6d6f43c/vscode.d.ts#L6614" > vscode.d.ts:6614< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Creates a shell execution with a command and arguments. For the real execution the editor will
construct a command line from the command and the arguments. This is subject to interpretation
especially when it comes to quoting. If full control over the command line is needed please
use the constructor that creates a < code > ShellExecution< / code > with the full command line.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > command: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.ShellQuotedString.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellQuotedString< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The command to execute.< / p >
< / div >
< / li >
< li >
< h5 > args: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.ShellQuotedString.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellQuotedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The command arguments.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < a href = "../interfaces/vscode.ShellExecutionOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellExecutionOptions< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Optional options for the started the shell.< / p >
< / div >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "vscode.ShellExecution.html" class = "tsd-signature-type" data-tsd-kind = "Class" > ShellExecution< / a > < / h4 >
< / li >
< / ul >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties（ ） < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "commandLine" class = "tsd-anchor" > < / a >
< h3 > command< wbr > Line< / h3 >
< div class = "tsd-signature tsd-kind-icon" > command< wbr > Line< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/6d6f43c/vscode.d.ts#L6619" > vscode.d.ts:6619< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The shell command line. Is < code > undefined< / code > if created with a command and arguments.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "command" class = "tsd-anchor" > < / a >
< h3 > command< / h3 >
< div class = "tsd-signature tsd-kind-icon" > command< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.ShellQuotedString.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellQuotedString< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/6d6f43c/vscode.d.ts#L6624" > vscode.d.ts:6624< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The shell command. Is < code > undefined< / code > if created with a full command line.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "args" class = "tsd-anchor" > < / a >
< h3 > args< / h3 >
< div class = "tsd-signature tsd-kind-icon" > args< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/vscode.ShellQuotedString.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellQuotedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > []< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/6d6f43c/vscode.d.ts#L6629" > vscode.d.ts:6629< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The shell args. Is < code > undefined< / code > if created with a full command line.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "options" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options< / h3 >
< div class = "tsd-signature tsd-kind-icon" > options< span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/vscode.ShellExecutionOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > ShellExecutionOptions< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/6d6f43c/vscode.d.ts#L6635" > vscode.d.ts:6635< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The shell options used when the command line is executed in a shell.
Defaults to undefined.< / p >
< / div >
< / div >
< / section >
< / section >
< ins class = "adsbygoogle" style = "display:block" data-ad-client = "ca-pub-7962287588031867" data-ad-slot = "9253022493" data-ad-format = "auto" data-full-width-responsive = "true" > < / ins > < script > ( adsbygoogle = window . adsbygoogle || [ ] ) . push ( { } ) ; < / script >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../modules.html" > Exports< / a >
< / li >
< li class = "current tsd-kind-namespace" >
< a href = "../modules/vscode.html" > vscode< / a >
< ul >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.authentication.html" > authentication< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.commands.html" > commands< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.comments.html" > comments< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.debug.html" > debug< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.env.html" > env< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.extensions.html" > extensions< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.languages.html" > languages< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.notebooks.html" > notebooks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.scm.html" > scm< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tasks.html" > tasks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tests.html" > tests< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.window.html" > window< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.workspace.html" > workspace< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< div style = "width: 200px" >
< script async = "async" type = "text/javascript" id = "clstr_globe" src = "//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4" > < / script >
< / div >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-class tsd-parent-kind-namespace" >
< a href = "vscode.ShellExecution.html" class = "tsd-kind-icon" > Shell< wbr > Execution< / a >
< ul >
< li class = " tsd-kind-constructor tsd-parent-kind-class" >
< a href = "vscode.ShellExecution.html#constructor" class = "tsd-kind-icon" > constructor< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.ShellExecution.html#commandLine" class = "tsd-kind-icon" > command< wbr > Line< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.ShellExecution.html#command" class = "tsd-kind-icon" > command< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.ShellExecution.html#args" class = "tsd-kind-icon" > args< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "vscode.ShellExecution.html#options" class = "tsd-kind-icon" > options< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > 图例< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > 友链：< a href = "https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target = "_blank" > VS Code 中文文档< / a > | < a href = "https://code.visualstudio.com/docs" target = "_blank" > VS Code 官网文档< / a > | < a href = "https://marketplace.visualstudio.com/" target = "_blank" > VS Code 扩展市场< / a > < / p >
< p > Generated by < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > . Maintained by < a href = "https://youngjuning.js.org" target = "_blank" > 洛竹< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< script > ( adsbygoogle = window . adsbygoogle || [ ] ) . push ( { } ) ; < / script >
< / body >
< / html >
