🌴πŸ’ͺ Synchronize your Visual Studio Code Settings Across Multiple Machines using Github GIST πŸ’ͺ🌴

README.md

Settings Sync Tweet

Previously known as Visual Studio Code Settings Sync

Version Travis Greenkeeper badge Follow

Drawing

Type Sync in command Palette in order to view all commands.

Key Features

1. Use your GitHub account token and Gist.
2. Easy to Upload and Download on one click.
3. Show a summary page at the end with details about config and extensions effected.
4. Auto download Latest Settings on Startup.
5. Auto upload Settings on file change.
6. Share the Gist with other users and let them download your settings.
7. Supports GitHub Enterprise
8. Support pragmas with @sync keywords: host, os and env are supported.

It Syncs

All extensions and complete User Folder that Contains
1. Settings File
2. Keybinding File
3. Launch File
4. Snippets Folder
5. VSCode Extensions & Extensions Configurations
6. Workspaces Folder

Shortcuts

1. Upload Key : Shift + Alt + U
2. Download Key : Shift + Alt + D

Steps To Get a Personal Access Token from GitHub

This extension requires a Personal Access Token from your GitHub account. You can create one by simply following the steps shown in the pictures below. Make sure you add Gist in scope.

Go to Settings / Developer settings / Personal access tokens / Generate New Token

Goto Settings / Developer settings / Personal Access Tokens

Select Gist From Scopes.

Select Scopes

Get an Access Token.

Get Access Token

Save the Token somewhere for future use (i.e. to upload from other machines).

Upload Your Settings For the first time

Press Shift + Alt + U it will ask your GitHub account access token.

Type ">Sync" In Command Palette into order download / upload

This will automatically open your GitHub settings page, allowing you to generate a new token for the application, as explained in the previous section. This token will allow the extension to create gists.

Enter the GitHub token in the window and click enter.

github account access token

Upload your settings automatically and the extension gives you Gist ID in the system message. Gist ID is needed to access the data you have uploaded with your token. Copy this Gist ID in order to download the settings to other machines.

uploaded automatically

You can always verify created gist on the following url:

https://gist.github.com/{your_userName}/{gist_id}

Here is the gif of the complete process when you execute the Upload command (Might take some time to load)

Upload

Download your Settings

Press Shift + Alt + D it will ask your GitHub Gist ID.

Type ">Sync" In Command Palette into order download / upload

Enter Your GitHub Token.

Enter the GitHub token in the window and click enter.

github account access token

Enter Your Gist ID.

You need to enter your Gist ID in order to download the files you have uploaded with Shift + Alt + U.

Enter Your Gist ID

Settings Downloaded. You are Done! All your files are downloaded

Enter Your Gist ID

Here is the gif of the complete process when you execute the Download command (Might take time to load)

Download

Reset Token / Gist Settings

Type ">Sync" In Command Palette and select Reset Token and Gist Settings

Toggle Auto Download

Auto Download is disabled by default. It will sync all the setting by default when the editor starts. Please make sure you have valid github Token and Gist available to make it work properly.

Select Command "Sync : Advanced Options > Toggle Auto-Download On Startup" command to Turn ON / OFF the auto download.

Toggle Force Download

Force Download is disabled by default. By default, extension won't download the latest settings if you already have the latest downloaded version, but sometimes when you delete some extension locally and don't upload the settings it will still show that you have latest versions by date or time checks, by turning this ON it will always download the cloud settings on startup.

Please make sure you have valid github Token and Gist available to make it work properly.

Select Command "Sync : Advanced Options > Toggle Force Download" command to Turn ON / OFF the force download.

Toggle Auto-Upload on change

Auto-upload is disabled by default. When the settings are changed and saved this feature will automatically start the upload process and save the settings online.

Please make sure you have valid github Token and Gist available to make it work properly.

Select Command "Sync : Advanced Options > Toggle Auto-Upload on Settings Change" command to Turn ON / OFF the auto-upload.

Toggle Summary

Summary is enabled by default which shows all files and extensions that are added or deleted on a single page. You may turn it off in order to make a upload and download process clean and quiet.

Select Command "Sync : Advanced Options > Show Summary Page On Upload / Download" command to Turn ON / OFF the auto download.

Create Public Gist To Share Settings

By default, it creates secret Gist so only you can see it but if you want to share your Gist with other users, you can set it to public. You can't change the exiting Gist type from secret to public so it will reset the Gist ID so you can create new Gist with all existing editor settings.

Select Command "Sync : Advanced Options > Share Settings with Public GIST"

Other users can give your Gist Id to download the Gist, but they can't upload their settings on your Gist.

Settings

There are two types of settings in Settings Sync. I will recommend you to read the configurations details here.

Gist Settings

Gist Settings are stored in settings.json file of Code. You can customize the settings in gist settings like:

1. Configure Gist Id (Environment)
2. Configure auto upload / download for Github Gist 
3. Configure extension sync behaviour
4. Configure force download
5. Configure quiet sync
    "sync.gist": "0c929b1a6c51015cdc9e0fe2e369ea4c",
    "sync.autoDownload": false,
    "sync.autoUpload": false,
    "sync.forceDownload": false,
    "sync.quietSync": false,
    "sync.askGistName": false,
    "sync.removeExtensions": true,
    "sync.syncExtensions": true

Global Settings

Global settings are present in syncLocalSettings.json inside User folder. These settings will be shared across multiple Gist Environments.

On Windows, this is %APPDATA%\Code\User\syncLocalSettings.json.

Mac, $HOME/Library/Application Support/Code/User/syncLocalSettings.json.

Linux, ~/.config/Code/User/syncLocalSettings.json.

You can customize the sync:

1. Options by which files / folders and settings to exclude from upload.
2. Configure default Gist Environment name.
3. Replace the code settings after downloading.
4. Change the Gist description while creating new one in github.
5. Configure Github Enterprise Url
{
    "ignoreUploadFiles": [
        "projects.json",
        "projects_cache_vscode.json",
        "projects_cache_git.json",
        "projects_cache_svn.json",
        "gpm_projects.json",
        "gpm-recentItems.json"
    ],
    "ignoreUploadFolders": [
        "workspaceStorage"
    ],
    "ignoreExtensions": [
        "ignored_extension_name"
    ],
    "replaceCodeSettings": {
        "http.proxy": "http://my.proxy.address:8080"
    },
    "gistDescription": "Visual Studio Code Settings Sync Gist",
    "version": 310,
    "token": "YOUR_GITHUB_TOKEN_HERE",
    "downloadPublicGist": false,
    "supportedFileExtensions": [
        "json",
        "code-snippets"
    ],
    "openTokenLink": true,
    "useCliBaseInstallation": true,
    "lastUpload": null,
    "lastDownload": null,
    "githubEnterpriseUrl": null,
    "hostName": null
}

I will recommend you to read the configurations details here.

How To Contribute

You can contribute in different ways. Read the details here

Credits

Contributors

Thank you to all the people who have already contributed to Settings Sync!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)

Contributors

Release Notes

License

Version

Version

Installs

Ratings

Drawing