vundle/README.md

About

Vundle is a short cut for Vimbundle and is a small plugin for managing Vim plugins.

Why

Vundle allows to:

• keep track and configure your scripts right in .vimrc
• install configured scripts (aka bundle)
• manage runtime path of your installed scripts so you don't have to
• search all available vim scripts by name
• clean up from unused scripts

Vundle takes advantage of vim-scripts.org in order to install/search all available vim scripts

How

1. Setup Vundle:

    git clone http://github.com/gmarik/vundle.git ~/.vim/vundle.git
   

2. Configure bundles:

   Append to your ~/.vimrc:

    set rtp+=~/.vim/vundle.git/ 
    call vundle#rc()
   
    " Bundles:
    Bundle "L9"
    Bundle "FuzzyFinder"
    Bundle "rails.vim"
    Bundle "ack.vim"
    Bundle "git://git.wincent.com/command-t.git"
    " ...
   

3. Install configured bundles:

   Launch vim, run :BundleInstall (no Vim restart required since v0.5)

   Installing requires Git and triggers Git clone for each configured repo to ~/.vim/bundle/.

Script installation

BundleInstall installs script only if it hasn't been already installed. BundleInstall is faster than BundleInstall! (note bang at the end) because latter fetches scripts without any checks. Use BundleInstall to install new scripts. Use BundleInstall! to update scripts.

Searching

:BundleSearch foo

lists search results in new split window, ie:

Bundle "VimFootnotes"
Bundle "foo.vim"

so you can just copy ones you need to .vimrc.

:BundleSearch! foo

refreshes script list before performing actual search.

Searching requires curl

Cleaning up

:BundleClean

confirms removal of unused script dirs from your .vim/bundle. BundleClean! does that silently.

Examples

See gmarik's vimrc for working example.

Inspiration and ideas from

• pathogen
• bundler
• Scott Bronson

TODO:

Vundle is a work in progress so any ideas/patches appreciated

• √ activate newly added bundles on .vimrc reload or after :BundleInstall
• √ use preview window for search results
• improve error handling
• allow specify revision/version?
• search by description aswell
• show descrption in search results
• instead sourcing .vimrc before installation come up with another solution
• documentation
• tests
• make it rock!