While we endeavor to have all systems supported, we can't universally guarantee compatibility. Here are some systems we have taken into account.

full support

bash on Ubuntu (including the Windows Subsystem for Linux)

This repo has been developed and fully tested on Xenial (16.04), but should work for older systems as well.

limited support

zsh

Your .zshrc will not include .bash_aliases. (Don't use .zsh_aliases; we won't be able to find that.)

Include the following in your .zshrc:

if [ -f ~/.bash_aliases ]; then
  . ~/.bash_aliases
fi

Additionally, the install script will not be able to source your .zshrc, so you will have to do that manually after install. However, the src alias should still work after you've finished setup.

Tab completions will not work in zsh.

bash on OSX (or similar login shells)

You will not have a .bashrc that runs on startup, and .bash_aliases may not be automatically included in your .bash_profile. You can run the setup script, but you should add the following to your .bash_profile:

if [ -f ~/.bash_aliases ]; then
  . ~/.bash_aliases
fi