🚀 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);

注: VS Code コマンドの完全なセットは、キーボードショートカットエディター (ファイル > 設定 > キーボードショートカット) で確認できます。キーボードショートカットエディターには、VS Code に組み込まれている、または拡張機能によって提供されているすべてのコマンドが、キーバインドと表示条件の when 句とともにリストされています。

コマンド

vscode.executeDataToNotebook - ノートブックシリアライザーを呼び出す

  • notebookType - ノートブックタイプ
  • data - データに変換するバイト
  • (戻り値) - ノートブックデータ

vscode.executeNotebookToData - ノートブックシリアライザーを呼び出す

  • notebookType - ノートブックタイプ
  • NotebookData - バイトに変換するノートブックデータ
  • (戻り値) - バイト

notebook.selectKernel - 指定されたノートブックエディターウィジェットのカーネルピッカーをトリガーする

  • options - カーネル選択オプション
  • (戻り値) - 結果なし

interactive.open - インタラクティブウィンドウを開き、ノートブックエディターと入力 URI を返す

  • showOptions - 表示オプション
  • resource - インタラクティブリソース URI
  • controllerId - ノートブックコントローラー ID
  • title - インタラクティブエディタータイトル
  • (戻り値) - ノートブックと入力 URI

vscode.editorChat.start - 新しいエディターチャットセッションを開始する

  • 実行引数 -
  • (戻り値) - 結果なし

vscode.executeDocumentHighlights - ドキュメントハイライトプロバイダーを実行します。

  • uri - テキストドキュメントの URI
  • position - テキストドキュメント内の位置
  • (戻り値) - DocumentHighlight インスタンスの配列に解決される Promise。

vscode.executeDocumentSymbolProvider - ドキュメントシンボルプロバイダーを実行します。

  • uri - テキストドキュメントの URI
  • (戻り値) - SymbolInformation および DocumentSymbol インスタンスの配列に解決される Promise。

vscode.executeFormatDocumentProvider - ドキュメントフォーマットプロバイダーを実行します。

  • uri - テキストドキュメントの URI
  • options - フォーマットオプション
  • (戻り値) - TextEdit の配列に解決される Promise。

vscode.executeFormatRangeProvider - 範囲フォーマットプロバイダーを実行します。

  • uri - テキストドキュメントの URI
  • range - テキストドキュメント内の範囲
  • options - フォーマットオプション
  • (戻り値) - TextEdit の配列に解決される Promise。

vscode.executeFormatOnTypeProvider - タイプ入力時フォーマットプロバイダーを実行します。

  • uri - テキストドキュメントの URI
  • position - テキストドキュメント内の位置
  • ch - トリガー文字
  • options - フォーマットオプション
  • (戻り値) - TextEdit の配列に解決される 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 - コードレンズプロバイダーを実行します。

  • uri - テキストドキュメントの URI
  • itemResolveCount - (オプション) 解決して返す必要があるレンズの数。解決済みのレンズのみを返し、パフォーマンスに影響を与えます
  • (戻り値) - CodeLens インスタンスの配列に解決される Promise。

vscode.executeCodeActionProvider - コードアクションプロバイダーを実行します。

  • uri - テキストドキュメントの URI
  • rangeOrSelection - テキストドキュメント内の範囲。一部のリファクタリングプロバイダーには Selection オブジェクトが必要です。
  • kind - (オプション) コードアクションを返すコードアクションの種類
  • itemResolveCount - (オプション) 解決するコードアクションの数 (数が多すぎるとコードアクションが遅くなる)
  • (戻り値) - Command インスタンスの配列に解決される Promise。

vscode.executeDocumentColorProvider - ドキュメントカラープロバイダーを実行します。

  • uri - テキストドキュメントの URI
  • (戻り値) - ColorInformation オブジェクトの配列に解決される Promise。

vscode.executeColorPresentationProvider - カラープレゼンテーションプロバイダーを実行します。

  • color - 表示および挿入する色
  • context - URI と範囲を持つコンテキストオブジェクト
  • (戻り値) - ColorPresentation オブジェクトの配列に解決される Promise。

vscode.executeInlayHintProvider - インレイヒントプロバイダーを実行する

  • uri - テキストドキュメントの URI
  • range - テキストドキュメント内の範囲
  • (戻り値) - Inlay オブジェクトの配列に解決される Promise

vscode.executeFoldingRangeProvider - 折りたたみ範囲プロバイダーを実行する

  • uri - テキストドキュメントの URI
  • (戻り値) - FoldingRange オブジェクトの配列に解決される Promise

vscode.resolveNotebookContentProviders - ノートブックコンテンツプロバイダーを解決する

  • (戻り値) - NotebookContentProvider 静的情報オブジェクトの配列に解決される Promise。

vscode.executeInlineValueProvider - インライン値プロバイダーを実行する

  • uri - テキストドキュメントの URI
  • range - テキストドキュメント内の範囲
  • context - InlineValueContext
  • (戻り値) - InlineValue オブジェクトの配列に解決される Promise

vscode.open - 提供されたリソースをエディターで開きます。テキストファイル、バイナリファイル、または http(s) URL を指定できます。テキストファイルを開くためのオプションをより細かく制御する必要がある場合は、代わりに vscode.window.showTextDocument を使用してください。

  • uri - テキストファイルまたはバイナリファイル、または http(s) URL の URI
  • columnOrOptions - (オプション) 開く列、またはエディターオプション (vscode.TextDocumentShowOptions を参照)
  • label - エディターラベル (オプション)
  • (戻り値) - 結果なし

vscode.openWith - 提供されたリソースを特定のエディターで開きます。

  • resource - 開くリソース
  • viewId - カスタムエディタービュー ID または VS Code のデフォルトエディターを使用する場合は 'default'
  • 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 - コンテキストキー値
  • (戻り値) - 結果なし

vscode.executeMappedEditsProvider - マップされた編集プロバイダーを実行する

  • uri - テキストドキュメントの URI
  • string_array - 文字列の配列、
  • MappedEditsContext - マップされた編集コンテキスト
  • (戻り値) - ワークスペース編集または null に解決される Promise

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 - ノートブックカーネル引数

  • 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 - ノートブックコントローラー ID
  • title - ノートブックエディタータイトル

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 です。後方互換性のため、オプションは boolean 型にすることもでき、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 - Issue Reporter を開き、オプションでフォームの一部を事前に入力します。

  • options - Issue Reporter に事前入力するために使用するデータ。

vscode.openIssueReporter - Issue Reporter を開き、オプションでフォームの一部を事前に入力します。

  • options - Issue Reporter に事前入力するために使用するデータ。

workbench.action.openLogFile - workbench.action.openLogFile

  • logFile -

workbench.action.openWalkthrough - チュートリアルを開きます。

  • walkthroughID - 開くチュートリアルの ID。
  • toSide - サイドの新しいエディターグループでチュートリアルを開きます。

シンプルなコマンド

パラメーターを必要としないシンプルなコマンドは、デフォルトの keybindings.json ファイルのキーボードショートカットリストにあります。バインドされていないコマンドは、ファイルの最後にコメントブロックでリストされています。

デフォルトの keybindings.json を確認するには、コマンドパレットから 基本設定: デフォルトのキーボードショートカットを開く (JSON) を実行します (⇧⌘P (Windows, Linux Ctrl+Shift+P))。

04/03/2025