Oh My Zsh is an open source, community-driven framework for managing your zsh configuration.
Sounds boring. Let's try again.
Oh My Zsh will not make you a 10x developer...but you may feel like one.
Once installed, your terminal shell will become the talk of the town or your money back! With each keystroke in your command prompt, you'll take advantage of the hundreds of powerful plugins and beautiful themes. Strangers will come up to you in cafรฉs and ask you, "that is amazing! are you some sort of genius?"
Finally, you'll begin to get the sort of attention that you have always felt you deserved. ...or maybe you'll use the time that you're saving to start flossing more often. ๐ฌ
To learn more, visit ohmyz.sh, follow @ohmyzsh on Twitter, and/or join us on Discord.
- A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL is preferred, but cygwin or msys also mostly work.
- Zsh should be installed (v4.3.9 or more recent). If not pre-installed (run
zsh --version
to confirm), check the following instructions here: Installing ZSH curl
orwget
should be installedgit
should be installed (recommended v1.7.2 or higher)
Oh My Zsh is installed by running one of the following commands in your terminal. You can install this via the command-line with either curl
or wget
.
sh -c "$(curl -fsSL https://github.com/lylyulei/ohmyzsh/master/tools/install.sh)"
sh -c "$(wget -O- https://github.com/lylyulei/ohmyzsh/master/tools/install.sh)"
It's a good idea to inspect the install script from projects you don't yet know. You can do that by downloading the install script first, looking through it so everything looks normal, then running it:
curl -Lo install.sh https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh
sh install.sh
Oh My Zsh comes with a shitload of plugins to take advantage of. You can take a look in the plugins directory and/or the wiki to see what's currently available.
Once you spot a plugin (or several) that you'd like to use with Oh My Zsh, you'll need to enable them in the .zshrc
file. You'll find the zshrc file in your $HOME
directory. Open it with your favorite text editor and you'll see a spot to list all the plugins you want to load.
vi ~/.zshrc
For example, this might begin to look like this:
plugins=(
git
bundler
dotenv
osx
rake
rbenv
ruby
)
Note that the plugins are separated by whitespace. Do not use commas between them.
Most plugins (should! we're working on this) include a README, which documents how to use them.
We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred themes now bundled. Most of them have screenshots on the wiki. Check them out!
Robby's theme is the default one. It's not the fanciest one. It's not the simplest one. It's just the right one (for him).
Once you find a theme that you'd like to use, you will need to edit the ~/.zshrc
file. You'll see an environment variable (all caps) in there that looks like:
ZSH_THEME="robbyrussell"
To use a different theme, simply change the value to match the name of your desired theme. For example:
ZSH_THEME="agnoster" # (this is one of the fancy ones)
# see https://github.com/ohmyzsh/ohmyzsh/wiki/Themes#agnoster
Note: many themes require installing the Powerline Fonts in order to render properly.
Open up a new terminal window and your prompt should look something like this:
In case you did not find a suitable theme for your needs, please have a look at the wiki for more of them.
If you're feeling feisty, you can let the computer select one randomly for you each time you open a new terminal window.
ZSH_THEME="random" # (...please let it be pie... please be some pie..)
And if you want to pick random theme from a list of your favorite themes:
ZSH_THEME_RANDOM_CANDIDATES=(
"robbyrussell"
"agnoster"
)
If you only know which themes you don't like, you can add them similarly to a blacklist:
ZSH_THEME_RANDOM_BLACKLIST=(pygmalion tjkirch_mod)
If you have some more questions or issues, you might find a solution in our FAQ.
If you're the type that likes to get their hands dirty, these sections might resonate.
Some users may want to manually install Oh My Zsh, or change the default path or other settings that the installer accepts (these settings are also documented at the top of the install script).
The default location is ~/.oh-my-zsh
(hidden in your home directory)
If you'd like to change the install directory with the ZSH
environment variable, either by running
export ZSH=/your/path
before installing, or by setting it before the end