2011-07-18 04:00:35 +00:00
|
|
|
A handful of functions, auto-complete helpers, and stuff that makes you shout...
|
|
|
|
|
|
|
|
|
|
> “OH MY ZSHELL!”
|
|
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
2011-10-12 03:13:58 +00:00
|
|
|
`oh-my-zsh` should work with any recent release of [Zsh](http://www.zsh.org), but the
|
2011-07-18 04:00:35 +00:00
|
|
|
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`
|
|
|
|
|
|
2011-10-12 03:13:58 +00:00
|
|
|
2. Create a new Zsh configuration by copying the Zsh template provided.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
|
|
|
|
**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
|
|
|
|
|
|
2011-10-12 03:13:58 +00:00
|
|
|
3. Set Zsh as your default shell:
|
2011-07-18 04:00:35 +00:00
|
|
|
|
|
|
|
|
`chsh -s /bin/zsh`
|
|
|
|
|
|
2011-10-12 03:13:58 +00:00
|
|
|
4. Start / restart Zsh by opening a new terminal window or tab.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
|
|
|
|
### Problems?
|
|
|
|
|
|
2011-10-12 03:13:58 +00:00
|
|
|
If you are not able to find certain commands after switching to *Oh My Zsh*, you need
|
2011-07-28 21:06:45 +00:00
|
|
|
to modify `PATH` in `~/.zshrc`, or better yet, in `~/functions/02.environment.zsh`
|
|
|
|
|
(may be subject to merge conflicts).
|
2011-07-18 04:00:35 +00:00
|
|
|
|
|
|
|
|
## 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
|
|
|
|
|
|
2011-10-12 03:13:58 +00:00
|
|
|
The [Zsh Reference Card](http://www.bash2zsh.com/zsh_refcard/refcard.pdf) is tasty.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
|
|
|
|
### Customization
|
|
|
|
|
|
|
|
|
|
If you have many related functions, you can organise them in a file in the
|
|
|
|
|
`functions/` directory.
|
|
|
|
|
|
|
|
|
|
## Help out!
|
|
|
|
|
|
2011-10-12 03:13:58 +00:00
|
|
|
I am not a Zsh expert and suspect that there are improvements to be made. If you have
|
2011-07-18 04:00:35 +00:00
|
|
|
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](https://github.com/robbyrussell/oh-my-zsh/contributors) of
|
|
|
|
|
contributors.
|
|
|
|
|
|
|
|
|
|
Thank you so much!
|
|
|
|
|
|
2011-12-28 22:04:43 +00:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
(The MIT License)
|
|
|
|
|
|
|
|
|
|
Copyright (c) 2011 Robby Russell, Sorin Ionescu, and contributors.
|
|
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
|
|
|
|
software and associated documentation files (the "Software"), to deal in the Software
|
|
|
|
|
without restriction, including without limitation the rights to use, copy, modify,
|
|
|
|
|
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
|
|
|
|
|
permit persons to whom the Software is furnished to do so, subject to the following
|
|
|
|
|
conditions:
|
|
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in all copies
|
|
|
|
|
or substantial portions of the Software.
|
|
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
|
|
|
|
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR
|
|
|
|
|
A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
|
|
|
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
|
|
|
|
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
|
|
|
|
|
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
|
|
