コマンド ライン インターフェース (CLI)
Visual Studio Code には、エディターの起動方法を制御できる強力なコマンドライン インターフェースが組み込まれています。コマンドライン オプション (スイッチ) を使用して、ファイルを開いたり、拡張機能をインストールしたり、表示言語を変更したり、診断情報を出力したりできます。
VS Code内でコマンドライン ツールを実行する方法については、統合ターミナルを参照してください。
コマンドライン ヘルプ
VS Code コマンドライン インターフェースの概要を確認するには、ターミナルまたはコマンド プロンプトを開き、code --help と入力します。バージョン、使用例、およびコマンドライン オプションの一覧が表示されます。
コマンドラインからの起動
コマンドラインから VS Code を起動して、ファイル、フォルダー、またはプロジェクトをすばやく開くことができます。通常は、フォルダーのコンテキスト内で VS Code を開きます。これを行うには、開いているターミナルまたはコマンド プロンプトから、プロジェクト フォルダーに移動して code . と入力します。
注: macOS のユーザーは、まずコマンド (シェル コマンド: PATH 内に 'code' コマンドをインストールします) を実行して、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-way マージを実行します。 |
-w または --wait |
ファイルが閉じられるまで待ってから戻ります。 |
--locale <locale> |
VS Code セッションの表示言語 (ロケール) を設定します。(例: en-US または zh-TW) |
ファイルとフォルダーを開く
ファイルを開いたり作成したりしたい場合があります。指定したファイルが存在しない場合、VS Code は新しい中間フォルダーと共にファイルを作成します。
code index.html style.css documentation\readme.md
ファイルとフォルダーの両方で、絶対パスまたは相対パスを使用できます。相対パスは、code を実行するコマンド プロンプトの現在のディレクトリを基準とします。
コマンドラインで複数のファイルを指定した場合、VS Code は 1 つのインスタンスのみを開きます。
コマンドラインで複数のフォルダーを指定した場合、VS Code は各フォルダーを含むマルチ ルート ワークスペースを作成します。
| 引数 | 説明 |
|---|---|
ファイル |
開くファイルの名前。ファイルが存在しない場合は作成され、編集済みとしてマークされます。各ファイル名をスペースで区切ることにより、複数のファイルを指定できます。 |
file:line[:character] |
-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 引数を使用します。特定のプロファイルにインストールするには --profile 引数を使用します。 |
--uninstall-extension <extension-id> |
拡張機能をアンインストールします。引数として完全な拡張機能名 publisher.extension を指定します。特定のプロファイルからアンインストールするには --profile 引数を使用します。 |
--disable-extensions |
インストールされているすべての拡張機能を無効にします。拡張機能は拡張機能ビューの無効セクションに表示されますが、アクティブ化されることはありません。 |
--list-extensions |
インストールされている拡張機能を一覧表示します。特定のプロファイルの一覧を表示するには --profile 引数を使用できます。 |
--show-versions |
--list-extensions を使用する際に、インストールされている拡張機能のバージョンを表示します。 |
--enable-proposed-api <ext> |
拡張機能の proposed API 機能を有効にします。引数として完全な拡張機能名 publisher.extension を指定します。 |
--update-extensions |
インストール済みの拡張機能を更新して終了します。 |
高度な CLI オプション
エラーの再現や高度な設定に役立つ CLI オプションがいくつかあります。
| 引数 | 説明 |
|---|---|
--extensions-dir <dir> |
拡張機能のルート パスを設定します。 ポータブル モードでは、 data フォルダーによって上書きされます。 |
--user-data-dir <dir> |
ユーザー データが保持されるディレクトリを指定します。root として実行する場合に便利です。 ポータブル モードでは、 data フォルダーによって上書きされます。 |
-s, --status |
プロセスの使用状況と診断情報を出力します。 |
-p, --performance |
開発者: Startup Performance コマンドを有効にして起動します。 |
--disable-gpu |
GPU ハードウェア アクセラレーションを無効にします。 |
--verbose |
詳細な出力を表示します (--wait を含みます)。 |
--prof-startup |
起動中に CPU プロファイラーを実行します。 |
--upload-logs |
現在のセッションのログをセキュアなエンドポイントにアップロードします。 |
| マルチ ルート | |
--add <dir> |
マルチ ルート ワークスペースのために、最後にアクティブだったウィンドウにフォルダーを追加します。 |
--remove <dir> |
マルチ ルート ワークスペースのために、最後にアクティブだったウィンドウからフォルダーを削除します。 |
リモート トンネルの作成
VS Code は他のリモート環境と統合することで、さらに強力かつ柔軟になります。私たちの目標は、ローカルとリモートの両方のマシンを 1 つの統一された 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 ダウンロード ページ でスタンドアロン インストール用にも提供されています。
Remote Tunnels の詳細については、Remote Tunnels のドキュメント をご覧ください。
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 を見つけられません。Windows および Linux の VS Code インストールでは、VS Code がパスにインストールされているはずです。VS Code をアンインストールしてから再インストールしてみてください。それでも code が見つからない場合は、Windows と Linux のプラットフォーム固有のセットアップ トピックを参照してください。
macOS では、手動でシェル コマンド: PATH に 'code' コマンドをインストールしますコマンドを実行する必要があります (コマンド パレット ⇧⌘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 の値を確認できます。