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…
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 X (formerly
Twitter), and join us on Discord.
Table of Contents
- [Getting Started](#getting-started)
- [Using Oh My Zsh](#using-oh-my-zsh)
- [Advanced Topics](#advanced-topics)
- [Getting Updates](#getting-updates)
- [Uninstalling Oh My Zsh](#uninstalling-oh-my-zsh)
- [How Do I Contribute To Oh My Zsh?](#how-do-i-contribute-to-oh-my-zsh)
- [Contributors](#contributors)
- [Follow Us](#follow-us)
- [Merchandise](#merchandise)
- [License](#license)
- [About Planet Argon](#about-planet-argon)
Getting Started
Operating System Compatibility
| O/S | Status |
| :------------- | :----: |
| Android | ✅ |
| FreeBSD | ✅ |
| LCARS | 🛸 |
| Linux | ✅ |
| macOS | ✅ |
| OS/2 Warp | ❌ |
| Windows (WSL2) | ✅ |
Prerequisites
- Zsh should be installed (v4.3.9 or more recent is fine but we prefer 5.0.8 and
zsh --version to confirm), check the following wiki instructions here:
Installing ZSH
curlorwgetshould be installedgitshould be installed (recommended v2.4.11 or higher)
Basic Installation
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, wget or another similar tool.
| Method | Command |
| :-------- | :------------------------------------------------------------------------------------------------ |
| curl | sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" |
| wget | sh -c "$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" |
| fetch | sh -c "$(fetch -o - https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" |
Alternatively, the installer is also mirrored outside GitHub. Using this URL instead may be required if you're
in a country like China or India (for certain ISPs), that blocks raw.githubusercontent.com:
| Method | Command |
| :-------- | :------------------------------------------------ |
| curl | sh -c "$(curl -fsSL https://install.ohmyz.sh/)" |
| wget | sh -c "$(wget -O- https://install.ohmyz.sh/)" |
| fetch | sh -c "$(fetch -o - https://install.ohmyz.sh/)" |
_Note that any previous .zshrc will be renamed to .zshrc.pre-oh-my-zsh. After installation, you can move
the configuration you want to preserve into the new .zshrc._
Manual Inspection
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:
sh
wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh
sh install.shIf the above URL times out or otherwise fails, you may have to substitute the URL forhttps://install.ohmyz.sh to be able to get the script.
Using Oh My Zsh
Plugins
Oh My Zsh comes with a shitload of plugins for you to take advantage of. You can take a look in the
plugins directory and/or the
wiki to see what's currently available.
Enabling Plugins
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.
sh
vi ~/.zshrcFor example, this might begin to look like this:
sh
plugins=(
git
bundler
dotenv
macos
rake
rbenv
ruby
)_Note that the plugins are separated by whitespace (spaces, tabs, new lines...). Do not use commas between
them or it will break._
Using Plugins
Each built-in plugin includes a README, documenting it. This README should show the aliases (if the plugin
adds any) and extra goodies that are included in that particular plugin.
Themes
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 and fifty themes now bundled. Most of them have
screenshots on the wiki (We are working on updating this!).
Check them out!
Selecting A Theme
_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:
sh
ZSH_THEME="robbyrussell"To use a different theme, simply change the value to match the name of your desired theme. For example:
sh
ZSH_THEME="agnoster" # (this is one of the fancy ones)
# see https://github.com/ohmyzsh/ohmyzsh/wiki/Themes#agnoster<!-- prettier-ignore-start -->
> [!NOTE]
> You will many times see screenshots for a zsh theme, and try it out, and find that it doesn't look the same for you.
>
> This is because many themes require installing a Powerline Font or a
> Nerd Font in order to render properly. Without them, these themes
> will render weird prompt symbols. Check out
> the FAQ for more
> information.
>
> Also, beware that themes only control what your prompt looks like. This is, the text you see before or after
> your cursor, where you'll type your commands. Themes don't control things such as the colors of your
> terminal window (known as _color scheme_) or the font of your terminal. These are settings that you can
> change in your terminal emulator. For more information, see
> what is a zsh theme.
<!-- prettier-ignore-end -->
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.
sh
ZSH_THEME="random" # (...please let it be pie... please be some pie..)And if you want to pick a random theme from a list of your favorite themes:
sh
ZSH_THEME_RANDOM_CANDIDATES=(
"robbyrussell"
"agnoster"
)If you only know which themes you don't like, you can add them similarly to an ignored list:
sh
ZSH_THEME_RANDOM_IGNORED=(pygmalion tjkirch_mod)FAQ
If you have some more questions or issues, you might find a solution in our
FAQ.
Advanced Topics
If you're the type that likes to get their hands dirty, these sections might resonate.
Advanced Installation
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).
Custom Directory
The default location is ~/.oh-my-zsh (hidden in your home directory, you can access it withcd ~/.oh-my-zsh)
If you'd like to change the install directory with the ZSH environment variable, either by runningexport ZSH=/your/path before installing, or by setting it before the end of the install pipeline like this:
sh
ZSH="$HOME/.dotfiles/oh-my-zsh" sh install.shUnattended Install
If you're running the Oh My Zsh install script as part of an automated install, you can pass the--unattended flag to the install.sh script. This will have the effect of not trying to change the default
shell, and it also won't run zsh when the installation has finished.
sh
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattendedIf you're in China, India, or another country that blocks raw.githubusercontent.com, you may have to
substitute the URL for https://install.ohmyz.sh for it to install.
Installing From A Forked Repository
The install script also accepts these variables to allow the installation of a different repository:
REPO(default:ohmyzsh/ohmyzsh): this takes the form ofowner/repository. If you set this variable,
https://github.com/{owner}/{repository}.
REMOTE(default:https://github.com/${REPO}.git): this is the full URL of the git repository clone. You
[email protected]:user/project.git).
_NOTE: it's incompatible with setting the REPO variable. This setting will take precedence._
BRANCH(default:master): you can use this setting if you want to change the default branch to be
master.
For example:
sh
REPO=apjanke/oh-my-zsh BRANCH=edge sh install.shManual Installation
1. Clone The Repository <!-- omit in toc -->
sh
git clone https://github.com/ohmyzsh/ohmyzsh.git ~/.oh-my-zsh2. _Optionally_, Backup Your Existing ~/.zshrc File <!-- omit in toc -->
sh
cp ~/.zshrc ~/.zshrc.orig3. Create A New Zsh Configuration File <!-- omit in toc -->
You can create a new zsh config file by copying the template that we have included for you.
sh
cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc4. Change Your Default Shell <!-- omit in toc -->
sh
chsh -s $(which zsh)You must log out from your user session and log back in to see this change.
5. Initialize Your New Zsh Configuration <!-- omit in toc -->
Once you open up a new terminal window, it should load zsh with Oh My Zsh's configuration.
Installation Problems
If you have any hiccups installing, here are a few common fixes.
- You _might_ need to modify your
PATHin~/.zshrcif you're not able to find some commands after
oh-my-zsh.
- If you installed manually or changed the install location, check the
ZSHenvironment variable in
~/.zshrc.
Custom Plugins And Themes
If you want to override any of the default behaviors, just add a new file (ending in .zsh) in the custom/
directory.
If you have many functions that go well together, you can put them as a XYZ.plugin.zsh file in thecustom/plugins/ directory and then enable this plugin.
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 custom/plugins/ directory and it will be loaded instead of the one in plugins/.
Enable GNU ls In macOS And FreeBSD Systems
The default behaviour in Oh My Zsh is to use BSD ls in macOS and FreeBSD systems. If GNU ls is installed
(as gls command), you can choose to use it instead. To do it, you can use zstyle-based config before
sourcing oh-my-zsh.sh:
zsh
zstyle ':omz:lib:theme-and-appearance' gnu-ls yes_Note: this is not compatible with DISABLE_LS_COLORS=true_
Skip Aliases
If you want to skip default Oh My Zsh aliases (those defined in lib/* files) or plugin aliases, you can use
the settings below in your ~/.zshrc file, before Oh My Zsh is loaded. Note that there are many different
ways to skip aliases, depending on your needs.
sh
# Skip all aliases, in lib files and enabled plugins
zstyle ':omz:*' aliases no
# Skip all aliases in lib files
zstyle ':omz:lib:*' aliases no
# Skip only aliases defined in the directories.zsh lib file
zstyle ':omz:lib:directories' aliases no
# Skip all plugin aliases
zstyle ':omz:plugins:*' aliases no
# Skip only the aliases from the git plugin
zstyle ':omz:plugins:git' aliases noYou can combine these in other ways taking into account that more specific scopes take precedence:
sh
# Skip all plugin aliases, except for the git plugin
zstyle ':omz:plugins:*' aliases no
zstyle ':omz:plugins:git' aliases yesA previous version of this feature was using the setting below, which has been removed:
sh
zstyle ':omz:directories' aliases noInstead, you can now use the following:
sh
zstyle ':omz:lib:directories' aliases noNotice <!-- omit in toc -->
> This feature is currently in a testing phase and it may be subject to change in the future. It is also not
> currently compatible with plugin managers such as zpm or zinit, which don't source the init script
> (oh-my-zsh.sh) where
…
Members
-
ohmyzsh ★ PINNED
🙃 A delightful community-driven (with 2,500+ 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.
Shell ★ 189k 21h agoExplain → -
wiki ★ PINNED
Public repository to host the Oh My Zsh project wiki.
Python ★ 225 6d agoExplain → -
ohmyzsh-bot ★ PINNED
A bot to manage the ohmyzsh project
TypeScript ★ 47 21h agoExplain → -
docker ★ PINNED
Oh My Zsh docker images
Dockerfile ★ 25 2d agoExplain → -
github-actions ▣
Repository of GitHub Actions used by the Oh My Zsh project
Shell ★ 23 5y agoExplain → -
discord
Repository hosting Discord bot(s)
Python ★ 6 2y agoExplain → -
trace.ohmyz.sh ⑂
🔬 A fast, interactive web-based viewer for performance tracing of zsh, with all heavy lifting done thanks to speedscope.app 💪
TypeScript ★ 5 9mo agoExplain →
No repos match these filters.