Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A community-driven framework for managing your zsh configuration. Includes 40+ optional plugins (rails, git, OSX, hub, capistrano, brew, ant, macports, etc), over 80 terminal themes to spice up your morning, and an auto-update tool so that makes it easy to keep up with the latest updates from the community.
Shell Ruby
branch: master

This branch is 47 commits ahead, 2135 commits behind robbyrussell:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
custom
lib
log
plugins
templates
themes
tools
zsh-completion @ 68c9494
zsh-syntax-highlighting @ 5320f1e
.gitignore
.gitmodules
README.textile
oh-my-zsh.sh
pludonizshrc
zgitinit

README.textile

Setup

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

The automatic installer

via `curl`

curl -L https://github.com/pludoni/oh-my-zsh/raw/master/tools/install.sh | sh

via `wget`

wget --no-check-certificate https://github.com/pludoni/oh-my-zsh/raw/master/tools/install.sh -O - | sh

The manual way

1. Clone the repository

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

2. Create a new zsh config by copying the zsh template we’ve provided.

NOTE: If you already have a ~/.zshrc file, you should back it up. cp ~/.zshrc ~/.zshrc.orig in case you want to go back to your original settings. cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc

3. Set zsh as your default shell:

chsh -s /bin/zsh

4. Start / restart zsh (open a new terminal is easy enough…)

Problems?

You might need to modify your PATH in ~/.zshrc if you’re not able to find some commands after switching to Oh My Zsh.

Usage

  • enable the plugins you want in your ~/.zshrc (take a look at plugins/ to see what’s possible)
    • example: plugins=(git osx ruby)
  • Theme support: Change the ZSH_THEME environment variable in ~/.zshrc.
  • much much more… take a look at lib/ what Oh My Zsh offers…

Useful

the refcard is pretty tasty for tips.

Customization

If you want to override any of the default behavior, just add a new file (ending in .zsh) into the custom/ directory.
If you have many functions which go well together you can put them as a *.plugin.zsh file in the custom/plugins/ directory and then enable this plugin.
If you would like to override the functionality of a plugin distributed with oh-my-zsh, create a plugin of the same name in the custom/plugins/ directory and it will be loaded instead of the one in plugins/.

Uninstalling

If you want to uninstall it, just run uninstall_oh_my_zsh from the command line and it’ll remove itself and revert you to bash (or your previous zsh config).

Contributors

Something went wrong with that request. Please try again.