Repository files navigation

Oh My Zsh is an open source, community-driven framework for managing yourzshconfiguration.

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 townor your money back! With each keystrokein 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'lluse the time that you're saving to start flossing more often. 😬

To learn more, visitohmyz.sh, follow@ohmyzsh on X (formerlyTwitter), and join us onDiscord.

• Zsh should be installed (v4.3.9 or more recent is fine but we prefer 5.0.8 andnewer). If not pre-installed (runzsh --version to confirm), check the following wiki instructions here:Installing ZSH
• curl orwget should be installed
• git should be installed (recommended v2.4.11 or higher)

Oh My Zsh is installed by running one of the following commands in your terminal. You can install this via thecommand-line with eithercurl,wget or another similar tool.

Alternatively, the installer is also mirrored outside GitHub. Using this URL instead may be required if you'rein a country like China or India (for certain ISPs), that blocksraw.githubusercontent.com:

Note that any previous.zshrc will be renamed to.zshrc.pre-oh-my-zsh. After installation, you can movethe configuration you want to preserve into the new.zshrc.

It's a good idea to inspect the install script from projects you don't yet know. You can do that bydownloading the install script first, looking through it so everything looks normal, then running it:

wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.shsh install.sh

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

Oh My Zsh comes with a shitload of plugins for you to take advantage of. You can take a look in theplugins directory and/or thewiki 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 editorand 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  macos  rake  rbenv  ruby)

Note that the plugins are separated by whitespace (spaces, tabs, new lines...).Do not use commas betweenthem or it will break.

Each built-in plugin includes aREADME, documenting it. This README should show the aliases (if the pluginadds any) and extra goodies that are included in that particular plugin.

We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over onehundred and fifty themes now bundled. Most of them havescreenshots on the wiki (We are working on updating this!).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 rightone (for him).

Once you find a theme that you'd like to use, you will need to edit the~/.zshrc file. You'll see anenvironment 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

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 formore of them.

If you're feeling feisty, you can let the computer select one randomly for you each time you open a newterminal 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 an ignored list:

ZSH_THEME_RANDOM_IGNORED=(pygmalion tjkirch_mod)

If you have some more questions or issues, you might find a solution in ourFAQ.

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 theinstaller 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, you can access it withcd ~/.oh-my-zsh)

If you'd like to change the install directory with theZSH environment variable, either by runningexport ZSH=/your/path before installing, or by setting it before the end of the install pipeline like this:

ZSH="$HOME/.dotfiles/oh-my-zsh" sh install.sh

If you're running the Oh My Zsh install script as part of an automated install, you can pass the--unattended flag to theinstall.sh script. This will have the effect of not trying to change the defaultshell, and it also won't runzsh when the installation has finished.

sh -c"$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)""" --unattended

If you're in China, India, or another country that blocksraw.githubusercontent.com, you may have tosubstitute the URL forhttps://install.ohmyz.sh for it to install.

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,the installer will look for a repository athttps://github.com/{owner}/{repository}.

