https://github.com/koki-develop/vscode-settings-sync

VSCode settings sync extension to manage settings on GitHub and synchronize across multiple environments.
https://github.com/koki-develop/vscode-settings-sync

Last synced: 8 months ago
JSON representation

VSCode settings sync extension to manage settings on GitHub and synchronize across multiple environments.

• Host: GitHub
• URL: https://github.com/koki-develop/vscode-settings-sync
• Owner: koki-develop
• License: mit
• Created: 2024-11-16T05:51:16.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-12T11:05:59.000Z (12 months ago)
• Last Synced: 2025-03-11T19:54:26.641Z (11 months ago)
• Language: TypeScript
• Homepage:
• Size: 386 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# VSCode Settings Sync

[![GitHub Release](https://img.shields.io/github/v/release/koki-develop/vscode-settings-sync)](https://github.com/koki-develop/vscode-settings-sync/releases/latest)

[![GitHub License](https://img.shields.io/github/license/koki-develop/vscode-settings-sync)](https://github.com/koki-develop/vscode-settings-sync/blob/main/LICENSE)

VSCode settings sync extension to manage settings on GitHub and synchronize across multiple environments.

## Installation

1. Download the `.vsix` from [GitHub Releases](https://github.com/koki-develop/vscode-settings-sync/releases/latest)

2. Install using the `code --install-extension`.

```sh

$ code --install-extension /path/to/settings-sync-x.y.z.vsix

# If you are using Cursor

$ cursor --install-extension /path/to/settings-sync-x.y.z.vsix

```

## Usage

### Setup

1. Create a GitHub repository to store your settings. (e.g. `koki-develop/vscode-settings`)

2. Set the repository in `sync.sourceRepository` in settings.json.

```json5

// settings.json

{

  "sync.sourceRepository": "koki-develop/vscode-settings"

}

```

### Upload Settings

Run `Sync: Upload Settings` from the command palette.  

You can also use `Alt + Shift + U`.

### Download Settings

Run `Sync: Download Settings` from the command palette.  

You can also use `Alt + Shift + D`.

## LICENSE

[MIT](https://github.com/koki-develop/vscode-settings-sync/blob/main/LICENSE)