mj / zsh-config

Download as
Browse Code ยป

Commit ffad68b978d443190535c8fd63c06d681eb90503

Authored by Adam Stankiewicz
Committed by Shrikant Sharat
1 parent 260f1270b9

Suggest tabbing contents of heredoc 

Conflicts:
	README.mkd

Showing 1 changed file with 4 additions and 5 deletions Inline Diff

1 # Antigen <sup>&beta;</sup> 1 # Antigen <sup>&beta;</sup>
2 2
3 [![Build Status](https://secure.travis-ci.org/zsh-users/antigen.png)](http://travis-ci.org/zsh-users/antigen) 3 [![Build Status](https://secure.travis-ci.org/zsh-users/antigen.png)](http://travis-ci.org/zsh-users/antigen)
4 4
5 Antigen is a small set of functions that help you easily manage your shell (zsh) 5 Antigen is a small set of functions that help you easily manage your shell (zsh)
6 plugins, called bundles. The concept is pretty much the same as bundles in a 6 plugins, called bundles. The concept is pretty much the same as bundles in a
7 typical vim+pathogen setup. Antigen is to zsh, what [Vundle][] is to vim. 7 typical vim+pathogen setup. Antigen is to zsh, what [Vundle][] is to vim.
8 8
9 Please note that this is a very new project and can be considered beta at best. 9 Please note that this is a very new project and can be considered beta at best.
10 That said, I am using antigen full time now on my work machine. 10 That said, I am using antigen full time now on my work machine.
11 11
12 Note: Please read the commit comments of the changesets when you pull a new 12 Note: Please read the commit comments of the changesets when you pull a new
13 version of antigen. 13 version of antigen.
14 14
15 ## Show off 15 ## Show off
16 16
17 > Enough talk. Let's fight! 17 > Enough talk. Let's fight!
18 > -- Po, Kung-fu Panda. 18 > -- Po, Kung-fu Panda.
19 19
20 You're going to experience antigen right in your open shell. No `.zshrc` 20 You're going to experience antigen right in your open shell. No `.zshrc`
21 tweaking and reading the rest of this documentation. Kinda like an ice-cream 21 tweaking and reading the rest of this documentation. Kinda like an ice-cream
22 sample, if you will. 22 sample, if you will.
23 23
24 Get and load antigen. 24 Get and load antigen.
25 25
26 curl https://raw.github.com/zsh-users/antigen/master/antigen.zsh > antigen.zsh 26 curl https://raw.github.com/zsh-users/antigen/master/antigen.zsh > antigen.zsh
27 source antigen.zsh 27 source antigen.zsh
28 28
29 There. You now have all the antigen goodies. Let's try install some plugins. How 29 There. You now have all the antigen goodies. Let's try install some plugins. How
30 about some color to start with. Get the [syntax highlighting plugin][] by 30 about some color to start with. Get the [syntax highlighting plugin][] by
31 running 31 running
32 32
33 antigen-bundle zsh-users/zsh-syntax-highlighting 33 antigen-bundle zsh-users/zsh-syntax-highlighting
34 34
35 Now let it do its thing and once you're back at your prompt, try and type a 35 Now let it do its thing and once you're back at your prompt, try and type a
36 command. See that? Colors! 36 command. See that? Colors!
37 37
38 So, you do git? ruby? git and ruby? There are lots of awesome plugins over at 38 So, you do git? ruby? git and ruby? There are lots of awesome plugins over at
39 oh-my-zsh. Treat yourself to some. 39 oh-my-zsh. Treat yourself to some.
40 40
41 antigen-bundle robbyrussell/oh-my-zsh plugins/ruby 41 antigen-bundle robbyrussell/oh-my-zsh plugins/ruby
42 # Or for the lazy, 42 # Or for the lazy,
43 antigen-bundle git 43 antigen-bundle git
44 44
45 There are lots of plugins out there in the wild and people are writing zsh 45 There are lots of plugins out there in the wild and people are writing zsh
46 utilities as small scripts all the time. Antigen is compatible with all of them. 46 utilities as small scripts all the time. Antigen is compatible with all of them.
47 The plugins and scripts don't need any special handling to be compatible with 47 The plugins and scripts don't need any special handling to be compatible with
48 antigen. 48 antigen.
49 49
50 Another example, [kennethreitz's autoenv][autoenv] (or [my fork][f-autoenv] of 50 Another example, [kennethreitz's autoenv][autoenv] (or [my fork][f-autoenv] of
51 it). Just a bundle command away. 51 it). Just a bundle command away.
52 52
53 antigen-bundle sharat87/autoenv 53 antigen-bundle sharat87/autoenv
54 54
55 And boom! you have all the autoenv goodness. Just remember how you used to do 55 And boom! you have all the autoenv goodness. Just remember how you used to do
56 these before antigen, clone it, modify your zshrc to source it, load a new 56 these before antigen, clone it, modify your zshrc to source it, load a new
57 terminal, all just to test it out. Duh! 57 terminal, all just to test it out. Duh!
58 58
59 A subtle aspect of this is that you can tell antigen to grab just about anything 59 A subtle aspect of this is that you can tell antigen to grab just about anything
60 from anyone's `dotfiles` repo, as long as it is in a directory under any repo on 60 from anyone's `dotfiles` repo, as long as it is in a directory under any repo on
61 github. 61 github.
62 62
63 And themes? How would you like a fancy new prompt for yourself? 63 And themes? How would you like a fancy new prompt for yourself?
64 64
65 antigen-theme funky 65 antigen-theme funky
66 66
67 No? Not your taste? There are many themes available to you, check out the 67 No? Not your taste? There are many themes available to you, check out the
68 oh-my-zsh's [page on themes][]. 68 oh-my-zsh's [page on themes][].
69 69
70 You can install themes from unofficial repos too! 70 You can install themes from unofficial repos too!
71 71
72 antigen-theme XsErG/zsh-themes themes/lazyuser 72 antigen-theme XsErG/zsh-themes themes/lazyuser
73 73
74 See? It's easy! To see how that works, refer to the section on the 74 See? It's easy! To see how that works, refer to the section on the
75 `antigen-theme` command further down. 75 `antigen-theme` command further down.
76 76
77 Note: Many of those plugins and especially themes, assume you have the core 77 Note: Many of those plugins and especially themes, assume you have the core
78 library of oh-my-zsh loaded. So, if you want to experiment further, issue a 78 library of oh-my-zsh loaded. So, if you want to experiment further, issue a
79 79
80 antigen-use oh-my-zsh 80 antigen-use oh-my-zsh
81 81
82 and continue until you're tired. At which point you can come back to this page 82 and continue until you're tired. At which point you can come back to this page
83 ;) 83 ;)
84 84
85 ## Usage 85 ## Usage
86 86
87 So, now that you're here, I suppose you are convinced and want antigen running 87 So, now that you're here, I suppose you are convinced and want antigen running
88 your shell all the time. Sweet. Let's do it. 88 your shell all the time. Sweet. Let's do it.
89 89
90 First, clone this repo, probably as a submodule if you have your dotfiles in a 90 First, clone this repo, probably as a submodule if you have your dotfiles in a
91 git repo, 91 git repo,
92 92
93 git clone https://github.com/zsh-users/antigen.git 93 git clone https://github.com/zsh-users/antigen.git
94 94
95 The usage should be very familiar to you if you use Vundle. A typical `.zshrc` 95 The usage should be very familiar to you if you use Vundle. A typical `.zshrc`
96 might look like this 96 might look like this
97 97
98 source /path-to-antigen-clone/antigen.zsh 98 source /path-to-antigen-clone/antigen.zsh
99 99
100 # Load the oh-my-zsh's library. 100 # Load the oh-my-zsh's library.
101 antigen-use oh-my-zsh 101 antigen-use oh-my-zsh
102 102
103 # Bundles from the default repo (robbyrussell's oh-my-zsh). 103 # Bundles from the default repo (robbyrussell's oh-my-zsh).
104 antigen-bundle git 104 antigen-bundle git
105 antigen-bundle heroku 105 antigen-bundle heroku
106 antigen-bundle pip 106 antigen-bundle pip
107 antigen-bundle lein 107 antigen-bundle lein
108 antigen-bundle command-not-found 108 antigen-bundle command-not-found
109 109
110 # Syntax highlighting bundle. 110 # Syntax highlighting bundle.
111 antigen-bundle zsh-users/zsh-syntax-highlighting 111 antigen-bundle zsh-users/zsh-syntax-highlighting
112 112
113 # Load the theme. 113 # Load the theme.
114 antigen-theme robbyrussell 114 antigen-theme robbyrussell
115 115
116 # Tell antigen that you're done. 116 # Tell antigen that you're done.
117 antigen-apply 117 antigen-apply
118 118
119 Open your zsh with this zshrc and you should see all the bundles you defined 119 Open your zsh with this zshrc and you should see all the bundles you defined
120 here, getting installed. Once its done, you are ready to roll. The complete 120 here, getting installed. Once its done, you are ready to roll. The complete
121 syntax for the `antigen-bundle` command is discussed further down on this page. 121 syntax for the `antigen-bundle` command is discussed further down on this page.
122 122
123 You can find more examples in the wiki: [Antigen in the wild][wild]. 123 You can find more examples in the wiki: [Antigen in the wild][wild].
124 124
125 ## Motivation 125 ## Motivation
126 126
127 If you use zsh and [oh-my-zsh][], you know that having many different plugins 127 If you use zsh and [oh-my-zsh][], you know that having many different plugins
128 that are developed by many different authors in a single (sub)repo is not very 128 that are developed by many different authors in a single (sub)repo is not very
129 easy to maintain. There are some really fantastic plugins and utilities in 129 easy to maintain. There are some really fantastic plugins and utilities in
130 oh-my-zsh, but having them all in a single repo doesn't really scale well. And I 130 oh-my-zsh, but having them all in a single repo doesn't really scale well. And I
131 admire robbyrussell's efforts for reviewing and merging the gigantic number of 131 admire robbyrussell's efforts for reviewing and merging the gigantic number of
132 pull requests the project gets. We need a better way of plugin management. 132 pull requests the project gets. We need a better way of plugin management.
133 133
134 This was discussed on [a][1] [few][2] [issues][3], but it doesn't look like 134 This was discussed on [a][1] [few][2] [issues][3], but it doesn't look like
135 there was any progress made. So, I'm trying to start this off with antigen, 135 there was any progress made. So, I'm trying to start this off with antigen,
136 hoping to better this situation. Please note that I'm by no means a zsh or any 136 hoping to better this situation. Please note that I'm by no means a zsh or any
137 shell script expert (far from it). 137 shell script expert (far from it).
138 138
139 [1]: https://github.com/robbyrussell/oh-my-zsh/issues/465 139 [1]: https://github.com/robbyrussell/oh-my-zsh/issues/465
140 [2]: https://github.com/robbyrussell/oh-my-zsh/issues/377 140 [2]: https://github.com/robbyrussell/oh-my-zsh/issues/377
141 [3]: https://github.com/robbyrussell/oh-my-zsh/issues/1014 141 [3]: https://github.com/robbyrussell/oh-my-zsh/issues/1014
142 142
143 Inspired by vundle, antigen can pull oh-my-zsh style plugins from various github 143 Inspired by vundle, antigen can pull oh-my-zsh style plugins from various github
144 repositories. You are not limited to use plugins from the oh-my-zsh repository 144 repositories. You are not limited to use plugins from the oh-my-zsh repository
145 only and you don't need to maintain your own fork and pull from upstream every 145 only and you don't need to maintain your own fork and pull from upstream every
146 now and then. I actually encourage you to grab plugins and scripts from various 146 now and then. I actually encourage you to grab plugins and scripts from various
147 sources, straight from the authors, before they even submit it to oh-my-zsh as a 147 sources, straight from the authors, before they even submit it to oh-my-zsh as a
148 pull request. 148 pull request.
149 149
150 Antigen also lets you switch the prompt theme with one command, just like that 150 Antigen also lets you switch the prompt theme with one command, just like that
151 151
152 antigen-theme candy 152 antigen-theme candy
153 153
154 and your prompt is changed, just for this session of course (unless you put this 154 and your prompt is changed, just for this session of course (unless you put this
155 line in your `.zshrc`). 155 line in your `.zshrc`).
156 156
157 ## Commands 157 ## Commands
158 158
159 The following are the commands provided by antigen. Note that the `-` in the 159 The following are the commands provided by antigen. Note that the `-` in the
160 following commands can be replaced with a space. You can write `antigen-bundle 160 following commands can be replaced with a space. You can write `antigen-bundle
161 ...` as `antigen bundle ...` and get away with it. For more details see the help 161 ...` as `antigen bundle ...` and get away with it. For more details see the help
162 on `antigen` command further down in this section. 162 on `antigen` command further down in this section.
163 163
164 ### antigen-bundle 164 ### antigen-bundle
165 165
166 This command tells antigen to install (if not already installed) and load the 166 This command tells antigen to install (if not already installed) and load the
167 given plugin. The simplest usage follows the following syntax. 167 given plugin. The simplest usage follows the following syntax.
168 168
169 antigen-bundle <plugin-name> 169 antigen-bundle <plugin-name>
170 170
171 This will install and load the `plugins/<name>` directory from [robbyrussell's 171 This will install and load the `plugins/<name>` directory from [robbyrussell's
172 oh-my-zsh][oh-my-zsh] (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`). 172 oh-my-zsh][oh-my-zsh] (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`).
173 173
174 However, the above is just syntax sugar for the extended syntax of the 174 However, the above is just syntax sugar for the extended syntax of the
175 `antigen-bundle` command. 175 `antigen-bundle` command.
176 176
177 antigen-bundle [<url> [<loc>]] 177 antigen-bundle [<url> [<loc>]]
178 178
179 where `<url>` is the repository url and it defaults to [robbyrussell's 179 where `<url>` is the repository url and it defaults to [robbyrussell's
180 oh-my-zsh][oh-my-zsh] repo (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL` 180 oh-my-zsh][oh-my-zsh] repo (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`
181 discussed further down). `<loc>` is the path under this repository which has the 181 discussed further down). `<loc>` is the path under this repository which has the
182 zsh plugin. This is typically the directory that contains a `*.plugin.zsh` file, 182 zsh plugin. This is typically the directory that contains a `*.plugin.zsh` file,
183 but it could contain a completion file or just many `*.zsh` files to be sourced. 183 but it could contain a completion file or just many `*.zsh` files to be sourced.
184 `<loc>` defaults to `/`, which indicates the repository itself is a plugin. 184 `<loc>` defaults to `/`, which indicates the repository itself is a plugin.
185 185
186 An example invocation would be 186 An example invocation would be
187 187
188 # The following is the same as `antigen-bundle ant`. But for demonstration 188 # The following is the same as `antigen-bundle ant`. But for demonstration
189 # purposes, we use the extended syntax here. 189 # purposes, we use the extended syntax here.
190 antigen-bundle https://github.com/robbyrussell/oh-my-zsh.git plugins/ant 190 antigen-bundle https://github.com/robbyrussell/oh-my-zsh.git plugins/ant
191 191
192 This would install the ant plugin from robbyrussell's oh-my-zsh repo. Of course, 192 This would install the ant plugin from robbyrussell's oh-my-zsh repo. Of course,
193 github url's can be shortened. 193 github url's can be shortened.
194 194
195 antigen-bundle robbyrussell/oh-my-zsh plugins/ant 195 antigen-bundle robbyrussell/oh-my-zsh plugins/ant
196 196
197 And since this repo is the default, even that isn't necessary. But we can't 197 And since this repo is the default, even that isn't necessary. But we can't
198 specify the `loc` without giving the first argument. 198 specify the `loc` without giving the first argument.
199 199
200 For this and a few other reasons, `antigen-bundle` also supports a simple 200 For this and a few other reasons, `antigen-bundle` also supports a simple
201 keyword argument syntax, using which we can rewrite the above as 201 keyword argument syntax, using which we can rewrite the above as
202 202
203 antigen-bundle --loc=plugins/ant 203 antigen-bundle --loc=plugins/ant
204 204
205 Which picks up the default for the `url` argument, and uses the `loc` given to 205 Which picks up the default for the `url` argument, and uses the `loc` given to
206 it. 206 it.
207 207
208 *Note* that you can mix and match positional and keyword arguments. But you 208 *Note* that you can mix and match positional and keyword arguments. But you
209 can't have positional arguments after keyword arguments. 209 can't have positional arguments after keyword arguments.
210 210
211 antigen-bundle robbyrussell/oh-my-zsh --loc=plugins/ant 211 antigen-bundle robbyrussell/oh-my-zsh --loc=plugins/ant
212 212
213 And keyword arguments don't care about the order in which the arguments are 213 And keyword arguments don't care about the order in which the arguments are
214 specified. The following is perfectly valid. 214 specified. The following is perfectly valid.
215 215
216 antigen-bundle --loc=plugins/ant --url=robbyrussell/oh-my-zsh 216 antigen-bundle --loc=plugins/ant --url=robbyrussell/oh-my-zsh
217 217
218 You can also specify a local directory on your file system as a bundle. In this 218 You can also specify a local directory on your file system as a bundle. In this
219 case, make sure the path you give is the absolute path (i.e., starts with a 219 case, make sure the path you give is the absolute path (i.e., starts with a
220 `/`). Relative paths are not supported. If the repo you gave is a local 220 `/`). Relative paths are not supported. If the repo you gave is a local
221 directory path, then it is not necessary that this path is a git repo. Please 221 directory path, then it is not necessary that this path is a git repo. Please
222 refer to the notes on `--no-local-clone` below. 222 refer to the notes on `--no-local-clone` below.
223 223
224 This command can also be used from your shell environment. This allows you to 224 This command can also be used from your shell environment. This allows you to
225 install plugins on the fly and try them out. Of course if you want a bundle to 225 install plugins on the fly and try them out. Of course if you want a bundle to
226 be available every time you open a shell, put it in your `.zshrc`. 226 be available every time you open a shell, put it in your `.zshrc`.
227 227
228 Other keyword-only arguments accepted: 228 Other keyword-only arguments accepted:
229 229
230 `--branch={git-branch-name}` &mdash; Specify the branch of the git repo to be 230 `--branch={git-branch-name}` &mdash; Specify the branch of the git repo to be
231 used for this bundle (without the braces of course). The default is whatever 231 used for this bundle (without the braces of course). The default is whatever
232 branch the clone comes with, which is usually `master`. For example, 232 branch the clone comes with, which is usually `master`. For example,
233 233
234 antigen-bundle github-user/repo --branch=develop 234 antigen-bundle github-user/repo --branch=develop
235 235
236 This will get the plugin as in the branch `develop`. 236 This will get the plugin as in the branch `develop`.
237 237
238 Note that if you specify two plugins to be loaded from the same git repo, but 238 Note that if you specify two plugins to be loaded from the same git repo, but
239 different branches, then two separate clones of this repo will be maintained. 239 different branches, then two separate clones of this repo will be maintained.
240 This is a small implementation detail and shouldn't influence you in any way. 240 This is a small implementation detail and shouldn't influence you in any way.
241 241
242 `--no-local-clone` &mdash; This command can be useful if you are developing a 242 `--no-local-clone` &mdash; This command can be useful if you are developing a
243 plugin and already have a clone on your local file system. If this argument is 243 plugin and already have a clone on your local file system. If this argument is
244 not given, even if the given repo url is a local path, a clone is made in the 244 not given, even if the given repo url is a local path, a clone is made in the
245 `$ADOTDIR/repos`, and the plugin is loaded from that clone. But, if you give 245 `$ADOTDIR/repos`, and the plugin is loaded from that clone. But, if you give
246 this argument, the plugin is sourced straight from the repo location, without 246 this argument, the plugin is sourced straight from the repo location, without
247 creating a clone. For example, 247 creating a clone. For example,
248 248
249 antigen-bundle /absolute/path/to/the/plugin --no-local-clone 249 antigen-bundle /absolute/path/to/the/plugin --no-local-clone
250 250
251 Note that if the repo url is *not* an absolute local path or a branch has been 251 Note that if the repo url is *not* an absolute local path or a branch has been
252 specified with the `--branch` option, this argument has no effect. That is, 252 specified with the `--branch` option, this argument has no effect. That is,
253 for this option to have any affect, the repo url must be an absolute local path 253 for this option to have any affect, the repo url must be an absolute local path
254 and no `--branch` should be specified. 254 and no `--branch` should be specified.
255 255
256 Also, if the local path given as the url is not a git repo, then this 256 Also, if the local path given as the url is not a git repo, then this
257 argument is forced as it doesn't makes sense to *clone* something that's not a 257 argument is forced as it doesn't makes sense to *clone* something that's not a
258 git repo. This property can be used to load any utility scripts you have in your 258 git repo. This property can be used to load any utility scripts you have in your
259 dotfiles repo. For example, 259 dotfiles repo. For example,
260 260
261 antigen-bundle $HOME/dotfiles/oh-my-zsh/custom 261 antigen-bundle $HOME/dotfiles/oh-my-zsh/custom
262 262
263 In addition to the above discussed arguments, `antigen-bundle` also takes a 263 In addition to the above discussed arguments, `antigen-bundle` also takes a
264 `btype` keyword-only argument, that is used internally. You shouldn't be 264 `btype` keyword-only argument, that is used internally. You shouldn't be
265 concerned with this argument, its only used internally and will probably go away 265 concerned with this argument, its only used internally and will probably go away
266 in the future. It indicates whether the bundle is a theme or a simple plugin. 266 in the future. It indicates whether the bundle is a theme or a simple plugin.
267 267
268 ### antigen-bundles 268 ### antigen-bundles
269 269
270 If you have a fair number of bundles, using the `antigen-bundle` command can 270 If you have a fair number of bundles, using the `antigen-bundle` command can
271 look cumbersome. You can use the `antigen-bundles` command to *bulk* define 271 look cumbersome. You can use the `antigen-bundles` command to *bulk* define
272 bundles instead of individual calls to `antigen-bundle`. 272 bundles instead of individual calls to `antigen-bundle`.
273 273
274 Usage is pretty straightforward. Just pipe the bundle specifications, just as 274 Usage is pretty straightforward. Just pipe the bundle specifications, just as
275 you would give to the `antigen-bundle` command, one per line, into the 275 you would give to the `antigen-bundle` command, one per line, into the
276 `antigen-bundles` command. The easiest way to do this, is using the heredoc 276 `antigen-bundles` command. The easiest way to do this, is using the heredoc
277 syntax. 277 syntax.
278 278
279 antigen-bundles <<EOBUNDLES 279 antigen-bundles <<EOBUNDLES
280 # Guess what to install when running an unknown command. 280 # Guess what to install when running an unknown command.
281 command-not-found 281 command-not-found
282
283 # The heroku tool helper plugin.
284 heroku
285 282
283 # The heroku tool helper plugin.
284 heroku
286 EOBUNDLES 285 EOBUNDLES
287 286
288 This is equivalent to 287 This is equivalent to
289 288
290 antigen-bundle command-not-found 289 antigen-bundle command-not-found
291 antigen-bundle heroku 290 antigen-bundle heroku
292 291
293 Of course, as you can see, from the lines piped to `antigen-bundles`, empty 292 Of course, as you can see, from the lines piped to `antigen-bundles`, empty
294 lines and those starting with a `#` are ignored. The rest are passed to 293 lines and those starting with a `#` are ignored. The rest are passed to
295 `antigen-bundle` without any quoting rules applied. They are actually `eval`-ed 294 `antigen-bundle` without any quoting rules applied. They are actually `eval`-ed
296 with the `antigen-bundle` command. See the source if you want to really 295 with the `antigen-bundle` command. See the source if you want to really
297 understand how it works. Its a very small function. 296 understand how it works. Its a very small function.
298 297
299 ### antigen-update 298 ### antigen-update
300 299
301 This is something you might not want to put in your `.zshrc`. Instead, run it 300 This is something you might not want to put in your `.zshrc`. Instead, run it
302 occasionally to update all your plugins. It doesn't take any arguments. 301 occasionally to update all your plugins. It doesn't take any arguments.
303 302
304 antigen-update 303 antigen-update
305 304
306 Please note that the updates that are downloaded are not immediately available. 305 Please note that the updates that are downloaded are not immediately available.
307 You have to open a new shell to be able to see the changes. This is a limitation 306 You have to open a new shell to be able to see the changes. This is a limitation
308 by design since reloading all the plugins *might* have some nasty side effects 307 by design since reloading all the plugins *might* have some nasty side effects
309 that may not be immediately apparent. Let's just say it can make your shell act 308 that may not be immediately apparent. Let's just say it can make your shell act
310 real quirky. 309 real quirky.
311 310
312 **Please note**: This command is not for updating *antigen* itself. Its for 311 **Please note**: This command is not for updating *antigen* itself. Its for
313 updating the bundles you are using with antigen. To update your copy of antigen, 312 updating the bundles you are using with antigen. To update your copy of antigen,
314 use the `selfupdate` command described further below. 313 use the `selfupdate` command described further below.
315 314
316 ### antigen-revert <sup>&alpha;</sup> 315 ### antigen-revert <sup>&alpha;</sup>
317 316
318 Reverts the state of all your plugins to how they were before the last 317 Reverts the state of all your plugins to how they were before the last
319 `antigen-update`. This command is currently experimental, so don't rely too much 318 `antigen-update`. This command is currently experimental, so don't rely too much
320 on it. There is a test for it, and it passes, so it should work fine though. 319 on it. There is a test for it, and it passes, so it should work fine though.
321 320
322 Takes no options. 321 Takes no options.
323 322
324 Insider detail: The information for reverting is stored in 323 Insider detail: The information for reverting is stored in
325 `$ADOTDIR/revert-info` file. If its not present, reverting is not possible. 324 `$ADOTDIR/revert-info` file. If its not present, reverting is not possible.
326 325
327 ### antigen-list 326 ### antigen-list
328 327
329 Use this command to list out the currently *loaded* plugins. Keep in mind that 328 Use this command to list out the currently *loaded* plugins. Keep in mind that
330 this includes any bundles installed on-the-fly. 329 this includes any bundles installed on-the-fly.
331 330
332 Takes no arguments. Gives out four entries per line of output, denoting the 331 Takes no arguments. Gives out four entries per line of output, denoting the
333 following fields of each bundle. 332 following fields of each bundle.
334 333
335 <repo-url> <loc> <btype> <has-local-clone?> 334 <repo-url> <loc> <btype> <has-local-clone?>
336 335
337 The `btype` field is an internal detail, that specifies if the bundle is a 336 The `btype` field is an internal detail, that specifies if the bundle is a
338 `plugin` or a `theme`. 337 `plugin` or a `theme`.
339 338
340 The final field is `true` or `false` reflecting whether there is a local clone 339 The final field is `true` or `false` reflecting whether there is a local clone
341 for this bundle. 340 for this bundle.
342 341
343 ### antigen-cleanup 342 ### antigen-cleanup
344 343
345 Used to clean up the clones of repos which are not used by any plugins currently 344 Used to clean up the clones of repos which are not used by any plugins currently
346 loaded. It takes no arguments. When run, it lists out the repo-clones that are 345 loaded. It takes no arguments. When run, it lists out the repo-clones that are
347 available but are not used by any plugin *currently loaded*. 346 available but are not used by any plugin *currently loaded*.
348 347
349 This command, by default asks for confirmation before deleting the unused 348 This command, by default asks for confirmation before deleting the unused
350 clones. If the `--force` argument is given, then this confirmation is not asked. 349 clones. If the `--force` argument is given, then this confirmation is not asked.
351 It straight away deletes all the unused clones. This option makes this command 350 It straight away deletes all the unused clones. This option makes this command
352 usable in a non-interactive fashion. 351 usable in a non-interactive fashion.
353 352
354 ### antigen-use oh-my-zsh 353 ### antigen-use oh-my-zsh
355 354
356 This is (almost) the same as 355 This is (almost) the same as
357 356
358 antigen-bundle --loc=lib 357 antigen-bundle --loc=lib
359 358
360 So, it basically installs the oh-my-zsh's library as a bundle. 359 So, it basically installs the oh-my-zsh's library as a bundle.
361 360
362 One other thing it does is that some oh-my-zsh plugins expect a `$ZSH` set to 361 One other thing it does is that some oh-my-zsh plugins expect a `$ZSH` set to
363 the full path of the oh-my-zsh clone being used. This is also set to the 362 the full path of the oh-my-zsh clone being used. This is also set to the
364 correct path, if not already set to something else. 363 correct path, if not already set to something else.
365 364
366 Please note that this assumes that the `ANTIGEN_DEFAULT_REPO_URL` is set to the 365 Please note that this assumes that the `ANTIGEN_DEFAULT_REPO_URL` is set to the
367 oh-my-zsh repo or a fork of that repo. If you want to specify the `url` too, 366 oh-my-zsh repo or a fork of that repo. If you want to specify the `url` too,
368 then you can't use the `antigen-use oh-my-zsh` short cut. You have to do that 367 then you can't use the `antigen-use oh-my-zsh` short cut. You have to do that
369 directly with the `antigen-bundle` command. 368 directly with the `antigen-bundle` command.
370 369
371 This is present to ease dealing with oh-my-zsh plugins. 370 This is present to ease dealing with oh-my-zsh plugins.
372 371
373 Use 372 Use
374 373
375 antigen-use oh-my-zsh 374 antigen-use oh-my-zsh
376 375
377 in your `.zshrc`, before any `antigen-bundle` declarations. It takes no 376 in your `.zshrc`, before any `antigen-bundle` declarations. It takes no
378 arguments. 377 arguments.
379 378
380 ### antigen-use prezto <sup>&alpha;</sup> 379 ### antigen-use prezto <sup>&alpha;</sup>
381 380
382 This is (almost, but not quite) the same as doing, 381 This is (almost, but not quite) the same as doing,
383 382
384 antigen-bundle sorin-ionescu/prezto 383 antigen-bundle sorin-ionescu/prezto
385 384
386 That is, initializes the canonical repo of the prezto framework. Please note 385 That is, initializes the canonical repo of the prezto framework. Please note
387 that prezto support is very new and experimental in antigen. If you find any 386 that prezto support is very new and experimental in antigen. If you find any
388 bugs, please report over on github issues. 387 bugs, please report over on github issues.
389 388
390 ### antigen-theme 389 ### antigen-theme
391 390
392 Used for switching the prompt theme. Invoke it with the name of the theme you 391 Used for switching the prompt theme. Invoke it with the name of the theme you
393 want to use. 392 want to use.
394 393
395 antigen-theme fox 394 antigen-theme fox
396 395
397 This will get the theme file located at `themes/fox.zsh-theme` in the repo 396 This will get the theme file located at `themes/fox.zsh-theme` in the repo
398 specified by `ANTIGEN_DEFAULT_REPO_URL`. 397 specified by `ANTIGEN_DEFAULT_REPO_URL`.
399 398
400 To pull themes from other repositories, use `antigen-theme` just like 399 To pull themes from other repositories, use `antigen-theme` just like
401 `antigen-bundle`. Exactly the same, just make sure the `url` and `loc` 400 `antigen-bundle`. Exactly the same, just make sure the `url` and `loc`
402 combination point to a theme file, having a `.zsh-theme` extension. 401 combination point to a theme file, having a `.zsh-theme` extension.
403 402
404 For example, 403 For example,
405 404
406 antigen-theme robbyrussell/oh-my-zsh themes/apple 405 antigen-theme robbyrussell/oh-my-zsh themes/apple
407 406
408 Will pull the apple theme from the canonical oh-my-zsh repo. Also, note that the 407 Will pull the apple theme from the canonical oh-my-zsh repo. Also, note that the
409 `.zsh-theme` extension is not present. It can be given, its optional. 408 `.zsh-theme` extension is not present. It can be given, its optional.
410 409
411 You can use this command to change your theme on the fly in your shell. Go on, 410 You can use this command to change your theme on the fly in your shell. Go on,
412 try out a few themes in your shell before you set it in your `.zshrc`. 411 try out a few themes in your shell before you set it in your `.zshrc`.
413 412
414 **Note**: Some themes use functions that are loaded by `antigen-use oh-my-zsh`. 413 **Note**: Some themes use functions that are loaded by `antigen-use oh-my-zsh`.
415 So, to avoid any trouble, run `antigen-use oh-my-zsh` if you haven't already 414 So, to avoid any trouble, run `antigen-use oh-my-zsh` if you haven't already
416 before experimenting with themes. If you have `antigen-use oh-my-zsh` in your 415 before experimenting with themes. If you have `antigen-use oh-my-zsh` in your
417 `.zshrc`, you're covered. 416 `.zshrc`, you're covered.
418 417
419 **Note**: Do *not* provide the `--btype` argument to `antigen-theme`. Its an 418 **Note**: Do *not* provide the `--btype` argument to `antigen-theme`. Its an
420 internal argument. 419 internal argument.
421 420
422 ### antigen-apply 421 ### antigen-apply
423 422
424 You have to add this command after defining all bundles you need, in your zshrc. 423 You have to add this command after defining all bundles you need, in your zshrc.
425 The completions defined by your bundles will be loaded at this step. 424 The completions defined by your bundles will be loaded at this step.
426 425
427 It is possible to load completions as and when a bundle is specified with the 426 It is possible to load completions as and when a bundle is specified with the
428 bundle command, in which case this command would not be necessary. But loading 427 bundle command, in which case this command would not be necessary. But loading
429 the completions is a time-consuming process, so if the completions were loaded 428 the completions is a time-consuming process, so if the completions were loaded
430 at every call to `antigen-bundle`, your shell will start noticeably slow when 429 at every call to `antigen-bundle`, your shell will start noticeably slow when
431 you have a good number of bundle specifications. 430 you have a good number of bundle specifications.
432 431
433 However, if you can suggest a way so that this would not be necessary, I am very 432 However, if you can suggest a way so that this would not be necessary, I am very
434 interested in discussing it. Please open up an issue with your details. Thanks. 433 interested in discussing it. Please open up an issue with your details. Thanks.
435 434
436 ### antigen-snapshot <sup>&alpha;</sup> 435 ### antigen-snapshot <sup>&alpha;</sup>
437 436
438 Creates a snapshot of all the clones you currently have *active* including the 437 Creates a snapshot of all the clones you currently have *active* including the
439 git version hash they are at and save it to a snapshot file. *Active* means, the 438 git version hash they are at and save it to a snapshot file. *Active* means, the
440 clones for those listed by `antigen-cleanup` are not included in the snapshot. 439 clones for those listed by `antigen-cleanup` are not included in the snapshot.
441 440
442 Takes one optional argument, the file name in which the snapshot is to be saved. 441 Takes one optional argument, the file name in which the snapshot is to be saved.
443 Defaults to `antigen-snapshot`. 442 Defaults to `antigen-snapshot`.
444 443
445 **Note**: The snapshot currently *only* contains the details of those bundles 444 **Note**: The snapshot currently *only* contains the details of those bundles
446 that have a clone. That is, bundles that have `--no-local-clone` set or are 445 that have a clone. That is, bundles that have `--no-local-clone` set or are
447 directly sourced from your file system (without a git repo), are not recorded 446 directly sourced from your file system (without a git repo), are not recorded
448 in the snapshot file. 447 in the snapshot file.
449 448
450 ### antigen-restore <sup>&alpha;</sup> 449 ### antigen-restore <sup>&alpha;</sup>
451 450
452 Restore the bundles state as specified in the snapshot. Takes one required 451 Restore the bundles state as specified in the snapshot. Takes one required
453 argument, the snapshot file name to read. 452 argument, the snapshot file name to read.
454 453
455 Although it restores the clones of the repos specified in the snapshot file, any 454 Although it restores the clones of the repos specified in the snapshot file, any
456 other clones present in your environment are not touched. This behavior may 455 other clones present in your environment are not touched. This behavior may
457 change in the future. 456 change in the future.
458 457
459 ### antigen-selfupdate 458 ### antigen-selfupdate
460 459
461 Use this command to update your copy of antigen. It basically does a `git pull` 460 Use this command to update your copy of antigen. It basically does a `git pull`
462 on your antigen's clone, *if* it is a git clone. Otherwise, it doesn't do 461 on your antigen's clone, *if* it is a git clone. Otherwise, it doesn't do
463 anything. 462 anything.
464 463
465 Takes no options. 464 Takes no options.
466 465
467 ### antigen-help 466 ### antigen-help
468 467
469 This exists so that there can be some help right in the command line. Currently 468 This exists so that there can be some help right in the command line. Currently
470 it doesn't provide much help other than redirecting you to the project page for 469 it doesn't provide much help other than redirecting you to the project page for
471 documentation. It is intended to provide more meaning and sub-command specific 470 documentation. It is intended to provide more meaning and sub-command specific
472 help in the future. 471 help in the future.
473 472
474 I could use some help here as I'm not that good at writing documentation that 473 I could use some help here as I'm not that good at writing documentation that
475 looks good as output on the command line. 474 looks good as output on the command line.
476 475
477 ### antigen 476 ### antigen
478 477
479 This is a parent command that mainly exists for convenience. This exists so the 478 This is a parent command that mainly exists for convenience. This exists so the
480 following two can be the same. 479 following two can be the same.
481 480
482 antigen-list 481 antigen-list
483 antigen list 482 antigen list
484 483
485 and 484 and
486 485
487 antigen-help 486 antigen-help
488 antigen help 487 antigen help
489 488
490 Because of this, we can create aliases like 489 Because of this, we can create aliases like
491 490
492 alias a=antigen 491 alias a=antigen
493 alias an=antigen 492 alias an=antigen
494 493
495 and run the antigen commands without making them look annoyingly long. 494 and run the antigen commands without making them look annoyingly long.
496 495
497 a bundle ruby 496 a bundle ruby
498 a theme candy 497 a theme candy
499 a list 498 a list
500 499
501 And even... 500 And even...
502 501
503 an update 502 an update
504 503
505 ## Configuration 504 ## Configuration
506 505
507 The following environment variables can be set to customize the behavior of 506 The following environment variables can be set to customize the behavior of
508 antigen. Make sure you set them *before* source-ing `antigen.zsh`. 507 antigen. Make sure you set them *before* source-ing `antigen.zsh`.
509 508
510 `ANTIGEN_DEFAULT_REPO_URL` &mdash; This is the default repository url that is 509 `ANTIGEN_DEFAULT_REPO_URL` &mdash; This is the default repository url that is
511 used for `bundle` commands. The default value is robbyrussell's oh-my-zsh repo, 510 used for `bundle` commands. The default value is robbyrussell's oh-my-zsh repo,
512 but you can set this to the fork url of your own fork. 511 but you can set this to the fork url of your own fork.
513 512
514 `ADOTDIR` &mdash; This directory is used to store all the repo clones, your 513 `ADOTDIR` &mdash; This directory is used to store all the repo clones, your
515 bundles, themes, caches and everything else antigen requires to run smoothly. 514 bundles, themes, caches and everything else antigen requires to run smoothly.
516 Defaults to `$HOME/.antigen`. 515 Defaults to `$HOME/.antigen`.
517 516
518 **Note**: `ANTIGEN_REPO_CACHE` & `ANTIGEN_BUNDLE_DIR` &mdash; These variables 517 **Note**: `ANTIGEN_REPO_CACHE` & `ANTIGEN_BUNDLE_DIR` &mdash; These variables
519 were used previously but are now removed. Please use `ADOTDIR` instead, as 518 were used previously but are now removed. Please use `ADOTDIR` instead, as
520 mentioned above. 519 mentioned above.
521 520
522 ## Running the tests 521 ## Running the tests
523 522
524 All the tests are in the `tests` folder and are run using the [cram][] test 523 All the tests are in the `tests` folder and are run using the [cram][] test
525 system. The latest version on that website, as of today is v0.5, which does not 524 system. The latest version on that website, as of today is v0.5, which does not
526 have the `--shell` argument which is required to run our tests. So, to get the 525 have the `--shell` argument which is required to run our tests. So, to get the
527 correct version of cram, run 526 correct version of cram, run
528 527
529 pip install -r requirements.txt 528 pip install -r requirements.txt
530 529
531 With that, once you have cram installed, you can run the tests as 530 With that, once you have cram installed, you can run the tests as
532 531
533 make 532 make
534 533
535 If you are making a feature addition, I'd really appreciate if you can add a 534 If you are making a feature addition, I'd really appreciate if you can add a
536 test for your feature. Even if you can add a test for an existing feature, that 535 test for your feature. Even if you can add a test for an existing feature, that
537 would be great as the tests are currently seriously lagging behind the full 536 would be great as the tests are currently seriously lagging behind the full
538 functionality of antigen. 537 functionality of antigen.
539 538
540 ## Notes on writing plugins 539 ## Notes on writing plugins
541 540
542 Most shell utilities/plugins are made up of just one file. For a plugin called 541 Most shell utilities/plugins are made up of just one file. For a plugin called
543 `awesomeness`, create a `awesomeness.plugin.zsh` and code away. 542 `awesomeness`, create a `awesomeness.plugin.zsh` and code away.
544 543
545 That said, even if you write a single file as a `.sh` file with the goodness you 544 That said, even if you write a single file as a `.sh` file with the goodness you
546 want to create, antigen will work just fine with it. The `*.plugin.zsh` way is 545 want to create, antigen will work just fine with it. The `*.plugin.zsh` way is
547 recommended by antigen, because it is widely used because of the [oh-my-zsh][] 546 recommended by antigen, because it is widely used because of the [oh-my-zsh][]
548 project. 547 project.
549 548
550 If you want to know how antigen loads the plugins, do continue. 549 If you want to know how antigen loads the plugins, do continue.
551 550
552 Firstly, antigen looks for a `*.plugin.zsh` file in the plugin directory. If 551 Firstly, antigen looks for a `*.plugin.zsh` file in the plugin directory. If
553 present, it will source *only* this script. Nothing else is sourced. This is for 552 present, it will source *only* this script. Nothing else is sourced. This is for
554 oh-my-zsh style plugins. 553 oh-my-zsh style plugins.
555 554
556 Secondly, it looks for a `init.zsh` file in the plugin directory. If present, it 555 Secondly, it looks for a `init.zsh` file in the plugin directory. If present, it
557 will source *only* this script. Nothing else is sourced. This is for prezto 556 will source *only* this script. Nothing else is sourced. This is for prezto
558 style modules. 557 style modules.
559 558
560 Otherwise, it looks for `*.zsh` files and if there are any, *all* of them are 559 Otherwise, it looks for `*.zsh` files and if there are any, *all* of them are
561 sourced. The order in which they are sourced is not currently defined. Please 560 sourced. The order in which they are sourced is not currently defined. Please
562 don't rely on this order. Nothing else is sourced after all the `*.zsh` scripts. 561 don't rely on this order. Nothing else is sourced after all the `*.zsh` scripts.
563 562
564 If no `*.zsh` files are present, it finally looks for any `*.sh` files and 563 If no `*.zsh` files are present, it finally looks for any `*.sh` files and
565 sources *all* of them. Again, the order in which they are sourced in not 564 sources *all* of them. Again, the order in which they are sourced in not
566 currently defined. 565 currently defined.
567 566
568 No matter which (or none) of the above happen to be sourced, this plugin 567 No matter which (or none) of the above happen to be sourced, this plugin
569 directory is added to the zsh's function path (`$fpath`) so that any completions 568 directory is added to the zsh's function path (`$fpath`) so that any completions
570 in it are loaded. 569 in it are loaded.
571 570
572 One exception to this rule is that if this plugin is a theme. In which case the 571 One exception to this rule is that if this plugin is a theme. In which case the
573 theme script is just sourced and nothing else is done. Not even adding to 572 theme script is just sourced and nothing else is done. Not even adding to
574 `$fpath`. 573 `$fpath`.
575 574
576 ## Meta 575 ## Meta
577 576
578 ### Helping out 577 ### Helping out
579 578
580 Antigen is licensed with the [MIT License][license]. To contribute, just fork, 579 Antigen is licensed with the [MIT License][license]. To contribute, just fork,
581 make changes and send a pull request. If its a rather long/complicated change, 580 make changes and send a pull request. If its a rather long/complicated change,
582 please consider opening an [issue][] first so we can discuss it out. 581 please consider opening an [issue][] first so we can discuss it out.
583 582
584 ### Feedback please 583 ### Feedback please
585 584
586 Any comments/suggestions/feedback welcome. Please say hello to me 585 Any comments/suggestions/feedback welcome. Please say hello to me
587 ([@sharat87][twitter]) on twitter. Or open an issue to discuss something 586 ([@sharat87][twitter]) on twitter. Or open an issue to discuss something
588 (anything!) about the project ;). 587 (anything!) about the project ;).
589 588
590 589
591 [Vundle]: https://github.com/gmarik/vundle 590 [Vundle]: https://github.com/gmarik/vundle
592 [page on themes]: https://github.com/robbyrussell/oh-my-zsh/wiki/Themes 591 [page on themes]: https://github.com/robbyrussell/oh-my-zsh/wiki/Themes
593 [wild]: https://github.com/zsh-users/antigen/wiki/In-the-wild 592 [wild]: https://github.com/zsh-users/antigen/wiki/In-the-wild
594 [syntax highlighting plugin]: https://github.com/zsh-users/zsh-syntax-highlighting 593 [syntax highlighting plugin]: https://github.com/zsh-users/zsh-syntax-highlighting
595 [autoenv]: https://github.com/kennethreitz/autoenv 594 [autoenv]: https://github.com/kennethreitz/autoenv
596 [f-autoenv]: https://github.com/sharat87/autoenv 595 [f-autoenv]: https://github.com/sharat87/autoenv
597 [oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh 596 [oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh
598 [cram]: https://bitheap.org/cram/ 597 [cram]: https://bitheap.org/cram/
599 [issue]: https://github.com/zsh-users/antigen/issues 598 [issue]: https://github.com/zsh-users/antigen/issues
600 [license]: http://mit.sharats.me 599 [license]: http://mit.sharats.me