コマンドラインインターフェース (CLI)
Visual Studio Codeには、エディターの起動方法を制御できる強力なコマンドラインインターフェースが組み込まれています。コマンドラインオプション（スイッチ）を使用して、ファイルを開いたり、拡張機能をインストールしたり、表示言語を変更したり、診断を出力したりできます。
VS Code内でコマンドラインツールを実行する方法をお探しの場合は、統合ターミナルをご覧ください。
コマンドラインヘルプ
VS Codeのコマンドラインインターフェースの概要については、ターミナルまたはコマンドプロンプトを開き、code --helpと入力してください。バージョン、使用例、およびコマンドラインオプションのリストが表示されます。
コマンドラインからの起動
コマンドラインからVS Codeを起動して、ファイル、フォルダー、またはプロジェクトをすばやく開くことができます。通常、フォルダーのコンテキスト内でVS Codeを開きます。これを行うには、開いているターミナルまたはコマンドプロンプトから、プロジェクトフォルダーに移動し、code .と入力します。
注: macOSのユーザーは、最初にコマンド（Shell Command: Install 'code' command in PATH）を実行して、VS Code実行可能ファイルをPATH環境変数に追加する必要があります。ヘルプについては、macOSセットアップガイドをお読みください。
WindowsおよびLinuxのインストールでは、VS Codeバイナリの場所をシステムパスに追加する必要があります。そうでない場合は、Path環境変数（Linuxの場合は$PATH）に手動で場所を追加できます。たとえば、Windowsでは、デフォルトのVS Codeバイナリの場所はAppData\Local\Programs\Microsoft VS Code\binです。プラットフォーム固有のセットアップ手順を確認するには、セットアップを参照してください。
Insiders: VS Code Insidersプレビューを使用している場合は、
code-insidersでInsidersビルドを起動します。
コアCLIオプション
以下は、codeを介してコマンドラインでVS Codeを起動するときに使用できるオプションの引数です。
| 引数 | 説明 |
|---|---|
-h または --help |
使用方法を出力 |
-v または --version |
VS Codeのバージョン（例：1.22.2）、GitHubコミットID、およびアーキテクチャ（例：x64）を出力します。 |
-n または --new-window |
以前のセッションを復元する代わりに、VS Codeの新しいセッションを開きます（デフォルト）。 |
-r または --reuse-window |
ファイルまたはフォルダーを最後にアクティブだったウィンドウで強制的に開きます。 |
-g または --goto |
file:line{:character}とともに使用すると、特定の行とオプションの文字位置でファイルを開きます。この引数は、一部のオペレーティングシステムでファイル名に:が許可されているため提供されています。 |
-d または --diff <file1> <file2> |
ファイル差分エディターを開きます。引数として2つのファイルパスが必要です。 |
-m または --merge <path1> <path2> <base> <result> |
ファイルの2つの変更されたバージョン、両方の変更されたバージョンの共通の起源、およびマージ結果を保存する出力ファイルのパスを提供することにより、3方向マージを実行します。 |
-w または --wait |
ファイルが閉じられるまで待機してから戻ります。 |
--locale <ロケール> |
VS Codeセッションの表示言語（ロケール）を設定します。（例：en-USまたはzh-TW） |
ファイルとフォルダーを開く
ファイルを開いたり作成したりする必要がある場合があります。指定されたファイルが存在しない場合、VS Codeは新しい中間フォルダーとともにそれらを作成します。
code index.html style.css documentation\readme.md
ファイルとフォルダーの両方で、絶対パスまたは相対パスを使用できます。相対パスは、codeを実行するコマンドプロンプトの現在のディレクトリからの相対パスです。
コマンドラインで複数のファイルを指定した場合、VS Codeは単一のインスタンスのみを開きます。
コマンドラインで複数のフォルダーを指定した場合、VS Codeは各フォルダーを含むマルチルートワークスペースを作成します。
| 引数 | 説明 |
|---|---|
ファイル |
開くファイルの名前。ファイルが存在しない場合は、作成され、編集済みとしてマークされます。各ファイル名をスペースで区切ることで、複数のファイルを指定できます。 |
ファイル:行[:文字] |
-g引数とともに使用されます。指定された行とオプションの文字位置で開くファイルの名前。 |
フォルダー |
開くフォルダーの名前。複数のフォルダーを指定でき、新しいマルチルートワークスペースが作成されます。 |
プロファイルを選択
--profileコマンドラインインターフェースオプションを使用して、特定のプロファイルでVS Codeを起動できます。--profile引数の後にプロファイルの名前を渡し、そのプロファイルを使用してフォルダーまたはワークスペースを開きます。以下のコマンドラインは、「Web Development」プロファイルでweb-sampleフォルダーを開きます。
code ~/projects/web-sample --profile "Web Development"
指定されたプロファイルが存在しない場合は、指定された名前の新しい空のプロファイルが作成されます。
拡張機能の操作
コマンドラインからVS Codeの拡張機能をインストールおよび管理できます。
| 引数 | 説明 |
|---|---|
--install-extension <extension-id> | <extension-vsix-path> |
拡張機能をインストールまたは更新します。完全な拡張機能名publisher.extensionまたはVSIXファイルへのパスを引数として指定します。特定のバージョンをインストールするには、@{version}を追加します。例：vscode.csharp@1.2.3。プロンプトを回避するには、--force引数を使用します。 |
--uninstall-extension <extension-id> |
拡張機能をアンインストールします。完全な拡張機能名publisher.extensionを引数として指定します。 |
--disable-extensions |
インストールされているすべての拡張機能を無効にします。拡張機能は、拡張機能ビューの無効セクションに引き続き表示されますが、アクティブ化されることはありません。 |
--list-extensions |
インストールされている拡張機能を一覧表示します。 |
--show-versions |
--list-extensionsを使用する場合、インストールされている拡張機能のバージョンを表示します。 |
--enable-proposed-api <ext> |
拡張機能の提案されたAPI機能を有効にします。完全な拡張機能名publisher.extensionを引数として指定します。 |
--update-extensions |
インストールされている拡張機能を更新して終了します。 |
高度なCLIオプション
エラーの再現と高度なセットアップに役立つCLIオプションがいくつかあります。
| 引数 | 説明 |
|---|---|
--extensions-dir <dir> |
拡張機能のルートパスを設定します。 ポータブルモードでは、 dataフォルダーによってオーバーライドされます。 |
--user-data-dir <dir> |
ユーザーデータが保存されるディレクトリを指定します。ルートとして実行する場合に役立ちます。 ポータブルモードでは、 dataフォルダーによってオーバーライドされます。 |
-s, --status |
プロセス使用量と診断情報を出力します。 |
-p, --performance |
開発者: 起動パフォーマンスコマンドを有効にして起動します。 |
--disable-gpu |
GPUハードウェアアクセラレーションを無効にします。 |
--verbose |
詳細な出力を出力します（--waitを暗黙的に指定）。 |
--prof-startup |
起動中にCPUプロファイラーを実行します。 |
--upload-logs |
現在のセッションのログを安全なエンドポイントにアップロードします。 |
| マルチルート | |
--add <dir> |
マルチルートワークスペースの最後のアクティブなウィンドウにフォルダーを追加します。 |
--remove <dir> |
マルチルートワークスペースの最後のアクティブなウィンドウからフォルダーを削除します。 |
リモートトンネルの作成
VS Codeは、他のリモート環境と統合して、さらに強力で柔軟になります。私たちの目標は、ローカルマシンとリモートマシンの両方を単一の統合されたCLIから管理できるまとまりのあるエクスペリエンスを提供することです。
Visual Studio Code Remote - Tunnels拡張機能を使用すると、セキュアトンネルを介して、デスクトップPCやVMなどのリモートマシンに接続できます。トンネリングは、あるネットワークから別のネットワークにデータを安全に送信します。SSHの要件なしに、どこからでもそのマシンに安全に接続できます。
リモートマシンでトンネルを開始するcode CLIに機能が組み込まれています。実行できます
code tunnel
リモートマシンにトンネルを作成します。WebまたはデスクトップのVS Codeクライアントを介してこのマシンに接続できます。
他のトンネリングコマンドを確認するには、code tunnel -helpを実行してください。
VS Code DesktopをインストールできないリモートマシンでCLIを実行する必要がある場合があるため、CLIはVS Codeダウンロードページでスタンドアロンインストールも可能です。
リモートトンネルの詳細については、リモートトンネルのドキュメントを参照してください。
URLでVS Codeを開く
プラットフォームのURL処理メカニズムを使用して、プロジェクトとファイルを開くこともできます。次のURL形式を使用して
プロジェクトを開く
vscode://file/{full path to project}/
vscode://file/c:/myProject/
ファイルを開く
vscode://file/{full path to file}
vscode://file/c:/myProject/package.json
行と列を指定してファイルを開く
vscode://file/{full path to file}:line:column
vscode://file/c:/myProject/package.json:5:10
設定エディターを開く
vscode://settings/setting.name
vscode://settings/editor.wordWrap
URLを解析してリダイレクトできるブラウザーやファイルエクスプローラーなどのアプリケーションでURLを使用できます。たとえば、Windowsでは、vscode:// URLをWindowsエクスプローラーに直接渡すか、コマンドラインにstart vscode://{ファイルのフルパス}として渡すことができます。
注: VS Code Insidersビルドを使用している場合、URLプレフィックスは
vscode-insiders://です。
次のステップ
詳細については、以下をご覧ください。
- 統合ターミナル - VS Code内からコマンドラインツールを実行します。
- 基本的な編集 - VS Codeエディターの基本を学びます。
- コードナビゲーション - VS Codeを使用すると、ソースコードをすばやく理解して移動できます。
よくある質問
'code' は内部コマンドまたは外部コマンドとして認識されません
OSは、パス上のVS Codeバイナリcodeを見つけることができません。VS Code WindowsおよびLinuxインストールでは、VS Codeがパスにインストールされているはずです。VS Codeをアンインストールして再インストールしてみてください。codeがまだ見つからない場合は、WindowsおよびLinuxのプラットフォーム固有のセットアップトピックを参照してください。
macOSでは、Shell Command: Install 'code' command in PATHコマンドを手動で実行する必要があります（コマンドパレット ⇧⌘P (Windows、Linux Ctrl+Shift+P) から利用可能）。詳細については、macOS固有のセットアップトピックを参照してください。
VS Code内からコマンドライン（ターミナル）にアクセスするにはどうすればよいですか？
VS Codeには、VS Code内からコマンドラインツールを実行できる統合ターミナルがあります。
ポータブルバージョンにするために、VS Codeの設定場所を指定できますか？
コマンドラインから直接指定することはできませんが、VS Codeにはポータブルモードがあり、設定とデータをインストールと同じ場所（USBドライブなど）に保持できます。
VS Codeによってシェルが起動されたことを検出するにはどうすればよいですか？
VS Codeが起動すると、ツールをセットアップするために「シェル環境」をソースするためにシェルを起動する場合があります。これにより、インタラクティブログインシェルが起動し、その環境がフェッチされます。シェルのセットアップによっては、問題が発生する可能性があります。たとえば、シェルがインタラクティブセッションとして起動されるのは予期しない場合があり、VS Codeはユーザーが作成したターミナルの正確な値と$PATHを一致させようとするために必要です。
VS Codeがこの最初のシェルを起動すると、VS Codeは変数VSCODE_RESOLVING_ENVIRONMENTを1に設定します。シェルまたはユーザー スクリプトがこのシェルのコンテキストで実行されているかどうかを知る必要がある場合は、VSCODE_RESOLVING_ENVIRONMENTの値を確認できます。