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

James McGlashan 8fb2c8d878 Merge branch 'master' of github.com:jamesm-sitegen/oh-my-zsh * 'master' of github.com:jamesm-sitegen/oh-my-zsh: Try again. This works. Load themes from ~/.omz/themes/ too We should start documenting things. Opps, not start, should be init. Fix needs to be named the same as the function This should be interesting. Attempt to install omz as a site function instead. Bad typo. set_theme $theme, not set_theme theme		2011-12-03 10:20:23 +11:00
lib	Try again. This works.	2011-12-02 12:54:42 -05:00
plugins	We should start documenting things.	2011-12-02 11:00:25 -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	Opps, not start, should be init.	2011-12-02 09:54:16 -05:00
README.md	We should start documenting things.	2011-12-02 11:00:25 -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

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

Customization

To enable more the plugins, customize the plugins array in your ~/.zshrc
To change themes, change the :omz:style zstyle 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.