コマンドラインインターフェース (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 プレビューを使用している場合、Insiders ビルドは
code-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 <locale> |
VS Code セッションの表示言語 (ロケール) を設定します。(例: en-US または zh-TW) |
ファイルとフォルダーを開く
ファイルを開いたり作成したりしたい場合があります。指定されたファイルが存在しない場合、VS Code は新しい中間フォルダーとともにそれらを作成します。
code index.html style.css documentation\readme.md
ファイルとフォルダーの両方で、絶対パスまたは相対パスを使用できます。相対パスは、code を実行するコマンドプロンプトの現在のディレクトリからの相対パスです。
コマンドラインで複数のファイルを指定した場合、VS Code は単一のインスタンスのみを開きます。
コマンドラインで複数のフォルダーを指定した場合、VS Code は各フォルダーを含むマルチルートワークスペースを作成します。
| 引数 | 説明 |
|---|---|
ファイル |
開くファイルの名前。ファイルが存在しない場合、ファイルは作成され、編集済みとしてマークされます。各ファイル名をスペースで区切ることにより、複数のファイルを指定できます。 |
file:line[:character] |
-g 引数と共に使用します。指定された行とオプションの文字位置で開くファイルの名前。 |
フォルダー |
開くフォルダーの名前。複数のフォルダーを指定でき、新しいマルチルートワークスペースが作成されます。 |
プロファイルの選択
--profile コマンドラインインターフェースオプションを使用して、特定のプロファイルで VS Code を起動できます。--profile 引数の後にプロファイルの名前を渡し、そのプロファイルを使用してフォルダーまたはワークスペースを開きます。以下のコマンドラインは、"Web Development" プロファイルで web-sample フォルダーを開きます。
code ~/projects/web-sample --profile "Web Development"
指定されたプロファイルが存在しない場合、指定された名前で新しい空のプロファイルが作成されます。
拡張機能の操作
コマンドラインから VS Code の拡張機能をインストールおよび管理できます。
| 引数 | 説明 |
|---|---|
|
拡張機能をインストールまたは更新します。引数として完全な拡張機能名 publisher.extension または VSIX ファイルへのパスのいずれかを指定します。特定のバージョンをインストールするには、@{version} を追加します。例: vscode.csharp@1.2.3。プロンプトを回避するには --force 引数を使用します。特定のプロファイルにインストールするには --profile 引数を使用します。 |
|
拡張機能をアンインストールします。引数として完全な拡張機能名 publisher.extension を指定します。特定のプロファイルからアンインストールするには --profile 引数を使用します。 |
|
インストールされているすべての拡張機能を無効にします。拡張機能は拡張機能ビューの無効セクションに表示されたままですが、アクティブ化されることはありません。 |
|
インストールされている拡張機能を一覧表示します。特定のプロファイルの拡張機能を一覧表示するには --profile 引数を使用できます。 |
|
--list-extensions を使用する際に、インストールされている拡張機能のバージョンを表示します。 |
|
拡張機能の提案された API 機能を有効にします。引数として完全な拡張機能名 publisher.extension を指定します。 |
|
インストールされている拡張機能を更新して終了します。 |
高度な CLI オプション
エラーの再現や高度な設定に役立つ CLI オプションがいくつかあります。
| 引数 | 説明 |
|---|---|
|
拡張機能のルートパスを設定します。 ポータブルモードでは、 data フォルダーによって上書きされます。 |
|
ユーザーデータが保持されるディレクトリを指定します。root として実行する場合に便利です。 ポータブルモードでは、 data フォルダーによって上書きされます。 |
|
プロセス使用状況と診断情報を表示します。 |
|
開発者: 起動パフォーマンス コマンドを有効にして起動します。 |
|
GPU ハードウェアアクセラレーションを無効にします。 |
|
詳細な出力を表示します (--wait を暗示します)。 |
|
起動時に CPU プロファイラーを実行します。 |
|
現在のセッションのログを安全なエンドポイントにアップロードします。 |
| マルチルート | |
|
マルチルートワークスペース用に、最後にアクティブだったウィンドウにフォルダーを追加します。 |
|
マルチルートワークスペース用に、最後にアクティブだったウィンドウからフォルダーを削除します。 |
リモートトンネルの作成
VS Code は他のリモート環境と統合することで、さらに強力かつ柔軟になります。私たちの目標は、ローカルマシンとリモートマシンの両方を1つの統合された CLI から管理できる、まとまりのあるエクスペリエンスを提供することです。
Visual Studio Code のRemote - Tunnels拡張機能を使用すると、デスクトップ PC や VM などのリモートマシンにセキュアなトンネルを介して接続できます。トンネリングは、あるネットワークから別のネットワークへデータを安全に送信します。これにより、SSH を必要とせずに、どこからでもそのマシンに安全に接続できます。
リモートマシンでトンネルを開始する機能を code CLI に組み込みました。以下を実行できます。
code tunnel
リモートマシン上にトンネルを作成します。このマシンには、Web またはデスクトップ版の VS Code クライアントを介して接続できます。
他のトンネリングコマンドは code tunnel -help を実行することで確認できます。
VS Code デスクトップ版をインストールできないリモートマシンで 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://{full path to file} として渡したりできます。
注意: 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 では、シェルコマンド: 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 の値を確認できます。