Provide support to synchronize settings across machines

[SrTobi]

There are quiet some extensions out there to handle setting synchronization between multiple computers. And in my opinion they are very important: Since vscode is very customizable with settings, keyboardshortcuts and extension it is very hard to synchronize those things between multiple workstations. And all those extensions are not really clean solutions, because vscode does nearly nothing to support them (for example the paths vscode uses are not exposed, see #2741).

So here some ideas to make synchronization clean and extensible:

• add a contribution point for synchronization extensions
  • Those extensions should not have to gather all the files that have to be synced. vscode should do this and then pass them to the extensions
  • Such an extension's job is only to upload/download the files, passed to them (so we can have the gist upload/svn upload/git repo upload/dropbox/filesystem/onedrive/ftp/other services.
  • Or maybe gather all settings into one big json object and pass that.
  • Support versioning and non versioning extensions
• add a remote_settings.json to build on top of the workspace-settings/user-settings stack.
• allow automatic and user triggered synchronization

Ok... just some ideas 😄

[Tyriar]

Related: #679

This is my solution for syncing keybindings and settings on Linux and Windows if you're interested. I haven't looked too deeply at doing it with extensions yet but I did file #691 some time ago to help with this.

[csholmq]

The plugin Sync Settings for Atom uses GitHub Gist to backup/sync:

• Settings
• Packages
• Keymap
• (Styles)
• (Init)
• Snippets

Atom also supports starring packages directly in Github and then easily install them using apm stars --user thedaniel --install.

[felixfbecker]

Imo this is a pretty low priority because most of the time settings are overwritten by workspace settings that are synced with version control anyway.

[csholmq]

@felixfbecker Extensions are however one of those things that doesn't version control. Neither is keymap.

[felixfbecker]

@csholmq That is a seperate issue though. For example, there could be a .vscode/extensions.json that specifies which extensions should be installed for this project, like editorconfig or a specific debug adapter, with a semver version constraint like a package.json.

[egamma]

This is not related to the original API request raised in this issue, but there is a sync extension that is using Gists. https://marketplace.visualstudio.com/items?itemName=Shan.code-settings-sync

[csholmq]

@egamma Exactly the functionality I sought after. But as @felixfbecker mentioned, perhaps this issue is a separate one.

[jokeyrhyme]

It might also be nice to install an extension once on one machine, and have your other machines either prompt or automatically install the same extension everywhere else.

Atom had an online package browser with "stars", and there was a command you could run to install everything you'd starred. Still not automatic, but it was a start.

I know others might object, but I personally have no problem having to log in to VSCode with my Microsoft account once per machine, if it facilitated this level of convenience. Maybe a synchronisation framework or something could be offered, so that provider-specific extensions could implement authentication and cloud-persistence (e.g. one for Microsoft, one for Google Drive, Dropbox, etc).

[golf1052]

I wrote an extension a while ago (here, also hasn't been updated in a while) that tried to help sync extensions between computers using file synchronization services. Originally I only supported syncing themes because syncing extensions seemed somewhat messy.

I think this should be the right way to maintain extensions between computers. Keep a list of what extensions are installed where, be able to pick and choose what extensions should be installed on which computer and then only manage syncing settings for those extensions. I assume the recommended way for extensions to manage settings is through this?

[felixfbecker]

https://marketplace.visualstudio.com/items?itemName=Shan.code-settings-sync syncs extensions very well

[ToMakeSense]

Very much agree with you, Add features--Account & Synchronization, handling setting synchronization and extensions synchronization(Mark extensions owned), what will make it much easier to install and to synchronize VS code between multiple computers.
Another extensions that syncs extensions: https://marketplace.visualstudio.com/items?itemName=golf1052.code-sync

[JosephTLyons]

Will settings sync be able to sync ssh configuration files?

[sandy081]

Not as of now.

[pycharmer1221]

which method is safe for now to sync

https://gist.github.com/wonderbeyond/661c686b64cb0cabb77a43b49b16b26e

or

https://mikefrobbins.com/2019/03/21/backup-and-synchronize-vscode-settings-with-a-github-gist/#comment-39448

[elliot-huffman]

which method is safe for now to sync

https://gist.github.com/wonderbeyond/661c686b64cb0cabb77a43b49b16b26e

or

https://mikefrobbins.com/2019/03/21/backup-and-synchronize-vscode-settings-with-a-github-gist/#comment-39448

I personally use this extension:
shan.code-settings-sync
It is super awesome and keeps my settings private on a private github gist.

[haugerbr]

@elliot-labs as discussed earlier in this thread, secret github gists are not private. Github documentation confirms as much https://docs.github.com/en/github/writing-on-github/creating-gists

I have used the same extension, but pulled some sensitive information out of my settings after finding out it wasn't private.

[elliot-huffman]

Oh crap! I missed that! 😬

[pycharmer1221]

@elliot-labs and @haugerbr
thanks,
I also don't know that gist is not private
so now I am thinking of writing some scripts for uploading settings to the cloud
and one script to download and install

I have also build a program that shows me scripts on startup
so I can put those script in there.

[escape0707]

Guys, vscode-insiders's sync isn't an option?

[jakobhviid]

I agree with @escape0707. Vs code insiders now has settings sync that will soon hit the public release. This is effectively a non problem and has been addressed.

[haugerbr]

@escape0707 @jakobhviid I'm aware of it and it's exactly what I'm planning on using once it moves to the normal VSCode builds. For now I'm still using settings sync while I wait.

[sandy081]

Settings Sync (preview) feature has landed into stable (1.48), hence closing this.

Please create separate issues for other requests or bugs.

[haugerbr]

@sandy081 is having seperate profiles within the same account a feature that has been requested already? For example, if I want to use my github account for the authentication method but want seperate work/personal profiles. For now I use seperate accounts which I actually like better for personal/work separation but I can see a use case where people want multiple personal profiles. I will open up a feature request for it if it does not already exist.

[sandy081]

Please go through the existing settings sync issues and create a one if does not exist.

[haugerbr]

Found it. Tagging it here in case anyone reading this thread is also interested in tracking it #92393

[Chiramisu]

Please join me in a nice round of applause and show of great appreciation for adding this feature (as of 1.48). I am thrilled and elated! Thank you so much VS Code team!! 👏🏼👏🏼👏🏼

However, if you could allow me just two minor gripes:

1. I seem to have to re-authenticate after some very short timeout (a day perhaps?) and a restart of VS Code.
2. Authentication takes place in a browser, and since I have tabitis and sometimes don't have my browser open, this becomes somewhat... irksome.

[sandy081]

Thanks.

I would suggest to open new issues for the problems you are facing with steps to repro.