• REMOTE (default:https://github.com/${REPO}.git): this is the full URL of the git repository clone. Youcan use this setting if you want to install from a fork that is not on GitHub (GitLab, Bitbucket...) or ifyou want to clone with SSH instead of HTTPS (git@github.com:user/project.git).

  NOTE: it's incompatible with setting theREPO variable. This setting will take precedence.

• BRANCH (default:master): you can use this setting if you want to change the default branch to bechecked out when cloning the repository. This might be useful for testing a Pull Request, or if you want touse a branch other thanmaster.

For example:

REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh

git clone https://github.com/ohmyzsh/ohmyzsh.git~/.oh-my-zsh

cp~/.zshrc~/.zshrc.orig

You can create a new zsh config file by copying the template that we have included for you.

cp~/.oh-my-zsh/templates/zshrc.zsh-template~/.zshrc

chsh -s$(which zsh)

You must log out from your user session and log back in to see this change.

Once you open up a new terminal window, it should load zsh with Oh My Zsh's configuration.

If you have any hiccups installing, here are a few common fixes.

• Youmight need to modify yourPATH in~/.zshrc if you're not able to find some commands afterswitching tooh-my-zsh.
• If you installed manually or changed the install location, check theZSH environment variable in~/.zshrc.

If you want to override any of the default behaviors, just add a new file (ending in.zsh) in thecustom/directory.

If you have many functions that go well together, you can put them as aXYZ.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 thesame name in thecustom/plugins/ directory and it will be loaded instead of the one inplugins/.

The default behaviour in Oh My Zsh is to use BSDls in macOS and FreeBSD systems. If GNUls is installed(asgls command), you can choose to use it instead. To do it, you can use zstyle-based config beforesourcingoh-my-zsh.sh:

zstyle':omz:lib:theme-and-appearance' gnu-ls yes

Note: this is not compatible withDISABLE_LS_COLORS=true

If you want to skip default Oh My Zsh aliases (those defined inlib/* files) or plugin aliases, you can usethe settings below in your~/.zshrc file,before Oh My Zsh is loaded. Note that there are many differentways to skip aliases, depending on your needs.

# Skip all aliases, in lib files and enabled pluginszstyle':omz:*' aliases no# Skip all aliases in lib fileszstyle':omz:lib:*' aliases no# Skip only aliases defined in the directories.zsh lib filezstyle':omz:lib:directories' aliases no# Skip all plugin aliaseszstyle':omz:plugins:*' aliases no# Skip only the aliases from the git pluginzstyle':omz:plugins:git' aliases no

You can combine these in other ways taking into account that more specific scopes take precedence:

# Skip all plugin aliases, except for the git pluginzstyle':omz:plugins:*' aliases nozstyle':omz:plugins:git' aliases yes

A previous version of this feature was using the setting below, which has been removed:

zstyle':omz:directories' aliases no

Instead, you can now use the following:

zstyle':omz:lib:directories' aliases no

This feature is currently in a testing phase and it may be subject to change in the future. It is also notcurrently compatible with plugin managers such as zpm or zinit, which don't source the init script(oh-my-zsh.sh) where this feature is implemented in.

It is also not currently aware of "aliases" that are defined as functions. Example of such aregccd,ggf, orggl functions from the git plugin.

Async prompt functions are an experimental feature (included on April 3, 2024) that allows Oh My Zsh to renderprompt information asynchronously. This can improve prompt rendering performance, but it might not work wellwith some setups. We hope that's not an issue, but if you're seeing problems with this new feature, you canturn it off by setting the following in your .zshrc file, before Oh My Zsh is sourced:

zstyle':omz:alpha:lib:git' async-prompt no

If your problem is that the git prompt just stopped appearing, you can try to force it setting the followingconfiguration beforeoh-my-zsh.sh is sourced. If it still does not work, please open an issue with yourcase.

zstyle':omz:alpha:lib:git' async-prompt force

By default, you will be prompted to check for updates every 2 weeks. You can choose other update modes byadding a line to your~/.zshrc file,before Oh My Zsh is loaded:

1. Automatic update without confirmation prompt:

   zstyle':omz:update' mode auto

2. Just offer a reminder every few days, if there are updates available:

   zstyle':omz:update' mode reminder

3. To disable automatic updates entirely:

   zstyle':omz:update' mode disabled

NOTE: you can control how often Oh My Zsh checks for updates with the following setting:

# This will check for updates every 7 dayszstyle':omz:update' frequency 7# This will check for updates every time you open the terminal (not recommended)zstyle':omz:update' frequency 0

You can also limit the update verbosity with the following settings:

zstyle':omz:update' verbose default# default update promptzstyle':omz:update' verbose minimal# only few lineszstyle':omz:update' verbose silent# only errors

If you'd like to update at any point in time (maybe someone just released a new plugin and you don't want towait a week?) you just need to run:

omz update

$ZSH/tools/upgrade.sh

Magic! 🎉

Oh My Zsh isn't for everyone. We'll miss you, but we want to make this an easy breakup.

If you want to uninstalloh-my-zsh, just rununinstall_oh_my_zsh from the command-line. It will removeitself and revert your previousbash orzsh configuration.

Before you participate in our delightful community, please read thecode of conduct.

I'm far from being aZsh expert and suspect there are many ways to improve – if youhave ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and sendpull requests!

We also need people to test out pull requests. So take a look throughthe open issues and help where you can.

SeeContributing for more details.

We have (more than) enough themes for the time being. Please add your theme to theexternal themes wiki page.

Oh My Zsh has a vibrant community of happy users and delightful contributors. Without all the time and helpfrom our contributors, it wouldn't be so awesome.

Thank you so much!

We're on social media:

• @ohmyzsh on X (formerly Twitter). You should follow it.
• Facebook poke us.
• Instagram tag us in your post showing Oh My Zsh!
• Discord to chat with us!

We havestickers, shirts, and coffee mugs availablefor you to show off your love of Oh My Zsh. Again, you will become the talk of the town!

Oh My Zsh is released under theMIT license.

Oh My Zsh was started by the team atPlanet Argon, aRuby on Rails development agency.Check out ourother open source projects.