The configuration framework for Zsh
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Sorin Ionescu 62fc8d802e
Separate unsetopt from setopt for clarity.
13 years ago
completions@62436acb8a Added zsh-completions. 13 years ago
plugins Tradition dictates that options are uppercase. 13 years ago
templates Added missing FX and named colors to spectrum. 13 years ago
themes Separate unsetopt from setopt for clarity. 13 years ago
.gitignore Ignore plugin cache files. 14 years ago
.gitmodules Added zsh-completions. 13 years ago
README.md Source functions in the order needed. 14 years ago
alias.zsh Tradition dictates that options are uppercase. 13 years ago
completion.zsh Tradition dictates that options are uppercase. 13 years ago
directory.zsh Tradition dictates that options are uppercase. 13 years ago
environment.zsh Tradition dictates that options are uppercase. 13 years ago
helper.zsh The functions directory should only hold functions. 13 years ago
history.zsh Tradition dictates that options are uppercase. 13 years ago
init.zsh Use relative path instead of OMZ variable. 13 years ago
keyboard.zsh Tradition dictates that options are uppercase. 13 years ago
spectrum.zsh The functions directory should only hold functions. 13 years ago
terminal.zsh Tradition dictates that options are uppercase. 13 years ago
utility.zsh The functions directory should only hold functions. 13 years ago

README.md

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!