SyncSettingsReborn

English | 简体中文

A community-maintained fork of the unmaintained Sync Settings plugin, published as SyncSettingsReborn. If you used the original package, your gist_id and access_token are migrated automatically on first run.

With SyncSettingsReborn, you are able to synchronize your Sublime Text settings among multiple devices, and keep them updated.

Being powered by GitHub-Gists, SyncSettingsReborn provides you a reliable cross-platform solution to keep your backups secure.

Please, follow the steps below to getting started with SyncSettingsReborn.

SyncSettingsReborn works on Windows, Linux, macOS and requires Sublime Text 4 (build 4050 or newer).

Sync methods

Besides the default GitHub Gist backend, Reborn also offers PackageSync-style ways to sync:

• Offline Zip backup / restore — SyncSettingsReborn: Backup to Zip and Restore from Zip produce a portable archive of your Packages/User. The zip is a local, offline export, so it is not filtered for secrets — treat the file as sensitive. Restore is the exact inverse of backup: whatever the archive contains is written back.
• Backup Package List — back up only the installed package list.
• Sync Online (Dropbox / Google Drive / OneDrive) — Define Folder, Push, Pull commands move a zip in/out of any cloud-synced folder, no background process required.

On restore, preserve_packages (default true) merges the incoming installed_packages with your local list instead of overwriting it, so packages only on this machine are kept.

Getting Started

1. Run Package Control: Install Package command, and looks for SyncSettingsReborn
2. Run SyncSettingsReborn: Edit User Settings
3. if Do you already have a gist?
   1. Copy gist id and put it in config file (https://gist.github.com/<username>/<gist id>) (gist_id property)
   2. Run SyncSettingsReborn: Download command to retrieve your backup.
4. else
   1. Create an access token here with gist scope checked.
   2. Put the token in the config file (access_token property)
   3. Run SyncSettingsReborn: Upload command (it creates a new Gist the first time, then updates it on every later run)

File Format

Please note - the config file uses the JSON format. A simplified example may look like the following.

{
    "access_token": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "gist_id": "xxxxxxxxxxxxxxxxxxxxxxxxx"
}

Options

By default, this plugin operates over Sublime Text packages folder (i.e /Users/<my_user>/Library/Application Support/Sublime Text/Packages/User), which means, excluded_files and included_files will look for files inside that folder.

Note: excluded_files and included_files are patterns defined as unix shell style.

Gist size limit: GitHub's gist REST API returns at most ~1 MiB of content per file in the inline content field and marks larger files truncated: true (only partial content). This only affects the inline field — the raw_url endpoint (git backend) always serves the complete file, and uploads are never truncated (GitHub stores whatever you send). Both the manual Download command and background auto-sync fetch content via raw_url, so files of any size are restored intact (including files pushed via git, whose inline content is empty). The offline zip backup is unaffected.

Commands

GitHub Gist (cloud sync)

Resetting your backup: Run SyncSettingsReborn: Delete (clears the saved gist_id), then SyncSettingsReborn: Upload — Upload will create a fresh Gist with your current files in one click, with no description prompt or gist_id question.

Offline Zip / Package list

Sync Online (Dropbox / Google Drive / OneDrive)

Utilities

Contributors

Thank you for contribute to this project:

Ferron H 💻

tomahl 💻

Johannes Weber 💻

William Myers 💻

Terminal 💻

mariohuq 💻

Issues

If you are experimenting an error, or an unusual behavior. Please let me know, creating a new issue appending the logs provided by the SyncSettingsReborn: Show logs command.

Development

You are welcome to contribute to this project, whenever you want.

The package has no runtime dependencies — all HTTP traffic uses the Python standard library. Development uses the repository's local virtualenv (Python 3.14):

$ python3.14 -m venv .venv
$ .venv/bin/python -m pip install -r requirements-dev.txt

Run tests

$ .venv/bin/python -m pytest tests/ -q
$ .venv/bin/python -m flake8 sync_settings_reborn tests

License

SyncSettingsReborn is licensed under the MIT license along with all source code.

Copyright (c) since 2015, Marcelo Fuentes <marceloe.fuentes@gmail.com>.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.