MENU
contact

VSCodeで設定をエクスポートする方法

VSCode

採用はこちら

VSCode（Visual Studio Code）の設定を別のパソコンへ移行したい場合や、万が一に備えてバックアップしておきたい場合は、設定をエクスポートできます。

VSCodeには複数の設定移行方法があり、主に次のような方法があります。

  • Profilesをエクスポートする
  • Settings Syncで同期する
  • settings.jsonを手動でコピーする
  • .vscode/settings.jsonをプロジェクト単位で管理する

どの方法が適しているかは、設定だけを保存したいのか、拡張機能まで含めて環境全体を移行したいのかによって異なります。

一般的には、VSCodeの環境をまとめて移行したい場合はProfiles、複数のPCで同じ環境を継続的に使用したい場合はSettings Syncが便利です。

目次

Profilesを使ってVSCodeの設定をエクスポートする

Profilesとは

Profilesは、VSCodeの設定や拡張機能などを用途ごとにまとめて管理できる機能です。

たとえば、Web開発用、PHP開発用、Python開発用など、用途別に異なるVSCode環境を作成できます。

Profilesでは、主に次のような項目を管理できます。

  • Settings
  • Keyboard Shortcuts
  • MCP Servers
  • Snippets
  • Tasks
  • Extensions

そのため、VSCodeの設定だけではなく、拡張機能やキーボードショートカットなどもまとめて移行したい場合に適しています。

Profilesをエクスポートする手順

VSCodeでProfilesをエクスポートする場合は、まずProfilesの管理画面を開きます。

メニューから次の順番で選択します。

File
↓
Preferences
↓
Profiles

また、VSCode左下にあるManageメニューなどからProfilesを開くこともできます。

エクスポートしたいプロファイルを選択し、「Export…」を実行します。

エクスポート先として、ローカルファイルまたはGitHub Gistなどを選択できます。

.code-profile形式で保存できる

Profilesをローカルファイルとして保存すると、一般的に次のようなファイルになります。

my-vscode-profile.code-profile

.code-profileはVSCodeのプロファイルファイルです。

このファイルをUSBメモリやクラウドストレージなどに保存しておけば、別のパソコンへVSCode環境を移行できます。

たとえば、PCを買い替える場合は次のような流れになります。

旧PC
↓
Profilesをエクスポート
↓
.code-profileを保存
↓
新PCにVSCodeをインストール
↓
.code-profileをインポート

GitHub Gistへ保存することもできる

Profilesはローカルファイルだけでなく、GitHub Gistへエクスポートすることもできます。

GitHub Gistを利用すると、プロファイルをURL経由で共有しやすくなります。

複数のパソコンで同じプロファイルを使用したい場合や、ほかのユーザーへ設定を共有したい場合にも便利です。

ただし、Gistを利用する場合は共有URLの取り扱いに注意しましょう。

機密情報や個人情報を設定ファイルへ保存している場合は、内容を確認してから共有することが重要です。

エクスポートしたProfilesをインポートする方法

.code-profileファイルを読み込む

別のパソコンでエクスポートした設定を利用する場合は、.code-profileをインポートします。

Profilesの管理画面からImportを選択し、保存しておいた.code-profileファイルを指定します。

インポートする内容を確認して適用すれば、設定や拡張機能などを新しい環境へ移行できます。

ドラッグ＆ドロップでインポートする

現在のVSCodeでは、.code-profileファイルをVSCodeのウィンドウへドラッグ＆ドロップしてインポートすることもできます。

.code-profileをVSCodeへドラッグするとProfilesのインポート画面が開くため、内容を確認して適用します。

PC移行時には非常に分かりやすい方法です。

参考サイト

VSCodeの設定の切り替えや共有に便利なプロファイル機能を活用しよう #VSCode – Qiita

Settings Syncで設定を同期する

Settings Syncとは

Settings Syncは、VSCodeの設定をクラウド経由で複数のパソコン間に同期する機能です。

Profilesがファイルとして設定をエクスポートする方法なのに対し、Settings Syncは継続的に設定を同期したい場合に向いています。

Settings Syncでは、主に次のような情報を同期できます。

  • Settings
  • Keyboard Shortcuts
  • User Snippets
  • User Tasks
  • UI State
  • Extensions
  • Profiles

自宅PCとノートPCなど、複数の環境で同じVSCode設定を使用したい場合に便利です。

Settings Syncを有効にする

VSCodeのManageメニューやAccountsメニューから、

Backup and Sync Settings...

を選択します。

その後、VSCode上に表示される手順に従ってアカウントへサインインし、同期を有効にします。

Settings Syncを有効にすると、設定変更や拡張機能などがクラウド側と同期されます。

新しいPCでも同じ設定を使用できる

