mj / zsh-config

Download as
Browse Code ยป

Commit 8a80d2b7a57acb5c80df78a29423b719ba54629c

Authored by Shrikant Sharat
1 parent 7f742ef265

Add docs on --no-local-clone and some examples.

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

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