prezto

The configuration framework for Zsh

Go to file

Sorin Ionescu 5f81b5ba1e View Git index diffs in Vim.		13 years ago
completions@62436acb8a	Added zsh-completions.	13 years ago
functions	Moved hub into the git plugin.	13 years ago
plugins	View Git index diffs in Vim.	13 years ago
templates	The theme should manage the completion indicator.	13 years ago
themes	The theme should manage the completion indicator.	13 years ago
.gitignore	Ignore plugin cache files.	13 years ago
.gitmodules	Added zsh-completions.	13 years ago
README.md	Added the MIT license.	13 years ago
alias.zsh	Alias p to PAGER since v is reserved for Vim.	13 years ago
completion.zsh	Use zstyle instead of variables for configuration.	13 years ago
directory.zsh	Tradition dictates that options are uppercase.	13 years ago
environment.zsh	Export INFOPATH for GNU info documentation.	13 years ago
helper.zsh	Added missing parenthesis to a few functions.	13 years ago
history.zsh	Removed redundant APPEND_HISTORY option.	13 years ago
init.zsh	Print an error when a plugin is not found.	13 years ago
keyboard.zsh	Do not bind empty key entries.	13 years ago
spectrum.zsh	Moved hub into the git plugin.	13 years ago
terminal.zsh	Added missing parenthesis to a few functions.	13 years ago
utility.zsh	Moved hub into the git plugin.	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.

Clone the repository.

git clone git://github.com/sorin-ionescu/oh-my-zsh.git ~/.oh-my-zsh
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

Set Zsh as your default shell:

chsh -s /bin/zsh
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!

License

(The MIT License)

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.