読者です 読者をやめる 読者になる 読者になる

試される大地から

furaiboが送る技術ブログ。プログラミングのTipsなど書いていきます。

GitHubでドットファイル(.dotfiles)を管理する



こんにちは、furaiboです。
今回はドットファイルGitHubで管理する方法について書きます。



他の方の.vimrcなどを最近はちょくちょく読んだりするのですが、その際に皆、GitHub上の".dotfiles"といったリポジトリ名で管理しているのを見かけるので、できる奴を気取りたい僕もそれに倣ってみました。



ドットファイルGitHubリポジトリ上に置いておくと、一元的にファイルを管理出来るだけでなく、メインPC以外の環境でも使い慣れた設定の導入が簡単になるという利点があります。



ここでは、

  • .vim(ディレクトリ)
  • .vimrc
  • .bashrc
  • .zshrc
  • .gitconfig
  • .xmodmap

などのファイルを扱うものとします。



まずは、GitHub上で「.dotfiles」という名前のリポジトリを作り、リポジトリの内容をクローンします。

$ cd ~
$ git clone git@github:(あなたのアカウント名)/.dotfiles

こうすると、ユーザのルートディレクトリに.dotfilesという名前のディレクトリができます。そして、ファイルを.dotfilesディレクトリ内にすべて移動します。

$ mv .vim .dotfiles/.vim
$ mv .vimrc .dotfiles/.vimrc
$ mv .bashrc .dotfiles/.bashrc
$ mv .zshrc .dotfiles/.zshrc
$ mv .gitconfig .dotfiles/.gitconfig
$ mv .xmodmap .dotfiles/.xmodmap


さらに、シンボリックリンクを張ります。

# シンボリックリンクの設定
$ ln -s ~/.dotfiles/.vim ~/.vim
$ ln -s ~/.dotfiles/.vimrc ~/.vimrc
$ ln -s ~/.dotfiles/.zshrc ~/.zshrc
$ ln -s ~/.dotfiles/.xmodmap ~/.xmodmap
$ ln -s ~/.dotfiles/.bashrc ~/.bashrc
$ ln -s ~/.dotfiles/.gitconfig ~/.gitconfig


シンボリックリンクにより、あたかもユーザディレクトリ上にファイルがあるかのように扱うことが出来ます。あとは、GitHubにpushするだけです。

$ cd ~/.dotfiles
$ git add .
$ git commit -m "initial commit"


これでドットファイルGitHub上へのアップロードは完了です。他のPCに移っても、git cloneで.dotfilesリポジトリをクローンし、シンボリックリンクを張れば、すぐにメインPCと同じ環境に移行することが可能になります。



僕の.dotfilesリポジトリへのリンクが以下にありますので、参考にしてみてください。


furaibo/.dotfiles · GitHub




参考にした記事は以下になります。



dotfilesをGitHubで管理,vimプラグインをNeoBundleで管理する方法メモ - Programming Log


Vim - dotfilesをgithubで管理 - Qiita


Linux - シンボリックリンクの作成と削除 - Qiita