Go to file
2011-07-13 18:37:22 -07:00
autoload expand path 2011-06-03 18:52:04 -05:00
doc make documentation use ready 2011-05-23 16:48:15 -05:00
test test 2011-06-03 18:53:20 -05:00
README.md Fix sample easymotion uri 2011-07-13 18:37:22 -07:00

About

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

Quick start

  1. Setup Vundle:

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

    Sample .vimrc:

    set nocompatible               " be iMproved
    filetype off                   " required!
    
    set rtp+=~/.vim/bundle/vundle/
    call vundle#rc()
    
    " let Vundle manage Vundle
    " required! 
    Bundle 'gmarik/vundle'
    
    " 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! 
    "
    " Brief help
    "
    " :BundleInstall  - install bundles (won't update installed)
    " :BundleInstall! - update if installed
    "
    " :Bundles foo    - search for foo
    " :Bundles! foo   - refresh cached list and search for foo
    "
    " :BundleClean    - confirm removal of unused bundles
    " :BundleClean!   - remove without confirmation
    "
    " see :h vundle for more details
    " or wiki for FAQ
    " Note: comments after Bundle command are not allowed..
    
    
  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

see :h vundle vimdoc for more details.

Examples

See gmarik's vimrc for working example.

If you have an interesting example, feel free to send a pull request with link to your config. Thx!

FAQ

see wiki

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