コマンドラインインターフェース (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 を起動するときに使用できるオプションの引数を以下に示します

ファイルとフォルダを開く

ファイルを開いたり作成したりすることがあります。指定されたファイルが存在しない場合、VS Code は新しい中間フォルダと共にファイルを作成します

code index.html style.css documentation\readme.md

ファイルとフォルダの両方で、絶対パスまたは相対パスを使用できます。相対パスは、code を実行するコマンドプロンプトの現在のディレクトリからの相対パスです。

コマンドラインで複数のファイルを指定すると、VS Code は単一のインスタンスのみを開きます。

コマンドラインで複数のフォルダを指定すると、VS Code は各フォルダを含むマルチルートワークスペースを作成します。

プロファイルを選択する

--profile コマンドラインインターフェースオプションを使用して、特定のプロファイルで VS Code を起動できます。--profile 引数の後にプロファイルの名前を渡し、そのプロファイルを使用してフォルダまたはワークスペースを開きます。以下のコマンドラインは、「Web 開発」プロファイルで web-sample フォルダを開きます

code ~/projects/web-sample --profile "Web 開発"

指定されたプロファイルが存在しない場合は、指定された名前の新しい空のプロファイルが作成されます。

拡張機能の操作

コマンドラインから VS Code 拡張機能をインストールおよび管理できます。

高度な CLI オプション

エラーの再現や高度なセットアップに役立つ CLI オプションがいくつかあります。

リモートトンネルを作成する

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 ダウンロードページ からスタンドアロンインストールすることもできます。

リモートトンネルの詳細については、リモートトンネルのドキュメント を参照してください。

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 では、シェルコマンド: 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 値を確認できます。