homeshick

homeshick [options] command [arguments]

homeshick is a Git-based dotfile synchronizer written in Bash. It uses "castles" (Git repositories) to manage dotfiles, creating symlinks from the repository to your home directory.Each castle is a Git repository stored in ~/.homesick/repos/. Files tracked in a castle (with track) are moved into the repository and replaced with symlinks pointing back to the repository copy. This allows version control and easy synchronization across machines. Multiple castles can be installed side by side, letting you combine shared dotfile collections (e.g. an oh-my-zsh castle) with your own.

generate CASTLE [CASTLE...]

Create a new castle (dotfiles repository)

Move a file/folder into a castle and replace it with a symlink

Change directory to a castle's repository, for running git commands directly

Clone a castle from a Git repository (supports GitHub "user/repo" shorthand)

Symlink all files in the given castles' (or all castles') home folders into $HOME

Run git pull for the given castles (or all castles) and their submodules

Check whether castles are behind, ahead, or up to date with their remote

Check remotes for updates, skipping castles checked within the last week

List all installed castles

Suppress status output except when input is required

Skip conflicting files in $HOME instead of overwriting them

Overwrite conflicting files in $HOME automatically

Run non-interactively, accepting default answers

Print additional diagnostic output

Requires Bash 3+ and Git 1.5+. Symlinks may not work correctly on some filesystems or in containers. Conflicts can arise when multiple castles contain the same file; use -f/--force or -s/--skip to resolve them non-interactively.

homeshick was created by Anders Ingemann, with the repository dating to 2012, as a pure Bash alternative to homesick (a Ruby gem). The name combines "home" (dotfiles) with "shell" (Bash implementation).

chezmoi(1), stow(8), git(1)

Source code · Documentation