【VSCode】複数のOSやPC上で設定を同期させる方法(SettingSync)

VSCodeに内蔵されている「Settings Sync」を用いて、数のOSやPC上で設定を同期させる方法を解説します。

「Settings Sync」とは

VSCode(Visual Studio Code)の標準機能「Settings Sync」は、複数のデバイス間でVSCodeの設定を共有できる機能です。設定ファイルや拡張機能、キーバインド、テーマやレイアウトなどを共有できます。これにより、どのデバイスでも同じ開発環境を簡単に利用できます。

利用には、「Microsoft アカウント」もしくは「GitHub アカウント」が必要となります。今回は、いずれかのアカウントを取得済であることを前提として、導入方法と使い方を解説します。


設定方法

① VSCodeの左下の歯車アイコン(設定)をクリックし、「バックアップと同期の設定」をクリックします。

② 「設定の同期」画面が表示されるので、同期したい項目にチェックを入れて「サインイン」をクリックします。

【同期できる項目】

  • 設定・・・settings.json の中身
  • キーボードショートカット・・・ keybindings.json のカスタム設定
  • スニペット
  • タスク
  • MCPサーバー
  • UIの状態・・・ テーマ、カラーテーマ、サイドバー配置などのレイアウト情報
  • 拡張機能・・・インストール済み拡張機能
  • プロファイル
  • プロンプトと指示

③ 「GitHubでサインイン」または「Microsoft」でサインインを選択します。

④ ブラウザが開くので、「GitHubアカウント」または「Microsoftアカウント」でサインインします。

⑤ ログイン後、VSCodeの左下の歯車アイコン(設定)をクリックし、「設定の同期がオン」となっていれば完了です。

⑥ 同期先のPCでも同様に①~⑤の作業を行うと、最初のPCと設定が同期されます。

同期項目の変更

同期設定は、初期設定後も変更可能です。同期の対象項目を削除したり追加できます。

設定の競合

同期元PCと同期先PCで設定に競合がある場合、ダイアログが表示されます。
「競合の表示」を選択すると競合している設定が表示されます。
「ローカルを置換」を選択すると、ローカルの設定(同期先PCの設定)がリモートの設定(同期元PCの設定)に修正されます。

関連ページ

【Windows11】PythonとVSCodeで環境構築する方法を丁寧に解説
Windows11上でPythonとVscodeを導入し、環境構築する方法について詳しく解説します。
【VSCode超入門】基本的な使い方から応用例まで解説
VSCode(Visual Studio Code)の基本的な使い方から応用例まで入門者向けに解説します。

コメント