💻 歡迎參加 6 月 3 日舉行的 MS Build 之 VS Code 直播活動。

內建指令

本文件列出了您可能會搭配 vscode.commands.executeCommand API 使用的 Visual Studio Code 指令子集。

請閱讀 指令指南 以了解如何使用指令 API。

以下是如何在 VS Code 中開啟新資料夾的範例

let uri = Uri.file('/some/path/to/folder');
let success = await commands.executeCommand('vscode.openFolder', uri);

注意：您可以透過鍵盤快速鍵編輯器 檔案 (File) > 喜好設定 (Preferences) > 鍵盤快速鍵 (Keyboard Shortcuts) 來查看 VS Code 的完整指令集。鍵盤快速鍵編輯器會列出所有內建於 VS Code 或由擴充功能提供的指令，以及它們的鍵盤繫結和適用時機 (when clauses)。

命令

vscode.executeDataToNotebook - 呼叫 Notebook 序列化程式

  • notebookType - Notebook 類型
  • data - 要轉換為資料的位元組 (Bytes)
  • (傳回值) - Notebook 資料

vscode.executeNotebookToData - 呼叫 Notebook 序列化程式

  • notebookType - Notebook 類型
  • NotebookData - 要轉換為位元組的 Notebook 資料
  • (傳回值) - 位元組 (Bytes)

notebook.selectKernel - 為指定的 Notebook 編輯器視窗觸發核心選擇器

  • options - 選擇核心選項
  • (傳回值) - 無結果

interactive.open - 開啟互動式視窗並傳回 Notebook 編輯器與輸入 URI

  • showOptions - 顯示選項
  • resource - 互動式資源 URI
  • controllerId - Notebook 控制器 ID
  • title - 互動式編輯器標題
  • (傳回值) - Notebook 與輸入 URI

vscode.editorChat.start - 呼叫新的編輯器對話作業階段

  • 執行引數 -
  • (傳回值) - 無結果

vscode.executeDocumentHighlights - 執行文件反白提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為 DocumentHighlight 執行個體陣列的 Promise。

vscode.executeDocumentSymbolProvider - 執行文件符號提供者。

  • uri - 文字文件的 URI
  • (傳回值) - 一個解析為 SymbolInformation 和 DocumentSymbol 執行個體陣列的 Promise。

vscode.executeFormatDocumentProvider - 執行文件格式化提供者。

  • uri - 文字文件的 URI
  • options - 格式化選項
  • (傳回值) - 一個解析為 TextEdits 陣列的 Promise。

vscode.executeFormatRangeProvider - 執行範圍格式化提供者。

  • uri - 文字文件的 URI
  • range - 文字文件中的範圍
  • options - 格式化選項
  • (傳回值) - 一個解析為 TextEdits 陣列的 Promise。

vscode.executeFormatOnTypeProvider - 執行輸入時格式化提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • ch - 觸發字元
  • options - 格式化選項
  • (傳回值) - 一個解析為 TextEdits 陣列的 Promise。

vscode.executeDefinitionProvider - 執行所有定義提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為 Location 或 LocationLink 執行個體陣列的 Promise。

vscode.executeTypeDefinitionProvider - 執行所有型別定義提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為 Location 或 LocationLink 執行個體陣列的 Promise。

vscode.executeDeclarationProvider - 執行所有宣告提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為 Location 或 LocationLink 執行個體陣列的 Promise。

vscode.executeImplementationProvider - 執行所有實作提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為 Location 或 LocationLink 執行個體陣列的 Promise。

vscode.executeReferenceProvider - 執行所有參考提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為 Location 執行個體陣列的 Promise。

vscode.executeHoverProvider - 執行所有懸停提示提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為 Hover 執行個體陣列的 Promise。

vscode.executeSelectionRangeProvider - 執行選取範圍提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為範圍陣列的 Promise。

vscode.executeWorkspaceSymbolProvider - 執行所有工作區符號提供者。

  • query - 搜尋字串
  • (傳回值) - 一個解析為 SymbolInformation 執行個體陣列的 Promise。

vscode.prepareCallHierarchy - 準備文件內某個位置的呼叫階層

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為 CallHierarchyItem 執行個體陣列的 Promise

