Vundle, the plug-in manager for Vim
 
gmarik c3ecda56b1 reset only on update 14 years ago
autoload invoke BundleInstallPre before actually installing 14 years ago
doc updated vim docs 14 years ago
test reset only on update 14 years ago
README.md FAQ 14 years ago

README.md

About

Vundle is a short cut for Vimbundle and is a Vim plugin manager.

Quick start

  1. Setup Vundle:

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

    Sample .vimrc:

     set nocompatible               " be iMproved
     filetype off                   " required!
    
     set rtp+=~/.vim/vundle.git/ 
     call vundle#rc()
    
     " My Bundles here:
     "
     " original repos on github
     Bundle 'tpope/vim-fugitive'
     Bundle 'lokaltog/vim-easymotion'
     Bundle 'rstacruz/sparkup', {'rtp': 'vim/'}
     " vim-scripts repos
     Bundle 'L9'
     Bundle 'FuzzyFinder'
     Bundle 'rails.vim'
     " non github repos
     Bundle 'git://git.wincent.com/command-t.git'
     " ...
    
     filetype plugin indent on     " required!
    
  3. Install configured bundles:

    Launch vim, run :BundleInstall.

    Windows users see Vundle for Windows

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

Why Vundle

Vundle allows to:

Also Vundle:

  • manages runtime path of your installed scripts
  • regenerates helptag atomatically

Docs

run :helptags ~/.vim/vundle.git/doc

see :h vundle vimdoc for more details.

Examples

See gmarik's vimrc for working example.

FAQ

  • Q i'm aked for username/pass, why? A Correct invalid bundle name. this is the case of invalid name used with Bundle, which leads to attemt to clone nonexisting repo:

      git clone http://github.com/gmarik/non_existin_repo
      Cloning into non_existin_repo...
      Username: 
      Password: 
      fatal: Authentication failed
    

Contributors

Thank you!

Inspiration and ideas from

Also

  • Vundle was developed and tested with Vim 7.3 on OSX, Linux and Windows
  • Vundle tries to be as KISS as possible

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
  • √ vim documentation
  • tests
  • improve error handling
  • put vundle to bundles/ too(will fix vundle help)
  • :VundleUpdate - self.update
  • handle dependencies
  • allow specify revision/version?
  • search by description aswell
  • show descrption in search results
  • instead sourcing .vimrc before installation come up with another solution
  • make it rock!