How do I back up my VS Code settings and list of installed extensions?

Question

I've just been through the VS Code installation process twice. The initial install is quick and painless (as is the editor itself), but I have had to remember the list of extensions I installed and am installing new ones a great rate.

With Sublime Text, I'd just copy a settings file to another PC and could auto-install any workflow dependencies that way, but what is the approach with VS Code?

Can I just back up a JSON 'settings' file or similar so that I can easily re-create my working environment (complete with extensions)?

Just like other cross-platform editors, simply copy the .vscode directory to the new user environment's home directory. — JW0914, Feb 07 '20 at 13:17
You may be able to use the new preview feature Settings Sync to accomplish what you are trying to do. It will let you use a GitHub account or Microsoft account to store your VS Code settings (including preferences, extensions, etc) across machines. — Joel Glovier, Jun 04 '21 at 18:42

score 98 · Accepted Answer · edited Dec 10 '19 at 12:36

98

I've submitted an answer for this on the main StackOverflow site - pasted below for context

I've need to do this myself a few times - especially when installing on another machine.

Depending on your platform VS Code looks for your extensions folder (.vscode/extensions) on one of the following paths:

Windows: %USERPROFILE%\.vscode\extensions
Mac: ~/.vscode/extensions
Linux: ~/.vscode/extensions

That should show you a list of the extensions

I've also had success using Visual Studio Code Settings Sync Extension to sync settings to GitHub gist

EDIT: In the lastest release of VSCode (May 2016) it is now possible to list the installed extension in the command line

code --list-extensions

edited Dec 10 '19 at 12:36

Amit Yadav

103

answered Jun 01 '16 at 06:53

MarkP

1,096

1

Settings Sync extension worked like charm, just exported my settings from OS X to Linux Mint. – vikas027 Aug 09 '17 at 11:20
21

I don't want to Sync! I want to backup! You did not properly answer the original question. – JesseNewman19 Dec 08 '17 at 01:51
1

Note that Settings Sync does not seem to backup WSL remote extensions if using remote connection – Mr Fox Jul 13 '20 at 12:13

score 48 · Answer 2 · answered Jun 24 '19 at 05:06

48

So as treehead's edit or MarkP's answer showed you can now list all extensions installed so the way to install that list of extensions would be to:

code --list-extensions >> vs_code_extensions_list.txt

Transfer the newly created file to the machine that you want to install those extensions to. On that machine you would:

cat vs_code_extensions_list.txt | xargs -n 1 code --install-extension

Which will then go through each extension in that file and install the extension.

If you want a clean install (AKA remove all existing extensions on that machine) you could run this before you install the new extensions (otherwise you will remove those new extensions too). BE CAREFUL as this will remove all extensions in VS Code:

code --list-extensions | xargs -n 1 code --uninstall-extension

answered Jun 24 '19 at 05:06

NickTheSick

581

Tried, got this error message: "xargs : The term 'xargs' is not recognized as the name of a cmdlet, function, script file, or operable program." ? – Nicholas Petersen Jul 15 '19 at 18:44
7

@NicholasPetersen That's for Linux. On windows: get-content c:\exportedlist.txt | % { code --install-extension $_ } – Jason Clement Oct 18 '19 at 21:06
Here is how to uninstall only exts missing from the file: code --list-extensions | diff - vs_code_extensions_list.txt | grep '^<' | sed 's/</code --uninstall-extension' | eval. Then install: code --list-extensions | diff - vs_code_extensions_list.txt | grep '^>' | sed 's/>/code --install-extension' | eval. – DUzun Mar 20 '21 at 23:12

score 14 · Answer 3 · edited Sep 12 '19 at 13:26

14

The Settings Sync extension should do the trick, though the UX is so-so.

It syncs your settings to a GitHub Gist in JSON format. You’ll have to create a GitHub token. I suggest saving the token code in the token file name, as when you need to download your settings again later, it’s unlikely you’ll have the code handy (at least, that was my case).

edited Sep 12 '19 at 13:26

Rory O'Kane

778

answered Aug 13 '16 at 00:22

Brandon

1,209

If you know you will need your GitHub token for the Settings Sync extension, you can get it from the token key in the syncLocalSettings.json that is in your Code profile, in the same folder as settings.json. – Rory O'Kane Sep 12 '19 at 08:47

score -1 · Answer 4 · answered Nov 29 '20 at 09:41

-1

I just install Google Backup and Sync apps and then add user folder C:\Users\<user>\.vscode into the list of folders to be backed up.

answered Nov 29 '20 at 09:41

Rosdi

906

this doesn't backup the settings but just the installed extensions which can easily be reinstalled if you get the list like mentioned in other comments – Patrick Wolf Nov 15 '21 at 04:29

How do I back up my VS Code settings and list of installed extensions?

4 Answers4