vscode.provideIncomingCalls - 計算項目的傳入呼叫

  • item - 呼叫階層項目
  • (傳回值) - 一個解析為 CallHierarchyIncomingCall 執行個體陣列的 Promise

vscode.provideOutgoingCalls - 計算項目的傳出呼叫

  • item - 呼叫階層項目
  • (傳回值) - 一個解析為 CallHierarchyOutgoingCall 執行個體陣列的 Promise

vscode.prepareRename - 執行重新命名提供者的 prepareRename。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為範圍與預留位置文字的 Promise。

vscode.executeDocumentRenameProvider - 執行重新命名提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • newName - 新的符號名稱
  • (傳回值) - 一個解析為 WorkspaceEdit 的 Promise。

vscode.executeLinkProvider - 執行文件連結提供者。

  • uri - 文字文件的 URI
  • linkResolveCount - (選用) 應解析的連結數量，僅在連結未解析時有效。
  • (傳回值) - 一個解析為 DocumentLink 執行個體陣列的 Promise。

vscode.provideDocumentSemanticTokensLegend - 提供文件的語意語彙基元圖例

  • uri - 文字文件的 URI
  • (傳回值) - 一個解析為 SemanticTokensLegend 的 Promise。

vscode.provideDocumentSemanticTokens - 提供文件的語意語彙基元

  • uri - 文字文件的 URI
  • (傳回值) - 一個解析為 SemanticTokens 的 Promise。

vscode.provideDocumentRangeSemanticTokensLegend - 提供文件範圍的語意語彙基元圖例

  • uri - 文字文件的 URI
  • range - (選用) 文字文件中的範圍
  • (傳回值) - 一個解析為 SemanticTokensLegend 的 Promise。

vscode.provideDocumentRangeSemanticTokens - 提供文件範圍的語意語彙基元

  • uri - 文字文件的 URI
  • range - 文字文件中的範圍
  • (傳回值) - 一個解析為 SemanticTokens 的 Promise。

