/atom-sync-settings

Synchronize all your settings and packages across atom instances

Primary LanguageCoffeeScriptMIT LicenseMIT

Sync Settings for Atom

Join the chat at https://gitter.im/Hackafe/atom-sync-settings Build Status

Synchronize settings, keymaps, user styles, init script, snippets and installed packages across Atom instances.

Features

  • Sync Atom's and package settings
  • Sync installed packages
  • Sync user keymaps
  • Sync user styles
  • Sync user init script
  • Sync snippets
  • Sync user defined text files
  • Manual backup/restore to a gist

Installation

$ apm install sync-settings or using the Install packages pane from Atom Settings.

Setup

  1. Open Sync Settings configuration in Atom Settings.
  2. Create a new personal access token which has the gist scope.
  3. Copy the access token to Sync Settings configuration.
  4. Create a new gist and save it.
  5. Copy the gist id (last part of url after the username) to Sync Settings configuration.

Disclaimer: Github Gists are by default public. If you don't want other people to easily find your gist (i.e. if you use certain packages, storing auth-tokens, a malicious party could abuse them), you should make sure to create a secret gist.

Alternative Sync Settings configuration using Atom's config.cson

  1. Click on Menu "Open Your Config" to edit Atom's config.cson
  2. Use these keys:
  "sync-settings":
    gistId: "b3025...88c41c"
    personalAccessToken: "6a10cc207b....7a67e871"

Usage

Open the Atom Command Palette where you can search for the following list of commands.

Backup or restore all settings from the Packages menu or use one of the following commands:

  • sync-settings:backup
  • sync-settings:restore

View your online backup using the following command:

  • sync-settings:view-backup

Check the latest backup is applied:

  • sync-settings:check-backup

You can also fork existing settings from a different GitHub user using the following command:

  • sync-settings:fork
  • In the following input field enter the Gist ID to fork

Running the tests

  1. Create a new personal access token which has the gist scope and will be used for testing purposes.
  2. Export it with export GITHUB_TOKEN=YOUR_TOKEN
  3. Run apm test

Contributing

If you're going to submit a pull request, please try to follow the official contribution guidelines of Atom.

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Ensure tests are passing. See running-the-tests.
  4. Commit your changes (git commit -am 'Add some feature').
  5. Push to the branch (git push origin my-new-feature).
  6. Create new Pull Request.

See all contributors.

Privacy

There is Segment.io which forwards data to Google Analytics to track what versions and platforms are used. Everything is anonymized and no personal information, such as source code, is sent. See atom-community#82 for more details. It can be disabled from package settings.