mj / zsh-config

Download as
Browse Code ยป

Commit 9c68b578628652af77789a48e7d469907bbaf837

Authored by Shrikant Sharat
2 parents fb91d60871 09665a0b5f

Merge pull request #31 from GUIpsp/master 

Update the README further with more theme goodness

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