Oshuma / oh-my-zsh
watch download tarball
public
Forks89Right
Watchers3Right
Fork of robbyrussell/oh-my-zsh
Description: A community-driven framework for managing your zsh configuration.
Homepage:
Clone URL: git://github.com/Oshuma/oh-my-zsh.git
name age
history
message
file .gitignore Wed Sep 23 08:14:04 -0700 2009 merge upstream [imajes]
file README.textile Thu Nov 12 10:14:09 -0800 2009 gave credit to Nick for the rake autocompletion... [technoweenie]
directory custom/ Wed Sep 23 08:02:58 -0700 2009 Moving some example files into custom/ [robbyrussell]
directory functions/ Sun Oct 25 21:47:23 -0700 2009 adding homebrew completions - and a function dir [kastner]
directory lib/ Loading commit data...
directory log/ Mon Aug 31 11:17:05 -0700 2009 Adding a file into log/ so that we have a log f... [robbyrussell]
file oh-my-zsh.sh Sun Oct 25 21:47:23 -0700 2009 adding homebrew completions - and a function dir [kastner]
directory templates/ Thu Nov 05 11:44:28 -0800 2009 Enabled colors in ls and made it possible to th... [To1ne]
directory themes/
directory tools/ Fri Oct 16 14:03:50 -0700 2009 Removed useless else [To1ne]
README.textile

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

“OH MY ZSHELL!”

Setup

The automatic installer… (do you trust me?)

wget http://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | sh

The manual way

1. Clone the repository

git clone git://github.com/robbyrussell/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

TODO: Update this..

  • Rake autocomplete: rake (tab). Will generate a cache of all your rake tasks and then let you auto-complete and/or select the task to run.
  • ssh autocomplete: ssh (tab) or scp (tab)
  • Git branch, it’ll tell you which branch you’re in when you’re in a git repository directory.
  • Theme support: Change the ZSH_THEME environment variable in ~/.zshrc.
  • much much more..

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.

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).

Thanks

  • Rick Olson (technoweenie) might remember some of the configuration, which I took from a pastie a few years ago.
  • Marcel (noradio) provided Rick the original zsh configuration.
  • Nicholas (ulysses) for the rake autocompletion code.

Help out!

I’m far from being a zsh-expert and suspect there are many ways to improve. If you have ideas on how to make the configuration easier to maintain (and faster), don’t hesitate to fork and send pull requests!

Send us your theme!

I’m hoping to collect a bunch of themes for our command prompts. You can see existing ones in the themes/ directory.

Todo from imajes:

  • need to make the title bar support git folder