🙃 A delightful community-driven (with 2,400+ contributors) framework for managing your zsh configuration. Includes 300+ optional plugins (rails, git, macOS, hub, docker, homebrew, node, php, python, etc), 140+ themes to spice up your morning, and an auto-update tool that makes it easy to keep up with the latest updates from the community.
Find a file
James McGlashan d872d12e76 testing
2011-12-06 17:07:07 +11:00
lib Try again. This works. 2011-12-02 12:54:42 -05:00
plugins Relicenced. 2011-12-04 12:20:08 -05:00
templates This should be interesting. 2011-12-02 09:52:28 -05:00
themes cleaned up a little bit, also added a space to help with selecting the current path 2011-12-03 00:43:43 +11:00
.gitignore Merge branch 'master' of git://github.com/robbyrussell/oh-my-zsh into taskwarrior-plugin 2011-05-29 18:51:32 -04:00
omz testing 2011-12-06 17:07:07 +11:00
README.md James you need to learn how to write markdown :P. 2011-12-04 12:16:35 -05:00

"OH MY ZSHELL!"

NOTE: This documentation isn't finished and this project is currently under rapid development. Be cautious, information here may not be up to date.

NOTE: This fork is specifically for Archlinux and has been patched for a system-wide install; Don't attempt to install to ~/.oh-my-zsh! This project had radically diverged away from its source. While plugins should remain compatible, there is much which has changed.

Setup

oh-my-zsh should work with any recent release of zsh, the minimum recommended version is 4.3.9. A package can be found in Archlinux's AUR. We recommend using cower to install it:

$ cower -dd oh-my-zsh-git

First set zsh as your shell.

$ chsh -s /bin/zsh

Then the following needs to be added to ~/.zshrc file to activate oh-my-zshell goodness.

autoload omz
zstyle :omz:style theme arch-blue
plugins=(archlinux sprunge git)
omz init

A skeleton template can be found at /usr/share/oh-my-zsh/templates/user.zsh-template

Here's some example configs:

Customization

  • To enable more the plugins, customize the plugins array in your ~/.zshrc
  • To change themes, change the :omz:style zstyle in ~/.zshrc.
  • To use sub-plugins simply add plugin/sub-plugin; example, archlinux/cower

If you want to override any of the default behaviour, just add a new file (ending in .zsh) into the ~/.omz/ directory. If you have many functions which go good together you can put them as a *.plugin.zsh file in the ~/.omz/plugins/ directory.

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 ~/.omz/plugins/ directory and it will be loaded instead of the one provided one.

Resources

The refcard is pretty tasty for tips.