The configuration framework for Zsh
Go to file
2012-01-23 20:40:43 -05:00
completions@62436acb8a Added zsh-completions. 2012-01-23 20:40:41 -05:00
plugins Tradition dictates that options are uppercase. 2012-01-23 20:40:43 -05:00
templates Added missing FX and named colors to spectrum. 2012-01-23 20:40:39 -05:00
themes Separate unsetopt from setopt for clarity. 2012-01-23 20:40:43 -05:00
.gitignore Ignore plugin cache files. 2011-08-28 15:33:58 -04:00
.gitmodules Added zsh-completions. 2012-01-23 20:40:41 -05:00
alias.zsh Tradition dictates that options are uppercase. 2012-01-23 20:40:43 -05:00
completion.zsh Tradition dictates that options are uppercase. 2012-01-23 20:40:43 -05:00
directory.zsh Tradition dictates that options are uppercase. 2012-01-23 20:40:43 -05:00
environment.zsh Tradition dictates that options are uppercase. 2012-01-23 20:40:43 -05:00
helper.zsh The functions directory should only hold functions. 2012-01-23 20:40:41 -05:00
history.zsh Tradition dictates that options are uppercase. 2012-01-23 20:40:43 -05:00
init.zsh Use relative path instead of OMZ variable. 2012-01-23 20:40:42 -05:00
keyboard.zsh Tradition dictates that options are uppercase. 2012-01-23 20:40:43 -05:00
README.md Source functions in the order needed. 2011-07-28 17:06:45 -04:00
spectrum.zsh The functions directory should only hold functions. 2012-01-23 20:40:41 -05:00
terminal.zsh Tradition dictates that options are uppercase. 2012-01-23 20:40:43 -05:00
utility.zsh The functions directory should only hold functions. 2012-01-23 20:40:41 -05:00

A handful of functions, auto-complete helpers, and stuff that makes you shout...

“OH MY ZSHELL!”

Setup

oh-my-zsh should work with any recent release of ZSH, but the minimum recommended version is 4.3.9.

  1. Clone the repository.

    git clone git://github.com/sorin-ionescu/oh-my-zsh.git ~/.oh-my-zsh

  2. Create a new ZSH configuration by copying the ZSH template provided.

NOTE: If you already have a ~/.zshrc file, you should back it up with cp ~/.zshrc{,.orig} in case you want to go back to your original settings.

cp ~/.oh-my-zsh/templates/zshrc.template.zsh ~/.zshrc
  1. Set ZSH as your default shell:

    chsh -s /bin/zsh

  2. Start / restart ZSH by opening a new terminal window or tab.

Problems?

If you are not able to find certain commands after switching to Oh My ZSH, you need to modify PATH in ~/.zshrc, or better yet, in ~/functions/02.environment.zsh (may be subject to merge conflicts).

Usage

  • Enable the plugins you want in ~/.zshrc.

    • Browse plugins/ to see what is available.
    • Populate the plugins array plugins=(git osx ruby).
  • Change the prompt in ~/.zshrc.

    • For a list of themes, type prompt -l.
    • To preview a theme, type prompt -p name.

Useful

The ZSH Reference Card is tasty.

Customization

If you have many related functions, you can organise them in a file in the functions/ directory.

Help out!

I am not a ZSH expert and suspect that there are improvements to be made. If you have ideas on how to make the configuration easier to maintain or improve the performance, do not hesitate to fork and send pull requests!

Contributors

This project would not exist without all of our awesome users and contributors.

  • View the growing list of contributors.

Thank you so much!