Your home directory is your castle. Don't leave your dotfiles behind.
Homesick is sorta like rip, but for dotfiles. It uses git to clone a repository containing dotfiles, and saves them in
~/.homesick. It then allows you to symlink all the dotfiles into place with a single command.
We call a repository that is compatible with homesick to be a 'castle'. To act as a castle, a repository must be organized like so:
- Contains a 'home' directory
- 'home' contains any number of files and directories that begin with '.'
To get started, install homesick first:
gem install homesick
Next, you use the homesick command to clone a castle:
homesick clone git://github.com/technicalpickles/pickled-vim.git
Alternatively, if it's on github, there's a slightly shorter way:
homesick clone technicalpickles/pickled-vim
With the castle cloned, you can now link its contents into your home dir:
homesick symlink pickled-vim
You can remove symlinks anytime when you don't need them anymore
homesick unlink pickled-vim
If you need to add further configuration steps you can add these in a file called '.homesickrc' in the root of a castle. Once you've cloned a castle with a .homesickrc run the configuration with:
homesick rc CASTLE
The contents of the .homesickrc file must be valid Ruby code as the file will be executed with Ruby's eval construct. The .homesickrc is also passed the current homesick object during its execution and this is available within the .homesickrc file as the 'self' variable. As the rc operation can be destructive the command normally asks for confirmation before proceeding. You can bypass this by passing the '--force' option, for example
homesick rc --force CASTLE.
If you're not sure what castles you have around, you can easily list them:
To pull your castle (or all castles):
homesick pull --all|CASTLE
To commit your castle's changes:
homesick commit CASTLE
To push your castle:
homesick push CASTLE
To open a terminal in the root of a castle:
homesick cd CASTLE
To open your default editor in the root of a castle (the $EDITOR environment variable must be set):
homesick open CASTLE
To execute a shell command inside the root directory of a given castle:
homesick exec CASTLE COMMAND
To execute a shell command inside the root directory of every cloned castle:
homesick exec_all COMMAND
Not sure what else homesick has up its sleeve? There's always the built in help:
If you ever want to see what version of homesick you have type:
homesick symlink basically makes symlink to only first depth in
castle/home. If you want to link nested files/directories, please use .homesick_subdir.
For example, when you have castle like this:
castle/home `-- .config `-- fooapp |-- config1 |-- config2 `-- config3
and have home like this:
$ tree -a ~ |-- .config | `-- barapp | |-- config1 | |-- config2 | `-- config3 `-- .emacs.d |-- elisp `-- inits
You may want to symlink only to
castle/home/.config/fooapp instead of
castle/home/.config because you already have
~/.config/barapp. In this case, you can use .homesick_subdir. Please write "directories you want to look up sub directories (instead of just first depth)" in this file.
homesick symlink CASTLE. The result is:
~ |-- .config | |-- barapp | | |-- config1 | | |-- config2 | | `-- config3 | `-- fooapp -> castle/home/.config/fooapp `-- .emacs.d |-- elisp `-- inits
homesick track NESTED_FILE CASTLE adds a line automatically. For example:
homesick track .emacs.d/elisp castle
~ |-- .config | |-- barapp | | |-- config1 | | |-- config2 | | `-- config3 | `-- fooapp -> castle/home/.config/fooapp `-- .emacs.d |-- elisp -> castle/home/.emacs.d/elisp `-- inits
castle/home |-- .config | `-- fooapp | |-- config1 | |-- config2 | `-- config3 `-- .emacs.d `-- elisp
Supported Ruby Versions
Homesick is tested on the following Ruby versions:
Note on Patches/Pull Requests
- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it. This is important so I don't break it in a future version unintentionally.
- Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
- Send me a pull request. Bonus points for topic branches.
Need homesick without the ruby dependency?
Check out homeshick.
Copyright (c) 2010 Joshua Nichols. See LICENSE for details.