mj / zsh-config

Download as
Browse Code ยป

Commit b33b9e9d4e80494d11855b8691fdb7e4ed4e3069

Authored by Shrikant Sharat
1 parent 72e72c6085

Fix #24. Add recommendation about plugin structure. 

Adding the oh-my-zsh way of organising plugins as a recommending way of writing
plugins. Though of course, in the spirit of antigen, it is not required.

Showing 1 changed file with 7 additions and 3 deletions Inline Diff

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