Setup Guide
This article details how to install and set up the settings sync extension.
For versions of this extension before v3.4.0, see this guide
There are 3 main ways to install the extension for use with VSCode. You may use whichever one you wish, but they are ordered from easiest to more advanced.
To open the extensions manager, type Ctrl + Shift + X or click
In the search bar, type Settings Sync. Hit the green Install button to install the extension.
Go to our marketplace page here. Tap the big blue install button. In the popup, tap Open Visual Studio Code.
In the Visual Studio Code window that opens, tap Install in the popup at the top of the screen. Then, Reload the window again.
Open the terminal and enter this command:
code --install-extension Shan.code-settings-syncWhen the extension is first installed, you will see a page prompting you to log in with GitHub.
- Press the button and log into your GitHub account if necessary.
- Once you have logged in, you will be redirected to a page saying
Success!, which you can close. - Go back to VSCode to complete the setup process.
- If you have uploaded your settings before, a tab will show up in VSCode where you can select the gist that you want to use. Click on the one you want to use, then click
Close Tabif you are done orBackif you want to change your gist.
Press Shift + Alt + U or type >Sync: Update / Upload Settings into the command palette to start the upload process.
Press Shift + Alt + D or type > Sync: Download Settings in the command palette to start the download process.
This extension will create a syncLocalSettings.json file inside the User folder of VSCode upon the first start.
These are the default locations:
- Windows:
%APPDATA%\Code\User\syncLocalSettings.json - Mac:
$HOME/Library/Application Support/Code/User/syncLocalSettings.json - Linux:
~/.config/Code/User/syncLocalSettings.json
Note that these may differ depending on the build of VSCode you're using.
For more info on troubleshooting issues, see the Troubleshooting Guide