「sync-settings」でAtomの設定をGithub(Gist)上で管理して複数マシンで共有する

Atomの設定を複数のマシンで同期したいので「sync-settings」を利用することにしました。
GithubのGistを利用するらしく事前にGithubアカウントが必要です。

sync-setting

公式ページによると、

  • 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

とあります。

パッケージ設定とかキーマップとかスニペットとか必要な設定もろもろを共有できるようです。

使い方

1. インストール

Atom上から「Ctr + ,」で設定画面を表示してパッケージ名で検索。
表示されたパッケージの「Install」ボタンを押下します。
インストール画面

2. Github側の準備

Access tokenの作成
  1. Githubのサイトからログイン
  2. 右上のアイコンメニューから[settings]をクリック
  3. 表示された画面の左メニューから[Personal access tokens]をクリック
  4. ハスワード入力画面が表示されたらアカウントのパスワードを入れて「Confirm password」を押下
  5. 表示された画面のページ右端の「Generate new token」ボタンを押下
  6. 下記のように設定して「Generate token」ボタンを押下

New personal access tokenページ
※ 「Token description」は自分がわかればなんでもOK
※ 「Select scopes」は今回はGistによる設定の共有なので「gist」のみでOK

成功すると下記のようなページが表示されます。
Access token取得画面
緑枠部分のランダム英数字が必要なトークンなのでコピペしておきます。
(一応モザイクをかけてあります)

Gistの作成

ページヘッダー部分の「Gist」リンクをクリックすると新規作成画面が表示されるので、
下記のように内容を記載して「Create secret gist」を押下
Gist作成画面
※ 空のファイルは作成できないので本文を入力していますが内容は何でもOK

作成後の画面の赤枠で囲った部分がGistIDなのでコピペしておきます。
(一応モザイクをかけてあります)
Gist画面

3. パッケージ側の設定

先ほど作成したトークンとGistIDを下記の入力欄へコピペします。
設定画面1

下記の部分で同期する項目の指定も可能です。
詳細設定

とりあえず最低限の設定は完了となります。

4. 設定のバックアップ

パレットを表示(Ctrl + Shift + P)して「Sync」と入力すると候補が出てくるので、
「Sync Settings:Backup」を実行。
コマンドパレット表示

画面右端に下記のメッセージが出ればバックアップ成功です。
バックアップ成功ダイアログ

また、Gist側を確認するとRevisionが増えていて共有用のファイルも作成されています。

5. 設定のリストア

別のマシンからリストアを行い設定が共有されているか確認します。

別マシン側の準備
  1. Atomのインストール(https://atom.io/
  2. 1. インストール」に従いパッケージをインストール
  3. 3. パッケージ側の設定」に従い同じトークンとGistIDを設定
  4. パレットを表示して「Sync Settings:Restore」を実行

画面右端に下記のメッセージが出ればリストア成功です。
リストア成功ダイアログ
※ 反映されてるか微妙な場合はエディタの再起動を行えばOKだと思います

設定画面のパッケージ一覧を確認するとマシン間で同じパッケージがインストールされていることを確認出るはずです。

感想

今まではマシンが変わるたびに新しくエディタのインストールとパッケージやテーマの設定を行っていました。
今回の「sync-settings」を導入することでその手間が大幅に短縮できることは業務効率化にもつながると思います。
(いちいち何をインストールしたかとか調べ直さなくてもよくなります!)

Github側のトークン生成やGist作成など準備までが若干めんどくさいですが、
最初に準備しておけばあとはそれを利用するだけなので2台目以降はそれを使いまわすだけです。
(Sublime Textにはこのような機能はなかったような…?)

@作業短縮時間(30分⇒5分以内)

参考サイト

atomの設定をバックアップできるパッケージ「sync-settings」が便利

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る