新しいPCへVSCodeをインストールしたあと、同じアカウントでSettings Syncを有効にすると、クラウド上に保存されている設定を利用できます。

既存のローカル設定とクラウド側の設定が異なる場合は、統合や置き換え、手動マージなどの選択肢が表示される場合があります。

既存の設定を残したい場合は、内容を確認してから同期することが重要です。

settings.jsonを手動でエクスポートする

settings.jsonとは

VSCodeのユーザー設定は、settings.jsonというJSONファイルに保存されています。

たとえば、次のような設定が保存されます。

{
    "editor.fontSize": 16,
    "editor.wordWrap": "on",
    "files.autoSave": "afterDelay",
    "editor.formatOnSave": true
}

設定だけを簡単にバックアップしたい場合は、settings.jsonをコピーする方法が便利です。

settings.jsonを開く方法

コマンドパレットを開きます。

Windows・Linuxの場合は、

Ctrl + Shift + P

macOSの場合は、

Command + Shift + P

を押します。

続いて、次のコマンドを検索して実行します。

Preferences: Open User Settings (JSON)

すると、ユーザー設定のsettings.jsonが開きます。

このファイルの内容をコピーして保存しておけば、設定のバックアップとして利用できます。

settings.jsonの保存場所

通常のユーザー設定

通常のユーザー設定は、OSごとに次の場所へ保存されています。

Windowsの場合は次の場所です。

%APPDATA%\Code\User\settings.json

macOSの場合は次の場所です。

$HOME/Library/Application Support/Code/User/settings.json

Linuxの場合は次の場所です。

$HOME/.config/Code/User/settings.json

これらのファイルをコピーすることでも、ユーザー設定をバックアップできます。

Profiles利用時のsettings.json

Profilesを利用している場合、プロファイル固有の設定は別の場所へ保存されます。

Windowsでは次のような場所です。

%APPDATA%\Code\User\profiles\<profile ID>\settings.json

macOSでは次のようになります。

$HOME/Library/Application Support/Code/User/profiles/<profile ID>/settings.json

Linuxでは次の場所です。

$HOME/.config/Code/User/profiles/<profile ID>/settings.json

なお、プロファイルを作成しただけで設定を変更していない場合は、そのプロファイル用のsettings.jsonがまだ作成されていないことがあります。

キーボードショートカットもバックアップする

keybindings.jsonに保存されている

カスタマイズしたキーボードショートカットは、設定とは別に管理されています。

コマンドパレットから次のコマンドを実行できます。

Preferences: Open Keyboard Shortcuts (JSON)

すると、カスタムショートカットをJSON形式で確認できます。

たとえば、次のような内容です。

[
    {
        "key": "ctrl+shift+t",
        "command": "workbench.action.reopenClosedEditor"
    }
]

settings.jsonだけをコピーしても、キーボードショートカットまで完全にバックアップできるわけではありません。

設定やショートカット、拡張機能をまとめて移行したい場合は、ProfilesまたはSettings Syncを利用するほうが簡単です。

ワークスペース設定をエクスポートする

ユーザー設定とワークスペース設定は異なる

VSCodeには、ユーザー設定とワークスペース設定があります。

ユーザー設定はVSCode全体に適用される設定です。

一方、ワークスペース設定は特定のプロジェクトだけに適用されます。

一般的なフォルダ形式のプロジェクトでは、次のように保存されます。

プロジェクト/
└─ .vscode/
   └─ settings.json

.vscodeフォルダをコピーする

プロジェクト固有の設定を別のPCへ移行したい場合は、.vscodeフォルダをプロジェクトと一緒にコピーできます。

Gitでプロジェクトを管理している場合は、.vscode/settings.jsonをリポジトリへ含めることで、チーム内で共通設定を共有することもできます。

ただし、APIキーやパスワードなどの機密情報を.vscode/settings.jsonへ保存している場合は、GitHubなどへ公開しないよう注意が必要です。

Multi-root Workspaceでは保存場所が異なる場合がある

複数のフォルダを1つのワークスペースとして管理するMulti-root Workspaceでは、ワークスペース設定が.code-workspaceファイルへ保存される場合があります。

そのため、ワークスペース設定が必ず.vscode/settings.jsonに保存されるとは限りません。

拡張機能も一緒に移行したい場合

settings.jsonだけでは拡張機能は移行できない

settings.jsonにはVSCodeの設定値が保存されていますが、インストール済み拡張機能そのものが保存されているわけではありません。

そのため、settings.jsonだけを別のPCへコピーしても、拡張機能は自動的にインストールされません。

たとえば、

PHP Intelephense
Prettier
ESLint
GitLens
Live Server

などを利用している場合、設定だけコピーしても拡張機能自体は移行されません。

ProfilesまたはSettings Syncを利用する

