mj / zsh-config

Download as
Browse Code ยป

Commit 2fe4683b32a1b7c466e33c4773c550f3b384d287

Authored by Shrikant Sharat
1 parent 3c5ff1c1e2

Update README with new command nomenclature. 

Also renamed antigen-bundle-update to antigen-update for command name
consistency.

Showing 2 changed files with 40 additions and 36 deletions Side-by-side Diff

... ... @@ -75,20 +75,20 @@ and your prompt is changed, just for this session of course.
75 75  
76 76 # Commands
77 77  
78   -## bundle
  78 +## antigen-bundle
79 79  
80 80 This command tells antigen to install (if not already installed) and load the
81 81 given plugin. The simplest usage follows the following syntax.
82 82  
83   - bundle <plugin-name>
  83 + antigen-bundle <plugin-name>
84 84  
85 85 This will install the `plugins/<name>` directory from [robbyrussell's
86 86 oh-my-zsh][oh-my-zsh] (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`).
87 87  
88   -However, the above is just syntax sugar for the extended syntax of the `bundle`
89   -command.
  88 +However, the above is just syntax sugar for the extended syntax of the
  89 +`antigen-bundle` command.
90 90  
91   - bundle [<url> [<loc>]]
  91 + antigen-bundle [<url> [<loc>]]
92 92  
93 93 where `<url>` is the repository url and it defaults to [robbyrussell's
94 94 oh-my-zsh][oh-my-zsh] repo (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`
... ... @@ -99,22 +99,22 @@ but it could contain a completion file or just many `*.zsh` files to be sourced.
99 99  
100 100 An example invocation would be
101 101  
102   - # The following is the same as `bundle ant`. But for demonstration purposes,
103   - # we use the extended syntax here.
104   - bundle https://github.com/robbyrussell/oh-my-zsh.git plugins/ant
  102 + # The following is the same as `antigen-bundle ant`. But for demonstration
  103 + # purposes, we use the extended syntax here.
  104 + antigen-bundle https://github.com/robbyrussell/oh-my-zsh.git plugins/ant
105 105  
106 106 This would install the ant plugin from robbyrussell's oh-my-zsh repo. Of course,
107 107 github url's can be shortened.
108 108  
109   - bundle robbyrussell/oh-my-zsh plugins/ant
  109 + antigen-bundle robbyrussell/oh-my-zsh plugins/ant
110 110  
111 111 And since this repo is the default, even that isn't necessary. But we can't
112 112 specify the `loc` without giving the first argument.
113 113  
114   -For this and a few other reasons, `bundle` also supports a simple keyword
115   -argument syntax, using which we can rewrite the above as
  114 +For this and a few other reasons, `antigen-bundle` also supports a simple
  115 +keyword argument syntax, using which we can rewrite the above as
116 116  
117   - bundle --loc=plugins/ant
  117 + antigen-bundle --loc=plugins/ant
118 118  
119 119 Which picks up the default for the `url` argument, and uses the `loc` given to
120 120 it.
... ... @@ -122,29 +122,29 @@ it.
122 122 *Note* that you can mix and match positional and keyword arguments. But you
123 123 can't have positional arguments after keyword arguments.
124 124  
125   - bundle robbyrussell/oh-my-zsh --loc=plugins/ant
  125 + antigen-bundle robbyrussell/oh-my-zsh --loc=plugins/ant
126 126  
127 127 And keyword arguments don't care about the order in which the arguments are
128 128 specified. The following is perfectly valid.
129 129  
130   - bundle --loc=plugins/ant --url=robbyrussell/oh-my-zsh
  130 + antigen-bundle --loc=plugins/ant --url=robbyrussell/oh-my-zsh
131 131  
132   -In addition to the above discussed arguments, `bundle` also takes a `btype`
133   -keyword-only argument, that is used internally. You shouldn't be concerned with
134   -this argument, its only used internally and will probably go away in the future.
135   -It indicates whether the bundle is a theme or a simple plugin.
  132 +In addition to the above discussed arguments, `antigen-bundle` also takes a
  133 +`btype` keyword-only argument, that is used internally. You shouldn't be
  134 +concerned with this argument, its only used internally and will probably go away
  135 +in the future. It indicates whether the bundle is a theme or a simple plugin.
136 136  
137   -You can use this `bundle` command not just from your `.zshrc`, but also from
138   -your shell environment. This allows you to install plugins on the fly and try
139   -them out. Of course if you want a bundle to be available every time you open a
140   -shell, put it in your `.zshrc`.
  137 +You can use this `antigen-bundle` command not just from your `.zshrc`, but also
  138 +from your shell environment. This allows you to install plugins on the fly and
  139 +try them out. Of course if you want a bundle to be available every time you open
  140 +a shell, put it in your `.zshrc`.
141 141  
142   -## bundle-update
  142 +## antigen-update
143 143  
144 144 This is something you might not want to put in your `.zshrc`. Instead, run it
145 145 occasionally to update all your plugins. It doesn't take any arguments.
146 146  
147   - bundle-update
  147 + antigen-update
148 148  
149 149 Please note that the updates that are downloaded are not immediately available.
150 150 You have to open a new shell to be able to see the changes. This is a limitation
... ... @@ -152,7 +152,10 @@ by design since reloading all the plugins *might* have some nasty side effects
152 152 that may not be immediately apparent. Let's just say it can make your shell act
153 153 real quirky.
154 154  
155   -## bundle-list
  155 +**Please note**: This command is not for updating *antigen* itself. Its for
  156 +updating the bundles you are using with antigen.
  157 +
  158 +## antigen-list
156 159  
157 160 Use this command to list out the currently *loaded* plugins. Keep in mind that
158 161 this includes any bundles installed on-the-fly.
... ... @@ -160,7 +163,7 @@ this includes any bundles installed on-the-fly.
160 163 Takes no arguments. Gives out the repo url and the plugin's location under the
161 164 repo.
162 165  
163   -## bundle-cleanup
  166 +## antigen-cleanup
164 167  
165 168 Used to clean up the clones of repos which are not used by any plugins. It takes
166 169 no arguments. When this is run, it lists out the repo-clones that are available
... ... @@ -169,33 +172,34 @@ but are not used by any plugin *currently loaded*.
169 172 This command currently cannot run in a non-interactive mode. So it won't be very
170 173 pleasant to use it in your `.zshrc`.
171 174  
172   -## bundle-lib
  175 +## antigen-lib
173 176  
174 177 This is a shortcut to
175 178  
176   - bundle --loc=lib
  179 + antigen-bundle --loc=lib
177 180  
178 181 So, it basically installs the oh-my-zsh's library as a bundle. Please note that
179 182 this assumes that the `ANTIGEN_DEFAULT_REPO_URL` is set to the oh-my-zsh repo or
180 183 a fork of that repo. If you want to specify the `url` too, then you can't use
181   -the `bundle-lib` short cut. You have to do that directly with the `bundle`
182   -command.
  184 +the `antigen-lib` short cut. You have to do that directly with the
  185 +`antigen-bundle` command.
183 186  
184 187 This is present only for legacy reasons and *might* (or might not) be removed in
185 188 the future.
186 189  
187 190 Use
188 191  
189   - bundle-lib
  192 + antigen-lib
190 193  
191   -in your `.zshrc`, before any `bundle` declarations. It takes no arguments.
  194 +in your `.zshrc`, before any `antigen-bundle` declarations. It takes no
  195 +arguments.
192 196  
193   -## bundle-theme
  197 +## antigen-theme
194 198  
195 199 Used for switching the prompt theme. Invoke it with the name of the theme you
196 200 want to use.
197 201  
198   - bundle-theme fox
  202 + antigen-theme fox
199 203  
200 204 Currently, themes are pulled from robbyrussell's oh-my-zsh repo, but it will
201 205 support getting themes from other repos as well in the future.
... ... @@ -203,7 +207,7 @@ support getting themes from other repos as well in the future.
203 207 You can use this command to change your theme on the fly in your shell. Go on,
204 208 try out a few themes in your shell before you set it in your `.zshrc`.
205 209  
206   -## bundle-apply
  210 +## antigen-apply
207 211  
208 212 You have to add this command after defining all bundles you need, in your zshrc.
209 213 The completions defined by your bundles will be loaded at this step.
... ... @@ -70,7 +70,7 @@ antigen-bundles () {
70 70 done
71 71 }
72 72  
73   -antigen-bundle-update () {
  73 +antigen-update () {
74 74 # Update your bundles, i.e., `git pull` in all the plugin repos.
75 75 -antigen-echo-record | awk '{print $1}' | sort -u | while read url; do
76 76 -antigen-ensure-repo --update "$url"