mj / zsh-config

Download as
Browse Code ยป

Commit fb91d6087105bf8bc996c33e8417adfc26f39266

Authored by Shrikant Sharat
1 parent 0c257ebe4a

Update docs on the new `-theme` sweetness. Fix #29.

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