mj / zsh-config

Download as
Browse Code ยป

Commit 79953f965ab3ce385dbbf22a9266977eca61853b

Authored by Shrikant Sharat
1 parent 13399b89bf

Fix readme links. Incudes fix #15

Showing 1 changed file with 2 additions and 2 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 You can also specify a local directory on your file system as a bundle. In this 202 You can also specify a local directory on your file system as a bundle. In this
203 case, make sure the path you give is the absolute path (i.e., starts with a 203 case, make sure the path you give is the absolute path (i.e., starts with a
204 `/`). Relative paths are not supported. If the repo you gave is a local 204 `/`). Relative paths are not supported. If the repo you gave is a local
205 directory path, then it is not necessary that this path is a git repo. Please 205 directory path, then it is not necessary that this path is a git repo. Please
206 refer to the notes on `--no-local-clone` below. 206 refer to the notes on `--no-local-clone` below.
207 207
208 In addition to the above discussed arguments, `antigen-bundle` also takes a 208 In addition to the above discussed arguments, `antigen-bundle` also takes a
209 `btype` keyword-only argument, that is used internally. You shouldn't be 209 `btype` keyword-only argument, that is used internally. You shouldn't be
210 concerned with this argument, its only used internally and will probably go away 210 concerned with this argument, its only used internally and will probably go away
211 in the future. It indicates whether the bundle is a theme or a simple plugin. 211 in the future. It indicates whether the bundle is a theme or a simple plugin.
212 212
213 You can use this `antigen-bundle` command not just from your `.zshrc`, but also 213 You can use this `antigen-bundle` command not just from your `.zshrc`, but also
214 from your shell environment. This allows you to install plugins on the fly and 214 from your shell environment. This allows you to install plugins on the fly and
215 try them out. Of course if you want a bundle to be available every time you open 215 try them out. Of course if you want a bundle to be available every time you open
216 a shell, put it in your `.zshrc`. 216 a shell, put it in your `.zshrc`.
217 217
218 Other keyword-only arguments accepted: 218 Other keyword-only arguments accepted:
219 219
220 `--branch={git-branch-name}` &mdash; Specify the branch of the git repo to be 220 `--branch={git-branch-name}` &mdash; Specify the branch of the git repo to be
221 used for this bundle (without the braces of course). The default is whatever 221 used for this bundle (without the braces of course). The default is whatever
222 branch the clone comes with, which is usually `master`. For example, 222 branch the clone comes with, which is usually `master`. For example,
223 223
224 antigen-bundle github-user/repo --branch=develop 224 antigen-bundle github-user/repo --branch=develop
225 225
226 This will get the plugin as in the branch `develop`. 226 This will get the plugin as in the branch `develop`.
227 227
228 Note that if you specify two plugins to be loaded from the same git repo, but 228 Note that if you specify two plugins to be loaded from the same git repo, but
229 different branches, then two separate clones of this repo will be maintained. 229 different branches, then two separate clones of this repo will be maintained.
230 This is a small implementation detail and shouldn't influence you in any way. 230 This is a small implementation detail and shouldn't influence you in any way.
231 231
232 `--no-local-clone` &mdash; This command can be useful if you are developing a 232 `--no-local-clone` &mdash; This command can be useful if you are developing a
233 plugin and already have a clone on your local file system. If this argument is 233 plugin and already have a clone on your local file system. If this argument is
234 not given, even if the given repo url is a local path, a clone is made in the 234 not given, even if the given repo url is a local path, a clone is made in the
235 `$ADOTDIR/repos`, and the plugin is loaded from that clone. But, if you give 235 `$ADOTDIR/repos`, and the plugin is loaded from that clone. But, if you give
236 this argument, the plugin is sourced straight from the repo location, without 236 this argument, the plugin is sourced straight from the repo location, without
237 creating a clone. For example, 237 creating a clone. For example,
238 238
239 antigen-bundle /absolute/path/to/the/plugin --no-local-clone 239 antigen-bundle /absolute/path/to/the/plugin --no-local-clone
240 240
241 Note that if the repo url is *not* an absolute local path or a branch has been 241 Note that if the repo url is *not* an absolute local path or a branch has been
242 specified with the `--branch` option, this argument has no effect. That is, 242 specified with the `--branch` option, this argument has no effect. That is,
243 for this option to have any affect, the repo url must be an absolute local path 243 for this option to have any affect, the repo url must be an absolute local path
244 and no `--branch` should be specified. 244 and no `--branch` should be specified.
245 245
246 Also, if the local path given as the url is not a git repo, then this 246 Also, if the local path given as the url is not a git repo, then this
247 argument is forced as it doesn't makes sense to *clone* something that's not a 247 argument is forced as it doesn't makes sense to *clone* something that's not a
248 git repo. This property can be used to load any utility scripts you have in your 248 git repo. This property can be used to load any utility scripts you have in your
249 dotfiles repo. For example, 249 dotfiles repo. For example,
250 250
251 antigen-bundle $HOME/dotfiles/oh-my-zsh/custom 251 antigen-bundle $HOME/dotfiles/oh-my-zsh/custom
252 252
253 ### antigen-bundles 253 ### antigen-bundles
254 254
255 If you have a fair number of bundles, using the `antigen-bundle` command can 255 If you have a fair number of bundles, using the `antigen-bundle` command can
256 look cumbersome. You can use the `antigen-bundles` command to *bulk* define 256 look cumbersome. You can use the `antigen-bundles` command to *bulk* define
257 bundles instead of individual calls to `antigen-bundle`. 257 bundles instead of individual calls to `antigen-bundle`.
258 258
259 Usage is pretty straightforward. Just pipe the bundle specifications, just as 259 Usage is pretty straightforward. Just pipe the bundle specifications, just as
260 you would give to the `antigen-bundle` command, one per line, into the 260 you would give to the `antigen-bundle` command, one per line, into the
261 `antigen-bundles` command. The easiest way to do this, is using the heredoc 261 `antigen-bundles` command. The easiest way to do this, is using the heredoc
262 syntax. 262 syntax.
263 263
264 antigen-bundles <<EOF 264 antigen-bundles <<EOF
265 # Guess what to install when running an unknown command. 265 # Guess what to install when running an unknown command.
266 command-not-found 266 command-not-found
267 267
268 # The heroku tool helper plugin. 268 # The heroku tool helper plugin.
269 heroku 269 heroku
270 270
271 EOF 271 EOF
272 272
273 This is equivalent to 273 This is equivalent to
274 274
275 antigen-bundle command-not-found 275 antigen-bundle command-not-found
276 antigen-bundle heroku 276 antigen-bundle heroku
277 277
278 Of course, as you can see, from the lines piped to `antigen-bundles`, empty 278 Of course, as you can see, from the lines piped to `antigen-bundles`, empty
279 lines and those starting with a `#` are ignored. The rest are passed to 279 lines and those starting with a `#` are ignored. The rest are passed to
280 `antigen-bundle` without any quoting rules applied. They are actually `eval`-ed 280 `antigen-bundle` without any quoting rules applied. They are actually `eval`-ed
281 with the `antigen-bundle` command. See the source if you want to really 281 with the `antigen-bundle` command. See the source if you want to really
282 understand how it works. Its a very small function. 282 understand how it works. Its a very small function.
283 283
284 ### antigen-update 284 ### antigen-update
285 285
286 This is something you might not want to put in your `.zshrc`. Instead, run it 286 This is something you might not want to put in your `.zshrc`. Instead, run it
287 occasionally to update all your plugins. It doesn't take any arguments. 287 occasionally to update all your plugins. It doesn't take any arguments.
288 288
289 antigen-update 289 antigen-update
290 290
291 Please note that the updates that are downloaded are not immediately available. 291 Please note that the updates that are downloaded are not immediately available.
292 You have to open a new shell to be able to see the changes. This is a limitation 292 You have to open a new shell to be able to see the changes. This is a limitation
293 by design since reloading all the plugins *might* have some nasty side effects 293 by design since reloading all the plugins *might* have some nasty side effects
294 that may not be immediately apparent. Let's just say it can make your shell act 294 that may not be immediately apparent. Let's just say it can make your shell act
295 real quirky. 295 real quirky.
296 296
297 **Please note**: This command is not for updating *antigen* itself. Its for 297 **Please note**: This command is not for updating *antigen* itself. Its for
298 updating the bundles you are using with antigen. 298 updating the bundles you are using with antigen.
299 299
300 ### antigen-list 300 ### antigen-list
301 301
302 Use this command to list out the currently *loaded* plugins. Keep in mind that 302 Use this command to list out the currently *loaded* plugins. Keep in mind that
303 this includes any bundles installed on-the-fly. 303 this includes any bundles installed on-the-fly.
304 304
305 Takes no arguments. Gives out the repo url and the plugin's location under the 305 Takes no arguments. Gives out the repo url and the plugin's location under the
306 repo. 306 repo.
307 307
308 ### antigen-cleanup 308 ### antigen-cleanup
309 309
310 Used to clean up the clones of repos which are not used by any plugins. It takes 310 Used to clean up the clones of repos which are not used by any plugins. It takes
311 no arguments. When this is run, it lists out the repo-clones that are available 311 no arguments. When this is run, it lists out the repo-clones that are available
312 but are not used by any plugin *currently loaded*. 312 but are not used by any plugin *currently loaded*.
313 313
314 This command, by default asks for confirmation before deleting the unused 314 This command, by default asks for confirmation before deleting the unused
315 clones. If the `--force` argument is given, then this confirmation is not asked. 315 clones. If the `--force` argument is given, then this confirmation is not asked.
316 It straight away deletes all the unused clones. This option makes this command 316 It straight away deletes all the unused clones. This option makes this command
317 usable in a non-interactive fashion. 317 usable in a non-interactive fashion.
318 318
319 ### antigen-lib 319 ### antigen-lib
320 320
321 This is a shortcut to 321 This is a shortcut to
322 322
323 antigen-bundle --loc=lib 323 antigen-bundle --loc=lib
324 324
325 So, it basically installs the oh-my-zsh's library as a bundle. Please note that 325 So, it basically installs the oh-my-zsh's library as a bundle. Please note that
326 this assumes that the `ANTIGEN_DEFAULT_REPO_URL` is set to the oh-my-zsh repo or 326 this assumes that the `ANTIGEN_DEFAULT_REPO_URL` is set to the oh-my-zsh repo or
327 a fork of that repo. If you want to specify the `url` too, then you can't use 327 a fork of that repo. If you want to specify the `url` too, then you can't use
328 the `antigen-lib` short cut. You have to do that directly with the 328 the `antigen-lib` short cut. You have to do that directly with the
329 `antigen-bundle` command. 329 `antigen-bundle` command.
330 330
331 This is present only for legacy reasons and *might* (or might not) be removed in 331 This is present only for legacy reasons and *might* (or might not) be removed in
332 the future. 332 the future.
333 333
334 Use 334 Use
335 335
336 antigen-lib 336 antigen-lib
337 337
338 in your `.zshrc`, before any `antigen-bundle` declarations. It takes no 338 in your `.zshrc`, before any `antigen-bundle` declarations. It takes no
339 arguments. 339 arguments.
340 340
341 ### antigen-theme 341 ### antigen-theme
342 342
343 Used for switching the prompt theme. Invoke it with the name of the theme you 343 Used for switching the prompt theme. Invoke it with the name of the theme you
344 want to use. 344 want to use.
345 345
346 antigen-theme fox 346 antigen-theme fox
347 347
348 Currently, themes are pulled from robbyrussell's oh-my-zsh repo, but it will 348 Currently, themes are pulled from robbyrussell's oh-my-zsh repo, but it will
349 support getting themes from other repos as well in the future. 349 support getting themes from other repos as well in the future.
350 350
351 You can use this command to change your theme on the fly in your shell. Go on, 351 You can use this command to change your theme on the fly in your shell. Go on,
352 try out a few themes in your shell before you set it in your `.zshrc`. 352 try out a few themes in your shell before you set it in your `.zshrc`.
353 353
354 ### antigen-apply 354 ### antigen-apply
355 355
356 You have to add this command after defining all bundles you need, in your zshrc. 356 You have to add this command after defining all bundles you need, in your zshrc.
357 The completions defined by your bundles will be loaded at this step. 357 The completions defined by your bundles will be loaded at this step.
358 358
359 It is possible to load completions as and when a bundle is specified with the 359 It is possible to load completions as and when a bundle is specified with the
360 bundle command, in which case this command would not be necessary. But loading 360 bundle command, in which case this command would not be necessary. But loading
361 the completions is a time-consuming process and your shell will start noticeably 361 the completions is a time-consuming process and your shell will start noticeably
362 slow if you have a good number of bundle specifications. 362 slow if you have a good number of bundle specifications.
363 363
364 However, if you're a zsh expert and can suggest a way so that this would not be 364 However, if you're a zsh expert and can suggest a way so that this would not be
365 necessary, I am very interested in discussing it. Please open up an issue with 365 necessary, I am very interested in discussing it. Please open up an issue with
366 your details. Thanks. 366 your details. Thanks.
367 367
368 ### antigen-help 368 ### antigen-help
369 369
370 This exists so that there can be some help right in the command line. Currently 370 This exists so that there can be some help right in the command line. Currently
371 it doesn't provide much help other than redirecting you to the project page for 371 it doesn't provide much help other than redirecting you to the project page for
372 documentation. It is intended to provide more meaning and sub-command specific 372 documentation. It is intended to provide more meaning and sub-command specific
373 help in the future. 373 help in the future.
374 374
375 I could use some help here as I'm not that good at writing documentation that 375 I could use some help here as I'm not that good at writing documentation that
376 looks good as output on the command line. 376 looks good as output on the command line.
377 377
378 ### antigen 378 ### antigen
379 379
380 This is a parent command that mainly exists for convenience. The idea is the 380 This is a parent command that mainly exists for convenience. The idea is the
381 following two are the same. 381 following two are the same.
382 382
383 antigen-list 383 antigen-list
384 antigen list 384 antigen list
385 385
386 and 386 and
387 387
388 antigen-help 388 antigen-help
389 antigen help 389 antigen help
390 390
391 Because of this, we can create aliases like 391 Because of this, we can create aliases like
392 392
393 alias a=antigen 393 alias a=antigen
394 alias an=antigen 394 alias an=antigen
395 395
396 and run the antigen commands without making them look annoyingly long. 396 and run the antigen commands without making them look annoyingly long.
397 397
398 a bundle ruby 398 a bundle ruby
399 a theme candy 399 a theme candy
400 a list 400 a list
401 401
402 And even... 402 And even...
403 403
404 an update 404 an update
405 405
406 ## Configuration 406 ## Configuration
407 407
408 The following environment variables can be set to customize the behavior of 408 The following environment variables can be set to customize the behavior of
409 antigen. Make sure you set them *before* source-ing `antigen.zsh`. 409 antigen. Make sure you set them *before* source-ing `antigen.zsh`.
410 410
411 `ANTIGEN_DEFAULT_REPO_URL` &mdash; This is the default repository url that is 411 `ANTIGEN_DEFAULT_REPO_URL` &mdash; This is the default repository url that is
412 used for `bundle` commands. The default value is robbyrussell's oh-my-zsh repo, 412 used for `bundle` commands. The default value is robbyrussell's oh-my-zsh repo,
413 but you can set this to the fork url of your own fork. 413 but you can set this to the fork url of your own fork.
414 414
415 `ADOTDIR` &mdash; This directory is used to store all the repo clones, your 415 `ADOTDIR` &mdash; This directory is used to store all the repo clones, your
416 bundles, themes, caches and everything else antigen requires to run smoothly. 416 bundles, themes, caches and everything else antigen requires to run smoothly.
417 Defaults to `$HOME/.antigen`. 417 Defaults to `$HOME/.antigen`.
418 418
419 **Note**: `ANTIGEN_REPO_CACHE` & `ANTIGEN_BUNDLE_DIR` &mdash; These variables 419 **Note**: `ANTIGEN_REPO_CACHE` & `ANTIGEN_BUNDLE_DIR` &mdash; These variables
420 were used previously but are now removed. Please use `ADOTDIR` instead, as 420 were used previously but are now removed. Please use `ADOTDIR` instead, as
421 mentioned above. 421 mentioned above.
422 422
423 ## Running the tests 423 ## Running the tests
424 424
425 All the tests are in the `tests` folder and are run using the [cram]() test 425 All the tests are in the `tests` folder and are run using the [cram][] test
426 system. Once you have cram installed, you can run the tests as 426 system. Once you have cram installed, you can run the tests as
427 427
428 make 428 make
429 429
430 or 430 or
431 431
432 make tests 432 make tests
433 433
434 If you are making a feature addition, I'd really appreciate if you can add a 434 If you are making a feature addition, I'd really appreciate if you can add a
435 test for your feature. Even if you can add a test for an existing feature, that 435 test for your feature. Even if you can add a test for an existing feature, that
436 would be great as the tests are currently seriously lagging behind the full 436 would be great as the tests are currently seriously lagging behind the full
437 functionality of antigen. 437 functionality of antigen.
438 438
439 ## Notes on writing plugins 439 ## Notes on writing plugins
440 440
441 If you are just going to write a single `.sh` file with the goodness you want to 441 If you are just going to write a single `.sh` file with the goodness you want to
442 create, just forget about this and go do that. Antigen will work just find with 442 create, just forget about this and go do that. Antigen will work just find with
443 such a plugin. 443 such a plugin.
444 444
445 If you want to know how antigen loads the plugins, do continue. 445 If you want to know how antigen loads the plugins, do continue.
446 446
447 Firstly, antigen looks for a `*.plugin.zsh` file in the plugin directory. If 447 Firstly, antigen looks for a `*.plugin.zsh` file in the plugin directory. If
448 present, it will source *only* this script. Nothing else is sourced. 448 present, it will source *only* this script. Nothing else is sourced.
449 449
450 Otherwise, it looks for `*.zsh` files and if there are any, *all* of them are 450 Otherwise, it looks for `*.zsh` files and if there are any, *all* of them are
451 sourced. The order in which they are sourced is not currently defined. Please 451 sourced. The order in which they are sourced is not currently defined. Please
452 don't rely on this order. Nothing else is sourced after all the `*.zsh` scripts. 452 don't rely on this order. Nothing else is sourced after all the `*.zsh` scripts.
453 453
454 If no `*.zsh` files are present, it finally looks for any `*.sh` files and 454 If no `*.zsh` files are present, it finally looks for any `*.sh` files and
455 sources *all* of them. Again, the order in which they are sourced in not 455 sources *all* of them. Again, the order in which they are sourced in not
456 currently defined. 456 currently defined.
457 457
458 No matter which (or none) of the above happen to be sourced, this plugin 458 No matter which (or none) of the above happen to be sourced, this plugin
459 directory is added to the zsh's function path (`$fpath`) so that any completions 459 directory is added to the zsh's function path (`$fpath`) so that any completions
460 in it are loaded. One exception to this rule is that if this plugin is a prompt 460 in it are loaded. One exception to this rule is that if this plugin is a prompt
461 theme. In which case the theme script is just sourced and nothing else is done. 461 theme. In which case the theme script is just sourced and nothing else is done.
462 462
463 ## Meta 463 ## Meta
464 464
465 ### Helping out 465 ### Helping out
466 466
467 Antigen is licensed with the [MIT License][license]. To contribute, just fork, 467 Antigen is licensed with the [MIT License][license]. To contribute, just fork,
468 make changes and send a pull request. If its a rather long/complicated change, 468 make changes and send a pull request. If its a rather long/complicated change,
469 please consider opening an [issue][] first so we can discuss it out. 469 please consider opening an [issue][] first so we can discuss it out.
470 470
471 ### Feedback please 471 ### Feedback please
472 472
473 Any comments/suggestions/feedback welcome. Please join the discussion on the 473 Any comments/suggestions/feedback welcome. Please join the discussion on the
474 [reddit page][] of this project. Also, follow me on twitter, 474 [reddit page][] of this project. Also, follow me on twitter,
475 [@sharat87](twitter). 475 [@sharat87][twitter].
476 476
477 [Vundle]: https://github.com/gmarik/vundle 477 [Vundle]: https://github.com/gmarik/vundle
478 [page on themes]: https://github.com/robbyrussell/oh-my-zsh/wiki/Themes 478 [page on themes]: https://github.com/robbyrussell/oh-my-zsh/wiki/Themes
479 [syntax highlighting plugin]: https://github.com/zsh-users/zsh-syntax-highlighting 479 [syntax highlighting plugin]: https://github.com/zsh-users/zsh-syntax-highlighting
480 [autoenv]: https://github.com/kennethreitz/autoenv 480 [autoenv]: https://github.com/kennethreitz/autoenv
481 [oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh 481 [oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh
482 [cram]: https://bitheap.org/cram/ 482 [cram]: https://bitheap.org/cram/
483 [issue]: https://github.com/sharat87/antigen/issues 483 [issue]: https://github.com/sharat87/antigen/issues
484 [license]: http://mit.sharats.me 484 [license]: http://mit.sharats.me
485 [reddit page]: http://www.reddit.com/r/commandline/comments/u4f26/antigen_a_plugin_manager_for_zsh_shell/ 485 [reddit page]: http://www.reddit.com/r/commandline/comments/u4f26/antigen_a_plugin_manager_for_zsh_shell/
486 [twitter]: http://twitter.com/sharat87 486 [twitter]: http://twitter.com/sharat87
487 487