Oh
Oh My Zsh is an open source, community-driven framework for managing your zsh configuration.
Sounds boring. Let's effort over again.
Oh My Zsh will not brand you a 10x programmer...but you may experience like 1.
In one case installed, your terminal shell volition become the talk of the boondocks or your money back! With each keystroke in your command prompt, you'll take reward of the hundreds of powerful plugins and beautiful themes. Strangers will come up upwards to yous in cafés and enquire you lot, "that is amazing! are you some sort of genius?"
Finally, you'll begin to go the sort of attention that you have ever felt yous deserved. ...or maybe you'll use the fourth dimension that y'all're saving to start flossing more often.
To acquire more, visit ohmyz.sh, follow @ohmyzsh on Twitter, and join us on Discord.
Table of Contents
- Getting Started
- Prerequisites
- Basic Installation
- Manual inspection
- Using Oh My Zsh
- Plugins
- Enabling Plugins
- Using Plugins
- Themes
- Selecting a Theme
- FAQ
- Plugins
- Advanced Topics
- Advanced Installation
- Custom Directory
- Unattended install
- Installing from a forked repository
- Manual Installation
- Installation Problems
- Custom Plugins and Themes
- Advanced Installation
- Getting Updates
- Manual Updates
- Uninstalling Oh My Zsh
- How practice I contribute to Oh My Zsh?
- Do NOT send united states of america themes
- Contributors
- Follow U.s.a.
- Merchandise
- License
- About Planet Argon
Getting Started
Prerequisites
- A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL2 is preferred, merely cygwin or msys besides more often than not work.
- Zsh should exist installed (v4.3.9 or more than recent is fine simply we prefer 5.0.8 and newer). If not pre-installed (run
zsh --versionto ostend), check the following wiki instructions hither: Installing ZSH -
coilorwgetshould be installed -
gitshould be installed (recommended v2.iv.11 or higher)
Basic Installation
Oh My Zsh is installed past running one of the following commands in your terminal. You tin install this via the command-line with either curlicue, wget or some other like 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)" |
Note that previous configuration in .zshrc volition be placed in .pre-oh-my-zsh. Later installation y'all tin can motion configuration y'all want to preserve into .zshrc.
Manual inspection
Information technology's a adept thought to audit the install script from projects you don't yet know. You can exercise that by downloading the install script first, looking through it and so everything looks normal, then running it:
wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh sh install.sh Using Oh My Zsh
Plugins
Oh My Zsh comes with a shitload of plugins for you to have reward of. You can have a await in the plugins directory and/or the wiki to see what's currently available.
Enabling Plugins
In one case 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 $Dwelling directory. Open up it with your favorite text editor and you'll see a spot to list all the plugins y'all want to load.
For example, this might begin to look like this:
plugins=( git bundler dotenv macos rake rbenv blood-red ) Annotation that the plugins are separated by whitespace (spaces, tabs, new lines...). Do non use commas betwixt them or information technology will break.
Using Plugins
Each plugin includes a README, documenting it. This README should testify the aliases (if the plugin adds whatever) and extra goodies that are included in that item plugin.
Themes
We'll acknowledge it. Early on in the Oh My Zsh world, we may take gotten a chip too theme happy. We have over 1 hundred and l themes now bundled. Well-nigh of them take screenshots on the wiki (Nosotros are working on updating this!). Cheque them out!
Selecting a Theme
Robby'southward theme is the default ane. It's not the fanciest one. Information technology's not the simplest one. It'due south 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 run across an environment variable (all caps) in there that looks like:
To use a dissimilar theme, simply change the value to friction match the name of your desired theme. For example:
ZSH_THEME= "agnoster" # (this is one of the fancy ones) # meet 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 concluding window and your prompt should await something like this:
In instance yous did non notice a suitable theme for your needs, delight have a await at the wiki for more than of them.
If you lot're feeling feisty, you can let the computer select one randomly for you each time y'all open up a new terminal window.
ZSH_THEME= "random" # (...please allow it exist pie... delight exist some pie..) And if you lot desire to pick random theme from a list of your favorite themes:
ZSH_THEME_RANDOM_CANDIDATES=( "robbyrussell" "agnoster" ) If you lot only know which themes you don't like, yous can add together them similarly to an ignored list:
ZSH_THEME_RANDOM_IGNORED=(pygmalion tjkirch_mod) FAQ
If y'all have some more than questions or bug, 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 desire 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 peak of the install script).
Custom Directory
The default location is ~/.oh-my-zsh (hidden in your home directory, you tin can access it with cd ~/.oh-my-zsh)
If yous'd like to modify the install directory with the ZSH environment variable, either by running export ZSH=/your/path before installing, or by setting it before the terminate of the install pipeline like this:
ZSH= " $HOME/.dotfiles/oh-my-zsh" sh install.sh Unattended install
If y'all're running the Oh My Zsh install script as part of an automated install, you tin laissez passer the flag --unattended to the install.sh script. This will take the effect of not trying to modify the default shell, and also won't run zsh when the installation has finished.
sh -c " $(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh) " " " --unattended Installing from a forked repository
The install script likewise accepts these variables to let installation of a different repository:
-
REPO(default:ohmyzsh/ohmyzsh): this takes the class ofpossessor/repository. If you gear up this variable, the installer will look for a repository athttps://github.com/{owner}/{repository}. -
REMOTE(default:https://github.com/${REPO}.git): this is the total URL of the git repository clone. Y'all can employ this setting if you want to install from a fork that is not on GitHub (GitLab, Bitbucket...) or if you want to clone with SSH instead of HTTPS (git@github.com:user/project.git).Annotation: information technology's incompatible with setting the
REPOvariable. This setting volition take precedence. -
BRANCH(default:master): you can use this setting if you want to change the default co-operative to be checked out when cloning the repository. This might be useful for testing a Pull Request, or if you want to apply a branch other thanmaster.
For example:
REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh Manual Installation
i. Clone the repository
git clone https://github.com/ohmyzsh/ohmyzsh.git ~/.oh-my-zsh 2. Optionally, backup your existing ~/.zshrc file
cp ~/.zshrc ~/.zshrc.orig 3. Create a new zsh configuration file
You lot can create a new zsh config file by copying the template that nosotros have included for you.
cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc 4. Change your default beat out
You must log out from your user session and log back in to see this change.
5. Initialize your new zsh configuration
Once y'all open upward a new terminal window, it should load zsh with Oh My Zsh's configuration.
Installation Problems
If you have whatever hiccups installing, here are a few common fixes.
- You lot might need to modify your
PATHin~/.zshrcif you're not able to find some commands later switching tooh-my-zsh. - If yous installed manually or changed the install location, check the
ZSHenvirons variable in~/.zshrc.
Custom Plugins and Themes
If you lot want to override whatsoever of the default behaviors, just add together a new file (ending in .zsh) in the custom/ directory.
If you take many functions that go well together, you can put them as a XYZ.plugin.zsh file in the custom/plugins/ directory and and so enable this plugin.
If you would similar 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 exist loaded instead of the one in plugins/.
Getting Updates
By default, you will be prompted to check for updates every 2 weeks. You can choose other update modes by calculation a line to your ~/.zshrc file, before Oh My Zsh is loaded:
-
Automatic update without confirmation prompt:
zstyle ':omz:update' mode auto -
But offer a reminder every few days, if in that location are updates available:
zstyle ':omz:update' manner reminder -
To disable automatic updates entirely:
zstyle ':omz:update' mode disabled
Annotation: you can control how frequently Oh My Zsh checks for updates with the following setting:
# This will check for updates every 7 days zstyle ':omz:update' frequency vii # This will bank check for updates every time you open up the terminal (non recommended) zstyle ':omz:update' frequency 0 Manual Updates
If you'd similar to update at any signal in time (maybe someone just released a new plugin and you lot don't want to wait a week?) you just demand to run:
Magic!
Uninstalling Oh My Zsh
Oh My Zsh isn't for anybody. We'll miss you, merely nosotros want to make this an like shooting fish in a barrel breakup.
If you want to uninstall oh-my-zsh, only run uninstall_oh_my_zsh from the command-line. Information technology will remove itself and revert your previous bash or zsh configuration.
How do I contribute to Oh My Zsh?
Before you lot participate in our delightful community, delight read the code of conduct.
I'm far from beingness a Zsh skilful and suspect in that location are many means 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!
Nosotros also need people to exam out pull-requests. And so take a look through the open issues and help where yous can.
See Contributing for more details.
Do NOT send us themes
We have (more than than) enough themes for the fourth dimension existence. Please add your theme to the external themes wiki folio.
Contributors
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 crawly.
Thank you lot so much!
Follow Us
We're on social media:
- @ohmyzsh on Twitter. You lot should follow information technology.
- Facebook poke us.
- Instagram tag usa in your post showing Oh My Zsh!
- Discord to chat with usa!
Merchandise
Nosotros have stickers, shirts, and coffee mugs bachelor for you lot to show off your love of Oh My Zsh. Again, you volition become the talk of the town!
License
Oh My Zsh is released under the MIT license.
About Planet Argon
Oh My Zsh was started by the team at Planet Argon, a Ruby on Rails development agency. Cheque out our other open up source projects.
westmorelandropened.blogspot.com
Source: https://github.com/ohmyzsh/ohmyzsh
0 Response to "Oh"
Post a Comment