拡張機能まで含めて環境を移行したい場合は、ProfilesまたはSettings Syncが便利です。

Profilesであれば、プロファイルに拡張機能を含めてエクスポートできます。

Settings Syncであれば、複数のPC間で拡張機能を同期できます。

Settings Syncを利用するときの注意点

すべての設定が同期されるわけではない

Settings Syncを有効にしても、すべての設定が必ず同期されるとは限りません。

特にマシン固有の設定は、デフォルトでは同期対象外になる場合があります。

VSCodeには、

machine

や、

machine-overridable

といった設定スコープがあります。

これらはパソコンごとに異なる値を使用することが多いため、同期されない設定があります。

ローカルパスには注意する

たとえば、Windowsでは、

C:\Users\ユーザー名\...

macOSでは、

/Users/ユーザー名/...

といったパスを設定へ記述する場合があります。

こうしたPC固有のパスは、別のPCではそのまま利用できない可能性があります。

Profilesでエクスポートする場合も、マシン固有の設定はエクスポート対象外になることがあります。

そのため、.code-profileを利用しても、元のPC環境を完全に100％再現できるとは限りません。

WindowsとmacOS間で移行するときの注意点

キーボードショートカットはプラットフォームごとに扱われる

WindowsとmacOSでは、CtrlキーとCommandキーなど、ショートカット体系が異なります。

そのため、Settings Syncではキーボードショートカットがデフォルトでプラットフォームごとに同期されます。

WindowsとmacOS間で同じショートカットを完全に共有したい場合は、設定内容を確認する必要があります。

WSL・SSH・Dev Containers利用時の注意点

リモート側の拡張機能は別管理になることがある

VSCodeでは、WSL、SSH、Dev Containersなどを利用してリモート開発できます。

ただし、Settings Syncを利用しても、ローカル環境とリモート環境の拡張機能が完全に同じ状態になるわけではありません。

たとえば、

Windows側VSCode
↓
WSL

や、

ローカルPC
↓
SSH
↓
Linuxサーバー

といった構成では、リモート環境側へインストールする拡張機能が別に管理されます。

リモート開発を利用している場合は、ローカル側とリモート側のVSCode環境を分けて考える必要があります。

VSCodeの設定をエクスポートするならどの方法がおすすめか

PCを買い替える場合

新しいPCへVSCode環境を移行したい場合は、Profilesが便利です。

旧PC
↓
Profilesをエクスポート
↓
.code-profileを保存
↓
新PC
↓
Profilesをインポート

という手順で、設定や拡張機能などをまとめて移行できます。

複数PCで同じ設定を使う場合

デスクトップPCとノートPCなど、複数端末で継続的に同じ環境を利用したい場合はSettings Syncが向いています。

PC A
  ↕
Settings Sync
  ↕
PC B

設定を変更すると同期できるため、手動でエクスポートやインポートを繰り返す必要がありません。

設定だけ保存したい場合

設定値だけをバックアップしたい場合は、settings.jsonをコピーする方法が簡単です。

ファイルサイズも小さく、Gitなどで管理することもできます。

ただし、拡張機能やショートカットなどは別途管理する必要があります。

VSCodeの設定エクスポート方法の違い

VSCodeの設定をエクスポート・移行する方法をまとめると、次のようになります。

方法主な用途特徴
ProfilesPC移行・バックアップ設定や拡張機能などをまとめて保存できる
Settings Sync複数PC間の同期クラウド経由で自動同期できる
settings.json設定だけのバックアップシンプルで管理しやすい
.vscode/settings.jsonプロジェクト単位プロジェクト固有設定を共有できる

目的に応じて使い分けることが重要です。

VSCodeの設定エクスポートはProfilesが便利

VSCodeには複数の設定バックアップ・移行方法があります。

PCを買い替えるなど、一度だけVSCode環境を移行する場合はProfilesが便利です。

.code-profileファイルとして保存しておけば、設定や拡張機能、キーボードショートカットなどを新しい環境へ移行しやすくなります。

一方、自宅PCと仕事用PCなど複数端末で同じVSCode環境を継続的に使用したい場合はSettings Syncが適しています。

設定値だけを保存したい場合はsettings.json、プロジェクト単位の設定を共有したい場合は.vscode/settings.jsonを利用するとよいでしょう。

用途に合わせて、Profiles、Settings Sync、settings.jsonを使い分けることで、VSCodeの設定を安全かつ効率的にバックアップ・移行できます。

以上、VSCodeで設定をエクスポートする方法についてでした。

最後までお読みいただき、ありがとうございました。

VSCode
よかったらシェアしてね！
  • URLをコピーしました！
  • URLをコピーしました！

関連記事

  1. ホーム
  2. VSCode
  3. VSCodeで設定をエクスポートする方法
目次