vscode.executeCompletionItemProvider - 執行完成項目提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • triggerCharacter - (選用) 當使用者輸入該字元（例如 , 或 (）時觸發完成
  • itemResolveCount - (選用) 要解析的完成數量（數字過大會減慢完成速度）
  • (傳回值) - 一個解析為 CompletionList 執行個體的 Promise。

vscode.executeSignatureHelpProvider - 執行簽章輔助提供者。

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • triggerCharacter - (選用) 當使用者輸入該字元（例如 , 或 (）時觸發簽章輔助
  • (傳回值) - 一個解析為 SignatureHelp 的 Promise。

vscode.executeCodeLensProvider - 執行 Code Lens 提供者。

  • uri - 文字文件的 URI
  • itemResolveCount - (選用) 應解析並傳回的 Lens 數量。只會傳回已解析的 Lens，會影響效能
  • (傳回值) - 一個解析為 CodeLens 執行個體陣列的 Promise。

vscode.executeCodeActionProvider - 執行程式碼動作提供者。

  • uri - 文字文件的 URI
  • rangeOrSelection - 文字文件中的範圍。某些重構提供者需要 Selection 物件。
  • kind - (選用) 要傳回程式碼動作的程式碼動作類型 (kind)
  • itemResolveCount - (選用) 要解析的程式碼動作數量（數字過大會減慢程式碼動作速度）
  • (傳回值) - 一個解析為 Command 執行個體陣列的 Promise。

vscode.executeDocumentColorProvider - 執行文件色彩提供者。

  • uri - 文字文件的 URI
  • (傳回值) - 一個解析為 ColorInformation 物件陣列的 Promise。

vscode.executeColorPresentationProvider - 執行色彩呈現提供者。

  • color - 要顯示與插入的色彩
  • context - 包含 uri 與範圍的 Context 物件
  • (傳回值) - 一個解析為 ColorPresentation 物件陣列的 Promise。

vscode.executeInlayHintProvider - 執行嵌入提示提供者

  • uri - 文字文件的 URI
  • range - 文字文件中的範圍
  • (傳回值) - 一個解析為 Inlay 物件陣列的 Promise

vscode.executeFoldingRangeProvider - 執行摺疊範圍提供者

  • uri - 文字文件的 URI
  • (傳回值) - 一個解析為 FoldingRange 物件陣列的 Promise

vscode.resolveNotebookContentProviders - 解析 Notebook 內容提供者

  • (傳回值) - 一個解析為 NotebookContentProvider 靜態資訊物件陣列的 Promise。

vscode.executeInlineValueProvider - 執行行內值提供者

  • uri - 文字文件的 URI
  • range - 文字文件中的範圍
  • context - InlineValueContext
  • (傳回值) - 一個解析為 InlineValue 物件陣列的 Promise

vscode.open - 在編輯器中開啟提供的資源。可以是文字或二進位檔案，或是 http(s) URL。如果您需要更細緻地控制開啟文字檔案的選項，請改用 vscode.window.showTextDocument。

  • uri - 文字或二進位檔案的 URI，或是 http(s) URL
  • columnOrOptions - (選用) 開啟的欄位或是編輯器選項，請參閱 vscode.TextDocumentShowOptions
  • label - 編輯器標籤 (選用)
  • (傳回值) - 無結果

vscode.openWith - 使用特定編輯器開啟提供的資源。

  • resource - 要開啟的資源
  • viewId - 自訂編輯器檢視 ID，或使用 'default' 來使用 VS Code 的預設編輯器
  • columnOrOptions - (選用) 開啟的欄位或是編輯器選項，請參閱 vscode.TextDocumentShowOptions
  • (傳回值) - 無結果

vscode.diff - 在差異編輯器中開啟提供的資源以比較內容。

  • left - 差異編輯器左側資源
  • right - 差異編輯器右側資源
  • title - 差異編輯器的人類可讀標題
  • options - (選用) 開啟的欄位或是編輯器選項 (請參閱 vscode.TextDocumentShowOptions)

vscode.changes - 在變更編輯器中開啟資源列表以比較內容。

  • title - 變更編輯器的人類可讀標題
  • resourceList - 要比較資源的列表

vscode.prepareTypeHierarchy - 準備文件內某個位置的型別階層

  • uri - 文字文件的 URI
  • position - 文字文件中的位置
  • (傳回值) - 一個解析為 TypeHierarchyItem 執行個體陣列的 Promise

vscode.provideSupertypes - 計算項目的父型別

  • item - 型別階層項目
  • (傳回值) - 一個解析為 TypeHierarchyItem 執行個體陣列的 Promise

vscode.provideSubtypes - 計算項目的子型別

  • item - 型別階層項目
  • (傳回值) - 一個解析為 TypeHierarchyItem 執行個體陣列的 Promise

vscode.revealTestInExplorer - 在總管中顯示測試執行個體

  • testItem - VS Code 的 TestItem。
  • (傳回值) - 無結果

setContext - 設定可以在 when 子句中使用的自訂內容鍵值。

  • name - 內容鍵名稱
  • value - 內容鍵值
  • (傳回值) - 無結果

cursorMove - 將游標移至檢視中的邏輯位置

  • 游標移動引數物件 - 可以透過此引數傳遞的屬性-值對
    • 'to': 必要，提供游標移動位置的邏輯值。
      'left', 'right', 'up', 'down', 'prevBlankLine', 'nextBlankLine',
'wrappedLineStart', 'wrappedLineEnd', 'wrappedLineColumnCenter'
'wrappedLineFirstNonWhitespaceCharacter', 'wrappedLineLastNonWhitespaceCharacter'
'viewPortTop', 'viewPortCenter', 'viewPortBottom', 'viewPortIfOutside'
    • 'by': 移動單位。預設值根據 'to' 值計算。
      'line', 'wrappedLine', 'character', 'halfLine'
    • 'value': 移動的單位數量。預設為 '1'。
    • 'select': 若為 'true' 則建立選取範圍。預設為 'false'。

editorScroll - 沿指定方向捲動編輯器

  • 編輯器捲動引數物件 - 可以透過此引數傳遞的屬性-值對
    • 'to': 必要，方向值。
      'up', 'down'
    • 'by': 移動單位。預設值根據 'to' 值計算。
      'line', 'wrappedLine', 'page', 'halfPage', 'editor'
    • 'value': 移動的單位數量。預設為 '1'。
    • 'revealCursor': 若為 'true'，且游標在視埠之外時會顯示游標。

revealLine - 在指定的邏輯位置顯示指定的行

  • 顯示行引數物件 - 可以透過此引數傳遞的屬性-值對
    • 'lineNumber': 必要，行號值。
    • 'at': 顯示該行所需的邏輯位置。
      'top', 'center', 'bottom'

editor.unfold - 展開編輯器中的內容

  • 編輯器展開引數 - 可以透過此引數傳遞的屬性-值對
    • 'levels': 要展開的層級數。若未設定，預設為 1。
    • 'direction': 若為 'up'，向上展開指定層級數；否則向下展開。
    • 'selectionLines': 要套用展開動作的編輯器選取範圍開始行陣列（從 0 開始）。若未設定，將使用當前選取範圍。

editor.fold - 摺疊編輯器中的內容

  • 編輯器摺疊引數 - 可以透過此引數傳遞的屬性-值對
    • 'levels': 要摺疊的層級數。
    • 'direction': 若為 'up'，向上摺疊指定層級數；否則向下摺疊。
    • 'selectionLines': 要套用摺疊動作的編輯器選取範圍開始行陣列（從 0 開始）。若未設定，將使用當前選取範圍。如果未設定層級或方向，則會摺疊位於該位置的區域；如果已摺疊，則改為摺疊第一個未摺疊的父級。

editor.toggleFold - 根據當前狀態摺疊或展開編輯器中的內容

editor.actions.findWithArgs - 使用特定選項開啟新的編輯器內搜尋小工具。

  • searchString - 預填搜尋輸入框的字串
  • replaceString - 預填取代輸入框的字串
  • isRegex - 啟用規則運算式
  • preserveCase - 取代時嘗試保留大小寫
  • findInSelection - 將搜尋範圍限制在當前選取範圍
  • matchWholeWord
  • isCaseSensitive

editor.action.goToLocations - 從檔案中的某個位置跳轉到位置

  • uri - 要開始的文字文件
  • position - 要開始的位置
  • locations - 位置陣列。
  • multiple - 定義多個結果時的處理方式，可為 peek、gotoAndPeek 或 goto
  • noResultsMessage - 當位置陣列為空時顯示的人類可讀訊息。

editor.action.peekLocations - 從檔案中的某個位置預覽位置

  • uri - 要開始的文字文件
  • position - 要開始的位置
  • locations - 位置陣列。
  • multiple - 定義多個結果時的處理方式，可為 peek、gotoAndPeek 或 goto

workbench.action.quickOpen - 快速存取

  • prefix -

notebook.cell.toggleOutputs - 切換輸出

  • options - 單元格範圍選項

notebook.fold - 摺疊單元格

  • index - 單元格索引

notebook.unfold - 展開單元格

  • index - 單元格索引

notebook.selectKernel - Notebook 核心引數

  • kernelInfo - 核心資訊

notebook.cell.changeLanguage - 變更單元格語言

  • range - 單元格範圍
  • language - 目標單元格語言

notebook.execute - 執行全部

  • uri - 文件 URI

notebook.cell.execute - 執行單元格

  • options - 單元格範圍選項

notebook.cell.executeAndFocusContainer - 執行單元格並聚焦容器

  • options - 單元格範圍選項

notebook.cell.cancelExecution - 停止單元格執行

  • options - 單元格範圍選項

workbench.action.findInFiles - 開啟工作區搜尋

  • 搜尋選項組 -

_interactive.open - 開啟互動式視窗

  • showOptions - 顯示選項
  • resource - 互動式資源 URI
  • controllerId - Notebook 控制器 ID
  • title - Notebook 編輯器標題

interactive.execute - 執行輸入框中的內容

  • resource - 互動式資源 URI

search.action.openNewEditor - 開啟新的搜尋編輯器。傳入的引數可包含變數，如 ${relativeFileDirname}。

  • 開啟新搜尋編輯器引數 -

search.action.openEditor - 開啟新的搜尋編輯器。傳入的引數可包含變數，如 ${relativeFileDirname}。

  • 開啟新搜尋編輯器引數 -

search.action.openNewEditorToSide - 開啟新的搜尋編輯器。傳入的引數可包含變數，如 ${relativeFileDirname}。

  • 開啟新搜尋編輯器引數 -

vscode.openFolder - 在當前視窗或新視窗中開啟資料夾或工作區（視 newWindow 引數而定）。請注意，除非 newWindow 參數設為 true，否則在同一個視窗開啟會關閉當前擴充功能主機處理序，並在給定的資料夾/工作區啟動新的處理序。

  • uri - (選用) 要開啟的資料夾或工作區檔案的 URI。若未提供，將會跳出原生對話框詢問使用者。
  • options - (選用) 選項。物件包含以下屬性：forceNewWindow：是否在新視窗中開啟資料夾/工作區。預設為在同一個視窗開啟。forceReuseWindow：是否強制在同一個視窗開啟資料夾/工作區。預設為 false。noRecentEntry：開啟的 URI 是否出現在「最近開啟」列表中。預設為 false。注意，為了向下相容，選項也可以是布林值，代表 forceNewWindow 設定。

vscode.newWindow - 視 newWindow 引數而定，開啟一個新視窗。

  • options - (選用) 選項。物件包含以下屬性：reuseWindow：是否開啟新視窗或是重複使用同一個視窗。預設為開啟新視窗。

vscode.removeFromRecentlyOpened - 從最近開啟列表中移除具有給定路徑的項目。

  • path - 要從最近開啟中移除的 URI 或 URI 字串。

moveActiveEditor - 按標籤頁或分組移動當前編輯器

  • 當前編輯器移動引數 - 引數屬性
    • 'to': 提供移動位置的字串值。
    • 'by': 提供移動單位的字串值 (按標籤頁或按分組)。
    • 'value': 提供移動多少位置或絕對位置的數值。

copyActiveEditor - 按分組複製當前編輯器

  • 當前編輯器複製引數 - 引數屬性
    • 'to': 提供複製位置的字串值。
    • 'value': 提供複製多少位置或絕對位置的數值。

vscode.getEditorLayout - 取得編輯器版面配置

  • (傳回值) - 編輯器版面配置物件，格式與 vscode.setEditorLayout 相同

workbench.action.files.newUntitledFile - 新增未命名文字檔案

  • 新增未命名文字檔案引數 - 若已知的話，為編輯器檢視類型或語言 ID

workbench.extensions.installExtension - 安裝指定的擴充功能

  • extensionIdOrVSIXUri - 擴充功能 ID 或 VSIX 資源 URI
  • options - (選用) 安裝擴充功能的選項。物件包含以下屬性：installOnlyNewlyAddedFromExtensionPackVSIX：啟用時，VS Code 僅安裝擴充功能包 VSIX 中新增的擴充功能。此選項僅在安裝 VSIX 時考慮。

workbench.extensions.uninstallExtension - 解除安裝指定的擴充功能

  • 要解除安裝的擴充功能 ID -

workbench.extensions.search - 搜尋特定擴充功能

  • 搜尋使用的查詢字串 -

workbench.action.tasks.runTask - 執行工作

  • args - 過濾快速選擇選單中顯示的工作

workbench.action.openIssueReporter - 開啟問題回報器，並可選擇預填部分表單。

  • options - 用於預填問題回報器的資料。

vscode.openIssueReporter - 開啟問題回報器，並可選擇預填部分表單。

  • options - 用於預填問題回報器的資料。

workbench.action.openLogFile - workbench.action.openLogFile

  • logFile -

workbench.action.openWalkthrough - 開啟導覽教學 (Walkthrough)。

  • walkthroughID - 要開啟的導覽教學 ID。
  • toSide - 在側邊的新編輯器分組中開啟導覽教學。

簡易指令

無需參數的簡易指令可在預設 keybindings.json 檔案的鍵盤快速鍵清單中找到。未繫結的指令列在檔案底部的註解區塊中。

若要檢視預設的 keybindings.json，請從指令選擇區執行 Preferences: Open Default Keyboard Shortcuts (JSON) (⇧⌘P (Windows, Linux Ctrl+Shift+P))。

5/28/2026
English 한국어 中文(简体) 中文(繁體)
© . This site is unofficial and not affiliated with Microsoft.