This repository has been archived on 2022-03-28. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Sorin Ionescu ba9900a488 Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Conflicts:
	.gitignore
	lib/aliases.zsh
	lib/completion.zsh
	lib/functions.zsh
	lib/git.zsh
	lib/key-bindings.zsh
	lib/misc.zsh
	lib/spectrum.zsh
	plugins/git/git.plugin.zsh
	plugins/osx/_man-preview
	plugins/osx/osx.plugin.zsh
	plugins/svn/svn.plugin.zsh
	templates/zshrc.zsh-template
	themes/lukerandall.zsh-theme
	themes/philips.zsh-theme
	tools/upgrade.sh
2011-08-26 02:58:19 -04:00
functions Merged vi-mode plugin with Emacs key bindings. 2011-08-14 21:14:57 -04:00
plugins Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh 2011-08-26 02:58:19 -04:00
templates Merged vi-mode plugin with Emacs key bindings. 2011-08-14 21:14:57 -04:00
themes Converted OMZ themes to native ZSH themes. 2011-07-17 20:15:51 -04:00
.gitignore Compile files into a pre-parsed form for faster sourcing. 2011-07-28 17:00:56 -04:00
oh-my-zsh.zsh Source functions in the order needed. 2011-07-28 17:06:45 -04:00
README.md Source functions in the order needed. 2011-07-28 17:06:45 -04: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!