The configuration framework for Zsh

Go to file

Sorin Ionescu 7bf5773b3d Rename gnu-utils to gnu-utility		13 years ago
modules	Rename gnu-utils to gnu-utility	13 years ago
templates	[#23 , Fix #80 ] Move themes into the prompt module	13 years ago
.gitignore	[#23 ] Rename plugins to modules	13 years ago
.gitmodules	Merge completions into functions	13 years ago
README.md	Fix a typo in the main README	13 years ago
helper.zsh	[#125 ] Add a helper that checks callables	13 years ago
init.zsh	Simplify a few for loops	13 years ago

README.md

Oh My Zsh

OMZ is a configuration framework for Zsh that enriches the command line interface environment with sane defaults, aliases, functions, auto completion, and prompt themes.

Installation

Oh My Zsh will work with any recent release of Zsh, but the minimum recommended version is 4.3.10.

Clone the repository:

git clone https://github.com/sorin-ionescu/oh-my-zsh.git ~/.oh-my-zsh
Initialize the submodules:

cd ~/.oh-my-zsh && git submodule update --init --recursive
Create a new Zsh configuration by copying the Zsh template provided:

cp ~/.oh-my-zsh/templates/zshrc ~/.zshrc
Set Zsh as your default shell:

chsh -s /bin/zsh
Open a new Zsh terminal window or tab.

Mac OS X

If you have administrator privileges, you must fix an Apple misconfiguration in Mac OS X 10.7 Lion by renaming /etc/zshenv to /etc/zprofile, or Zsh will have the wrong PATH when executed non-interactively by scripts.

Troubleshooting

If you are not able to find certain commands after switching to Oh My Zsh, modify the PATH variable in environment.zsh then open a new Zsh terminal window or tab.

Usage

Oh My Zsh has many features disabled by default. Read the source code and accompanying README files to learn of what is available.

Modules

Browse modules/ to see what is available.
Load the modules you need in ~/.zshrc then open a new Zsh terminal window or tab.

Themes

For a list of themes, type prompt -l.
To preview a theme, type prompt -p name.
Load the theme you like in ~/.zshrc then open a new Zsh terminal window or tab.

Customization

The project is managed via Git. It is highly recommend that you commit your changes and push them to GitHub to not lose them. If you do not know how to use Git, follow this tutorial and bookmark this reference.

Completions

Submit program completions to the zsh-completions project. The Oh My Zsh completions directory will be synched against it.

Resources

The Zsh Reference Card is indispensable.

Contribute

This project would not exist without all of its users and contributors.

If you have ideas on how to make the configuration easier to maintain or improve its performance, do not hesitate to fork and send pull requests.

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.