vimpire / README.rst

Alpha software! Like, alpha alpha, you know ;)

This is a script that manages plugins hosted on git or hg and make them available to pathogen, so it make your vim ever the more awesome!

First off, this script assumes you have a file called vimrc in your dotvim directory, which might as well be linked to your ~/.vimrc file. In that file, put lines like the following, (one for each plugin you want):

" Bundle: git://

Note: You'll anyway need the above line at least, you of course need pathogen, silly. Note: You can get github links from for plugins that don't offer sane deployment options.

Add any number such bundle lines with various plugins. Vimpire will try to guess the vcs from git or hg, and is correct most of the time, but if you want to specify it yourself, do so as:

" Bundle: my-strange-url-from-which-no-one-can-tell-the-vcs with git

There, that with git in the end is what tells Vimpire what vcs to use. Neat eh?

You can also decide what folder the plugin will be cloned to, by using the to option in a similar way to the with option as described above. For example,:

" Bundle: git:// to super-plugin

And this will cause the pathogen plugin to be cloned to bundle/super-plugin instead of bundle/vim-pathogen.

If, for some reason, you don't want to pull/fetch, but clone every time instead, you can add force clone to the end of the bundle line. This is useful, if you are messing up the plugin's directory using the commands in Run directives, described below.

And of course, you can have a line with both the with and the to options, along with any other that might be added in the future ;).

Now, navigate to your vimfiles or dotvim directory and do:

$ wget $

You may also include a Run directive below the Bundle directive to run a command after getting/updating the corresponding bundle. Note that this command will be run with the plugin's directory as the pwd. For example, to compile Command-T plugin,:

" Bundle: git:// " Run: cd ruby/command-t
" Run: ruby extconf.rb && make

Note: If a run directive points to a cd command, like the 2nd line above, it is not sent to the shell. It is natively interpreted by vimpire, and does NOT have all the advanced functionality of the cd command in a shell. So, things like cd - do not work. This should not affect for most users, though.

If a bundle entry is deleted, or a directory exists in the bundle directory, without a corresponding entry in the vimrc file, it will be deleted. Deleting plugins is still experimental, but if it does not work, you may manually delete the plugin directory in the bundle directory.

Report any issues whatsoever :)