mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2025-12-26 02:12:33 +01:00

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

cli cli-app hacktoberfest oh-my-zsh oh-my-zsh-plugin oh-my-zsh-theme ohmyzsh plugin-framework plugins productivity shell terminal theme themes zsh zsh-configuration

Find a file

Simon Gomizelj c83ecd5d1a Output error messages in sprunge to stderr.		2011-11-29 15:46:53 -05:00
lib	Making command-not-found support a plugin.	2011-11-29 07:01:52 -05:00
plugins	Output error messages in sprunge to stderr.	2011-11-29 15:46:53 -05:00
templates	Updated templates.	2011-11-29 14:51:46 -05:00
themes	This was saved from tools, as those tools are worthless for arch! AUR/pkgbuild ftw!	2011-11-29 16:40:38 +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
oh-my-zsh.zsh	Source .zsh files ~/.omz instead of ~/.omz/lib for user customizations. Use NULL_GLOB when sourcing files in directory to properly deal with no matches.	2011-11-29 13:37:34 -05:00
README.md	Touched up README	2011-11-29 12:41:49 -05:00

README.md

"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

The user must have zsh set as their shell.

# chsh -s /bin/zsh <USERNAME>

The following needs to be added to the start of the user's ~/.zshrc file to activate oh-my-zshell goodness.

ZSH_THEME="arch-blue"
plugins=(archlinux sprunge git)
load_oh_my_zshell

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

Customization

To enable more the plugins, customize the plugins array in your ~/.zshrc
To change themes, change the ZSH_THEME environment variable in ~/.zshrc.

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.