1 <p align="center"><img src="https://ohmyzsh.s3.amazonaws.com/omz-ansi-github.png" alt="Oh My Zsh"></p>
3 Oh My Zsh is an open source, community-driven framework for managing your [zsh](https://www.zsh.org/) configuration.
5 Sounds boring. Let's try again.
7 **Oh My Zsh will not make you a 10x developer...but you may feel like one.**
9 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?"_
11 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. 😬
13 To learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter, and join us on [Discord](https://discord.gg/ohmyzsh).
15 [![CI](https://github.com/ohmyzsh/ohmyzsh/workflows/CI/badge.svg)](https://github.com/ohmyzsh/ohmyzsh/actions?query=workflow%3ACI)
16 [![Follow @ohmyzsh](https://img.shields.io/twitter/follow/ohmyzsh?label=Follow+@ohmyzsh&style=flat)](https://twitter.com/intent/follow?screen_name=ohmyzsh)
17 [![Discord server](https://img.shields.io/discord/642496866407284746)](https://discord.gg/ohmyzsh)
18 [![Gitpod ready](https://img.shields.io/badge/Gitpod-ready-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ohmyzsh/ohmyzsh)
19 [![huntr.dev](https://cdn.huntr.dev/huntr_security_badge_mono.svg)](https://huntr.dev/bounties/disclose/?utm_campaign=ohmyzsh%2Fohmyzsh&utm_medium=social&utm_source=github&target=https%3A%2F%2Fgithub.com%2Fohmyzsh%2Fohmyzsh)
22 <summary>Table of Contents</summary>
24 - [Getting Started](#getting-started)
25 - [Prerequisites](#prerequisites)
26 - [Basic Installation](#basic-installation)
27 - [Manual inspection](#manual-inspection)
28 - [Using Oh My Zsh](#using-oh-my-zsh)
30 - [Enabling Plugins](#enabling-plugins)
31 - [Using Plugins](#using-plugins)
33 - [Selecting a Theme](#selecting-a-theme)
35 - [Advanced Topics](#advanced-topics)
36 - [Advanced Installation](#advanced-installation)
37 - [Custom Directory](#custom-directory)
38 - [Unattended install](#unattended-install)
39 - [Installing from a forked repository](#installing-from-a-forked-repository)
40 - [Manual Installation](#manual-installation)
41 - [Installation Problems](#installation-problems)
42 - [Custom Plugins and Themes](#custom-plugins-and-themes)
43 - [Getting Updates](#getting-updates)
44 - [Manual Updates](#manual-updates)
45 - [Uninstalling Oh My Zsh](#uninstalling-oh-my-zsh)
46 - [How do I contribute to Oh My Zsh?](#how-do-i-contribute-to-oh-my-zsh)
47 - [Do NOT send us themes](#do-not-send-us-themes)
48 - [Contributors](#contributors)
49 - [Follow Us](#follow-us)
50 - [Merchandise](#merchandise)
52 - [About Planet Argon](#about-planet-argon)
60 - A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL2 is preferred, but cygwin or msys also mostly work.
61 - [Zsh](https://www.zsh.org) should be installed (v4.3.9 or more recent is fine but we prefer 5.0.8 and newer). If not pre-installed (run `zsh --version` to confirm), check the following wiki instructions here: [Installing ZSH](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH)
62 - `curl` or `wget` should be installed
63 - `git` should be installed (recommended v2.4.11 or higher)
65 ### Basic Installation
67 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.
70 | :-------- | :------------------------------------------------------------------------------------------------ |
71 | **curl** | `sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` |
72 | **wget** | `sh -c "$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` |
73 | **fetch** | `sh -c "$(fetch -o - https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` |
75 _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`._
77 #### Manual inspection
79 It's a good idea to inspect the install script from projects you don't yet know. You can do
80 that by downloading the install script first, looking through it so everything looks normal,
84 wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh
92 Oh My Zsh comes with a shitload of plugins for you to take advantage of. You can take a look in the [plugins](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins) directory and/or the [wiki](https://github.com/ohmyzsh/ohmyzsh/wiki/Plugins) to see what's currently available.
96 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.
102 For example, this might begin to look like this:
116 _Note that the plugins are separated by whitespace (spaces, tabs, new lines...). **Do not** use commas between them or it will break._
120 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.
124 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](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes) on the wiki (We are working on updating this!). Check them out!
126 #### Selecting a Theme
128 _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)._
130 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:
133 ZSH_THEME="robbyrussell"
136 To use a different theme, simply change the value to match the name of your desired theme. For example:
139 ZSH_THEME="agnoster" # (this is one of the fancy ones)
140 # see https://github.com/ohmyzsh/ohmyzsh/wiki/Themes#agnoster
143 _Note: many themes require installing a [Powerline Font](https://github.com/powerline/fonts) or a [Nerd Font](https://github.com/ryanoasis/nerd-fonts) in order to render properly. Without them, these themes will render [weird prompt symbols](https://github.com/ohmyzsh/ohmyzsh/wiki/FAQ#i-have-a-weird-character-in-my-prompt)_
145 Open up a new terminal window and your prompt should look something like this:
147 ![Agnoster theme](https://cloud.githubusercontent.com/assets/2618447/6316862/70f58fb6-ba03-11e4-82c9-c083bf9a6574.png)
149 In case you did not find a suitable theme for your needs, please have a look at the wiki for [more of them](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes).
151 If you're feeling feisty, you can let the computer select one randomly for you each time you open a new terminal window.
154 ZSH_THEME="random" # (...please let it be pie... please be some pie..)
157 And if you want to pick random theme from a list of your favorite themes:
160 ZSH_THEME_RANDOM_CANDIDATES=(
166 If you only know which themes you don't like, you can add them similarly to an ignored list:
169 ZSH_THEME_RANDOM_IGNORED=(pygmalion tjkirch_mod)
174 If you have some more questions or issues, you might find a solution in our [FAQ](https://github.com/ohmyzsh/ohmyzsh/wiki/FAQ).
178 If you're the type that likes to get their hands dirty, these sections might resonate.
180 ### Advanced Installation
182 Some users may want to manually install Oh My Zsh, or change the default path or other settings that
183 the installer accepts (these settings are also documented at the top of the install script).
185 #### Custom Directory
187 The default location is `~/.oh-my-zsh` (hidden in your home directory, you can access it with `cd ~/.oh-my-zsh`)
189 If you'd like to change the install directory with the `ZSH` environment variable, either by running
190 `export ZSH=/your/path` before installing, or by setting it before the end of the install pipeline
194 ZSH="$HOME/.dotfiles/oh-my-zsh" sh install.sh
197 #### Unattended install
199 If you're running the Oh My Zsh install script as part of an automated install, you can pass the `--unattended`
200 flag to the `install.sh` script. This will have the effect of not trying to change
201 the default shell, and it also won't run `zsh` when the installation has finished.
204 sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattended
207 #### Installing from a forked repository
209 The install script also accepts these variables to allow installation of a different repository:
211 - `REPO` (default: `ohmyzsh/ohmyzsh`): this takes the form of `owner/repository`. If you set
212 this variable, the installer will look for a repository at `https://github.com/{owner}/{repository}`.
214 - `REMOTE` (default: `https://github.com/${REPO}.git`): this is the full URL of the git repository
215 clone. You can use this setting if you want to install from a fork that is not on GitHub (GitLab,
216 Bitbucket...) or if you want to clone with SSH instead of HTTPS (`git@github.com:user/project.git`).
218 _NOTE: it's incompatible with setting the `REPO` variable. This setting will take precedence._
220 - `BRANCH` (default: `master`): you can use this setting if you want to change the default branch to be
221 checked out when cloning the repository. This might be useful for testing a Pull Request, or if you
222 want to use a branch other than `master`.
227 REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh
230 #### Manual Installation
232 ##### 1. Clone the repository <!-- omit in toc -->
235 git clone https://github.com/ohmyzsh/ohmyzsh.git ~/.oh-my-zsh
238 ##### 2. _Optionally_, backup your existing `~/.zshrc` file <!-- omit in toc -->
241 cp ~/.zshrc ~/.zshrc.orig
244 ##### 3. Create a new zsh configuration file <!-- omit in toc -->
246 You can create a new zsh config file by copying the template that we have included for you.
249 cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc
252 ##### 4. Change your default shell <!-- omit in toc -->
258 You must log out from your user session and log back in to see this change.
260 ##### 5. Initialize your new zsh configuration <!-- omit in toc -->
262 Once you open up a new terminal window, it should load zsh with Oh My Zsh's configuration.
264 ### Installation Problems
266 If you have any hiccups installing, here are a few common fixes.
268 - You _might_ need to modify your `PATH` in `~/.zshrc` if you're not able to find some commands after switching to `oh-my-zsh`.
269 - If you installed manually or changed the install location, check the `ZSH` environment variable in `~/.zshrc`.
271 ### Custom Plugins and Themes
273 If you want to override any of the default behaviors, just add a new file (ending in `.zsh`) in the `custom/` directory.
275 If you have many functions that go well together, you can put them as a `XYZ.plugin.zsh` file in the `custom/plugins/` directory and then enable this plugin.
277 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/`.
281 By default, you will be prompted to check for updates every 2 weeks. You can choose other update modes by adding a line to your `~/.zshrc` file, **before Oh My Zsh is loaded**:
283 1. Automatic update without confirmation prompt:
286 zstyle ':omz:update' mode auto
289 2. Just offer a reminder every few days, if there are updates available:
292 zstyle ':omz:update' mode reminder
295 3. To disable automatic updates entirely:
298 zstyle ':omz:update' mode disabled
301 NOTE: you can control how often Oh My Zsh checks for updates with the following setting:
304 # This will check for updates every 7 days
305 zstyle ':omz:update' frequency 7
306 # This will check for updates every time you open the terminal (not recommended)
307 zstyle ':omz:update' frequency 0
312 If you'd like to update at any point in time (maybe someone just released a new plugin and you don't want to wait a week?) you just need to run:
320 ## Uninstalling Oh My Zsh
322 Oh My Zsh isn't for everyone. We'll miss you, but we want to make this an easy breakup.
324 If you want to uninstall `oh-my-zsh`, just run `uninstall_oh_my_zsh` from the command-line. It will remove itself and revert your previous `bash` or `zsh` configuration.
326 ## How do I contribute to Oh My Zsh?
328 Before you participate in our delightful community, please read the [code of conduct](CODE_OF_CONDUCT.md).
330 I'm far from being a [Zsh](https://www.zsh.org/) expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!
332 We also need people to test out pull requests. So take a look through [the open issues](https://github.com/ohmyzsh/ohmyzsh/issues) and help where you can.
334 See [Contributing](CONTRIBUTING.md) for more details.
336 ### Do NOT send us themes
338 We have (more than) enough themes for the time being. Please add your theme to the [external themes](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes) wiki page.
342 Oh My Zsh has a vibrant community of happy users and delightful contributors. Without all the time and help from our contributors, it wouldn't be so awesome.
348 We're on social media:
350 - [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter. You should follow it.
351 - [Facebook](https://www.facebook.com/Oh-My-Zsh-296616263819290/) poke us.
352 - [Instagram](https://www.instagram.com/_ohmyzsh/) tag us in your post showing Oh My Zsh!
353 - [Discord](https://discord.gg/ohmyzsh) to chat with us!
357 We have [stickers, shirts, and coffee mugs available](https://shop.planetargon.com/collections/oh-my-zsh?utm_source=github) for you to show off your love of Oh My Zsh. Again, you will become the talk of the town!
361 Oh My Zsh is released under the [MIT license](LICENSE.txt).
363 ## About Planet Argon
365 ![Planet Argon](https://pa-github-assets.s3.amazonaws.com/PARGON_logo_digital_COL-small.jpg)
367 Oh My Zsh was started by the team at [Planet Argon](https://www.planetargon.com/?utm_source=github), a [Ruby on Rails development agency](https://www.planetargon.com/skills/ruby-on-rails-development?utm_source=github). Check out our [other open source projects](https://www.planetargon.com/open-source?utm_source=github).