README.md 11.6 KB
Newer Older
Marc Cornellà's avatar
Marc Cornellà committed
1
2
3
<p align="center">
  <img src="https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png" alt="Oh My Zsh">
</p>
4

5
Oh My Zsh is an open source, community-driven framework for managing your [zsh](https://www.zsh.org/) configuration.
6

Robby Russell's avatar
Robby Russell committed
7
Sounds boring. Let's try again.
Robby Russell's avatar
Robby Russell committed
8

Robby Russell's avatar
Robby Russell committed
9
__Oh My Zsh will not make you a 10x developer...but you may feel like one.__
Robby Russell's avatar
Robby Russell committed
10
11
12

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?"_

13
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. 😬
14

Robby Russell's avatar
Robby Russell committed
15
16
17
18
To learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter, and/or join us on Discord.

[![Follow @ohmyzsh](https://img.shields.io/twitter/follow/ohmyzsh?label=Follow+@ohmyzsh&style=flat)](https://twitter.com/intent/follow?screen_name=ohmyzsh)
[![Discord server](https://img.shields.io/discord/642496866407284746)](https://discord.gg/bpXWhnN)
19
20
21

## Getting Started

Robby Russell's avatar
Robby Russell committed
22
### Prerequisites
23

24
* A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL is preferred, but cygwin or msys also mostly work.
25
* [Zsh](https://www.zsh.org) 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](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH)
26
* `curl` or `wget` should be installed
Kevin Ndung'u's avatar
Kevin Ndung'u committed
27
* `git` should be installed
28
29
30

### Basic Installation

31
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`.
32
33
34

#### via curl

35
```shell
36
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
37
```
38
39
40

#### via wget

41
```shell
42
sh -c "$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
43
44
45
46
47
48
49
50
51
```

#### 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:

```shell
52
curl -Lo install.sh https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh
53
sh install.sh
54
```
55
56
57
58
59

## Using Oh My Zsh

### Plugins

60
Oh My Zsh comes with a shitload of plugins 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.
61
62
63

#### Enabling Plugins

64
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.
65

66
67
68
69
70
```shell
vi ~/.zshrc
```

For example, this might begin to look like this:
71

Qix's avatar
Qix committed
72
```shell
73
74
75
76
77
78
79
80
81
plugins=(
  git
  bundler
  dotenv
  osx
  rake
  rbenv
  ruby
)
Qix's avatar
Qix committed
82
```
83

84
85
_Note that the plugins are separated by whitespace. **Do not** use commas between them._

86
87
88
89
90
91
#### Using Plugins

Most plugins (should! we're working on this) include a __README__, which documents how to use them.

### Themes

92
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](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes) on the wiki. Check them out!
93
94
95

#### Selecting a Theme

96
_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)._
97

98
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:
99

Qix's avatar
Qix committed
100
101
102
```shell
ZSH_THEME="robbyrussell"
```
103

G. Kay Lee's avatar
G. Kay Lee committed
104
To use a different theme, simply change the value to match the name of your desired theme. For example:
105

Qix's avatar
Qix committed
106
107
```shell
ZSH_THEME="agnoster" # (this is one of the fancy ones)
108
# see https://github.com/ohmyzsh/ohmyzsh/wiki/Themes#agnoster
Qix's avatar
Qix committed
109
```
110

111
112
_Note: many themes require installing the [Powerline Fonts](https://github.com/powerline/fonts) in order to render properly._

113
Open up a new terminal window and your prompt should look something like this:
114

Qix's avatar
Qix committed
115
116
![Agnoster theme](https://cloud.githubusercontent.com/assets/2618447/6316862/70f58fb6-ba03-11e4-82c9-c083bf9a6574.png)

117
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).
118

119
120
121
122
123
124
125
If you're feeling feisty, you can let the computer select one randomly for you each time you open a new terminal window.


```shell
ZSH_THEME="random" # (...please let it be pie... please be some pie..)
```

LE Manh Cuong's avatar
LE Manh Cuong committed
126
127
128
And if you want to pick random theme from a list of your favorite themes:

```shell
129
ZSH_THEME_RANDOM_CANDIDATES=(
LE Manh Cuong's avatar
LE Manh Cuong committed
130
131
132
133
  "robbyrussell"
  "agnoster"
)
```
134

135
136
137
138
### FAQ

If you have some more questions or issues, you might find a solution in our [FAQ](https://github.com/ohmyzsh/ohmyzsh/wiki/FAQ).

139
140
## Advanced Topics

Qix's avatar
Qix committed
141
If you're the type that likes to get their hands dirty, these sections might resonate.
142
143
144

### Advanced Installation

145
146
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).
147
148
149
150
151

#### Custom Directory

The default location is `~/.oh-my-zsh` (hidden in your home directory)

152
153
154
155
156
157
158
159
160
161
162
163
164
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 of the install pipeline
like this:

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

#### Unattended install

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

Qix's avatar
Qix committed
166
```shell
167
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattended
168
169
170
171
172
173
```

#### Installing from a forked repository

The install script also accepts these variables to allow installation of a different repository:

174
- `REPO` (default: `ohmyzsh/ohmyzsh`): this takes the form of `owner/repository`. If you set
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
  this variable, the installer will look for a repository at `https://github.com/{owner}/{repository}`.

- `REMOTE` (default: `https://github.com/${REPO}.git`): this is the full URL of the git repository
  clone. You can use 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`).

  _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
  checked out when cloning the repository. This might be useful for testing a Pull Request, or if you
  want to use a branch other than `master`.

For example:

```shell
REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh
Qix's avatar
Qix committed
191
```
192
193
194
195
196

#### Manual Installation

##### 1. Clone the repository:

Qix's avatar
Qix committed
197
```shell
198
git clone https://github.com/ohmyzsh/ohmyzsh.git ~/.oh-my-zsh
Qix's avatar
Qix committed
199
```
200

Qix's avatar
Qix committed
201
##### 2. *Optionally*, backup your existing `~/.zshrc` file:
202

Qix's avatar
Qix committed
203
204
205
```shell
cp ~/.zshrc ~/.zshrc.orig
```
206
207
208

##### 3. Create a new zsh configuration file

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

Qix's avatar
Qix committed
211
212
213
```shell
cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc
```
214
215
216

##### 4. Change your default shell

Qix's avatar
Qix committed
217
```shell
218
chsh -s $(which zsh)
Qix's avatar
Qix committed
219
```
220
221

You must log out from your user session and log back in to see this change.
222
223
224
225
226
227
228
229
230

##### 5. Initialize your new zsh configuration

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.

231
232
233
234
* You _might_ need to modify your `PATH` in `~/.zshrc` if you're not able to find some commands after
switching to `oh-my-zsh`.
* If you installed manually or changed the install location, check the `ZSH` environment variable in
`~/.zshrc`.
235
236
237
238
239

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

Qix's avatar
Qix committed
240
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.
241
242
243
244
245
246
247

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/`.

## Getting Updates

By default, you will be prompted to check for upgrades every few weeks. If you would like `oh-my-zsh` to automatically upgrade itself without prompting you, set the following in your `~/.zshrc`:

Qix's avatar
Qix committed
248
249
250
```shell
DISABLE_UPDATE_PROMPT=true
```
251
252
253

To disable automatic upgrades, set the following in your `~/.zshrc`:

Qix's avatar
Qix committed
254
255
256
```shell
DISABLE_AUTO_UPDATE=true
```
257
258
259

### Manual Updates

Qix's avatar
Qix committed
260
If you'd like to upgrade 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:
261

Qix's avatar
Qix committed
262
263
264
```shell
upgrade_oh_my_zsh
```
265

266
Magic! 🎉
267
268
269
270
271
272
273

## Uninstalling Oh My Zsh

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

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.

274
275
276
## How do I contribute to Oh My Zsh?

Before you participate in our delightful community, please read the [code of conduct](CODE_OF_CONDUCT.md).
277

278
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!
279

280
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.
281

282
283
See [Contributing](CONTRIBUTING.md) for more details.

Qix's avatar
Qix committed
284
### Do NOT send us themes
285

286
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.
287
288
289
290
291
292
293
294
295

## 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 awesome.

Thank you so much!

## Follow Us

296
We're on the social media.
Robby Russell's avatar
Robby Russell committed
297
298
299

* [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter. You should follow it.
* [Oh My Zsh](https://www.facebook.com/Oh-My-Zsh-296616263819290/) on Facebook.
300
301
302

## Merchandise

303
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!
304

Qix's avatar
Qix committed
305
## License
306

307
Oh My Zsh is released under the [MIT license](LICENSE.txt).
308
309
310

## About Planet Argon

311
![Planet Argon](https://pa-github-assets.s3.amazonaws.com/PARGON_logo_digital_COL-small.jpg)
312

313
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).