「sync-settings」パッケージでAtomエディタの設定をバックアップ・同期する

パソコン

2016.10.252017.03.29

私は「Atom」というエディタを好んで使用しているのですが、別のパソコンに「Atom」をインストールする場合、設定などを引き継いで使いたいと常々思っていました。何かよい方法はないか探していたところ、パッケージの導入で実現できそうだったので、試してみることにしました。

というわけで、今回はAtomエディタの設定をバックアップ・同期する方法をご紹介いたします。

目次

「Atom」とは
Atomエディタの設定のバックアップ・同期までの流れ
1. 必要なもの
Atomの設定をバックアップ・同期する
まとめ

「Atom」とは

「Atom」はGitHub製のフリーのテキストエディタで、パッケージをインストールすることによって機能を追加し、自分好みのエディタにすることができます。デフォルトではエディタ内の表記は英語ですが、パッケージをインストールすることにより、日本語にして利用することができます。

対応OSはWindows、Mac OS X、Linuxとなっています。

Atomエディタの設定のバックアップ・同期までの流れ

「sync-settings」パッケージをインストールする。
GitHubのアクセストークンを作成する。
Gist Idを作成する。
「sync-settings」の設定を行う。
別PCに「Atom」をインストールし、「sync-settings」の設定を行う。

必要なもの

GitHubのアカウント

「sync-settings」で設定するにはGitHubなどでトークンを生成する必要があるので、GitHubアカウントが必須となります。

Atomの設定をバックアップ・同期する

「sync-settings」パッケージをインストールする

Atomエディタを開き、ファイルにある「環境設定」を選択します。

Atom 「環境設定」を選択 — 「環境設定」を選択

設定にある「Install」を選択します。

Atom 「Install」を選択 — 「Install」を選択

「パッケージ」を選択し、「sync-settings」と入力します。

Atom 「sync-settings」と入力 — 「sync-settings」と入力

「sync-settings」が検索結果の一覧に表示されるのでインストールします。

Atom 「sync-settings」をインストール — 「sync-settings」をインストール

「sync-settings」をインストールした後、GitHubのサイトに行き、アクセストークンを作成します。

GitHubのアクセストークンを作成する

「Sign in to GitHub · GitHub」でアカウント情報を入力し、サインインします。

GitHubにサインイン

右上のアイコンを選択し、「Settings」を選択します。

GitHub「Settings」を選択 — 「Settings」を選択

左下メニューにある「Personal access tokens」を選択します。

GitHub「Personal access tokens」を選択

「Personal access token」右横の「Generate new token」ボタンをクリックします。

「Generate new token」ボタンをクリック

「New personal access token」ページに行き、「Token description」に適当な文言を入力した後、「gist」にチェックを入れて「Generate token」ボタンをクリックします。

GitHub 「gist」にチェックを入れて「Generate token」ボタンをクリック — 「gist」にチェックを入れて「Generate token」ボタンをクリック

アクセストークンが生成されるので控えておきます。同じアクセストークンは生成されないので、控えを忘れた場合は再度生成する必要があります。

GitHub トークンを控える — アクセストークンを控える

Gist Idを作成する

ヘッダーある「Gist」をクリックし、GitHub Gistへ行きます。

「Gist」をクリック

適当なファイルネームと内容を入力し、「Create secret gist」ボタンをクリックします。

GitHub Gist 適当なファイルネームと内容を入力し、「Create secret gist」ボタンをクリック — 適当なファイルネームと内容を入力し、「Create secret gist」ボタンをクリック

アドレスバーにあるユーザー名の後に表示される英数字がGist Idとなるので控えます。

ユーザー名の後に表示される英数字を控える

「sync-settings」の設定を行う

Atomの設定にある「パッケージ」を選択します。

Atom 「パッケージ」を選択 — 「パッケージ」を選択

パッケージ一覧に「sync-settings」があるので「Settings」ボタンをクリックします。

Atom sync-settings「Settings」ボタンをクリック — 「Settings」ボタンをクリック

「Settings」の「Personal access tokens」にGitHubで生成したトークンを入力、「Gist Id」にGitHub Gistで控えたGist Idを入力します。

Atom sync-settings トークンとGist Idを入力 — トークンとGist Idを入力

トークンとGist Idを入力した後、メニューバーのパッケージからSynchronize Settings > Backupを選択します。

Atom sync-settings Backupを選択 — Backupを選択

GitHubへのアップロードが完了すると、Atomに下記のような通知が表示されます。

Atom 設定バックアップの成功通知 — バックアップの成功通知

GitHub Gistで設定ファイルのアップロードを確認

GitHub Gistに行き、「init.coffee」というリンクが出来ているのでクリックします。

GitHub Gist 「init.coffee」をクリック — 「init.coffee」をクリック

「init.coffee」、「keymap.cson」、「packages.json」などAtomの設定ファイルがアップロードされていることを確認します。

「init.coffee」

「keymap.cson」

「packages.json」

「settings.json」

「snippets.cson」

「styles.less」

アップロードされるファイルや内容はAtomの環境によって変わります。

別のPCにあるAtomの設定を同期(ダウンロード)する

再度「sync-settings」をインストールし、同じGitHubのアクセストークンとGist Idを入力します。

Atom sync-settings 同じトークンとGist Idを入力 — トークンとGist Idを入力

そして、メニューバーのパッケージからSynchronize Settings > Restoreを選択します。

Atom Restoreを選択 — Restoreを選択

リストアが成功すると下記のような通知が表示されます。

リストアの成功通知

今後Atomを起動すると、下記のように既にバックアップがされている旨の通知がされます。

既にバックアップがされている旨の通知

エディタを操作して設定の同期を確認できれば終了です。

まとめ

「Atom」はGitHub製のフリーのテキストエディタで、対応OSはWindows、Mac OS X、Linux。
「sync-settings」パッケージで設定のバックアップ・同期を行う。
「sync-settings」の設定にはGitHubアカウントが必須。
GitHubのアクセストークン、Gist Idを作成して「sync-settings」に設定する。

「Atom」の設定を「sync-settings」でバックアップ・同期ができれば、どのパソコンの「Atom」であっても、同じ環境を構築することができます。

もし「Atom」エディタを利用している方で、まだ試していない方がいれば、「sync-settings」パッケージの導入を検討してみてはいかがでしょうか。

コメント