VS Codeで使えるcodeコマンドについて

1 min read読了の目安(約1600字

公式ドキュメント:

https://code.visualstudio.com/docs/editor/command-line#_command-line-help

概要

code コマンドを利用して、プロジェクトのファイル操作や、拡張機能の管理、トラブルシューティングなどを実行できる。

利用方法

VS Codeアプリをインストールすれば利用できる。
Macの場合、加えて Shell Command: Install code command in PATH を実行する。 command + shift P で見つかる。他にも何かつまづいたらこちらを参考に。

https://code.visualstudio.com/docs/setup/mac

code -h を入力するとヘルプが表示される。詳しい機能についてはそちらを。
Visual Studio Code 1.52.1 時点ではこのようになっている。

主な機能

フォルダやファイルを新しいVS Codeウィンドウで開く

コマンドライン操作中に、VS Codeでちょっと編集したくなった時に。

code -n <file or folder>

フォルダやファイルをまとめて開く(新規作成する)

指定したパスで中間ディレクトリが存在しなければ、保存時にそのままフォルダも作成してくれる。深い階層のファイルを作りたいときに便利。
単に既存のファイルを開くならVS Code側で command + P 検索したほうが早い。

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

2つのファイルの差分を表示する

オプション -d -diff を入力し、比較したいファイル2つを指定するとサクッと差分を確認できる。

code -d index.html index2.html

拡張機能を管理する

コマンド 内容
code --install-extension <ext> 拡張機能をインストールする
code --uninstall-extension <ext> 拡張機能をアンインストールする
code --list-extensions インストールされている拡張機能をリストアップする
code --list-extensions --show-versions インストールされている拡張機能をバージョンつきでリストアップする
code --enable-proposed-api <ext> 提案された拡張機能APIを有効にする

トラブルシューティング

コマンド 内容
code -v VS Codeのバージョンを表示する
code --disable-extensions インストールされているすべての拡張機能を無効にする
code --disable-extension <extension-id> 拡張機能を無効にする
code -sync <on> <off> 同期をオンまたはオフにする
code --disable-gpu GPU ハードウェアアクセラレーションを無効にする