Installation

homeshick is installed as a managed repository (AKA castle), this way it can keep itself updated. In order to create the castle, simply clone it to the appropriate location.

git clone git://github.com/andsens/homeshick.git $HOME/.homesick/repos/homeshick

Now lets make homeshick work when we type homeshick.

printf '\nsource "$HOME/.homesick/repos/homeshick/homeshick.sh"' >> $HOME/.bashrc

This adds a line to your .bashrc which includes a script that defines the homeshick() function.

If you use csh or tcsh, you can update your .cshrc like this:

printf '\nsource "$HOME/.homesick/repos/homeshick/bin/homeshick.csh"' >> $HOME/.cshrc

To get the function working right away, you will have to rerun your .bashrc with source $HOME/.bashrc, or your .cshrc with source $HOME/.cshrc.

Note: The reason we want to define a function and not a simply alias bin/homeshick to homeshick is because of the [[cd|Commands#cd]] command. homeshick cannot change the working directory of your current shell if it is invoked as a subprocess.

You can skip the commands part and go to the tutorials if you prefer getting to know homeshick by using it.

Completion

Bash completion

ZSH completion