/vundle

Vundle, the plug-in manager for Vim

Primary LanguageVimLMIT LicenseMIT

About

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

Vundle-installer

Quick start

  1. Set up Vundle:

    $ git clone https://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/'}
    Bundle 'tpope/vim-rails.git'
    " vim-scripts repos
    Bundle 'L9'
    Bundle 'FuzzyFinder'
    " non-GitHub repos
    Bundle 'git://git.wincent.com/command-t.git'
    " Git repos on your local machine (i.e. when working on your own plugin)
    Bundle 'file:///Users/gmarik/path/to/plugin'
    " ...
    
    filetype plugin indent on     " required!
    "
    " Brief help
    " :BundleList          - list configured bundles
    " :BundleInstall(!)    - install (update) bundles
    " :BundleSearch(!) foo - search (or refresh cache first) for foo
    " :BundleClean(!)      - confirm (or auto-approve) removal of unused bundles
    "
    " see :h vundle for more details or wiki for FAQ
    " NOTE: comments after Bundle commands are not allowed.
  3. Install configured bundles:

    Launch vim, run :BundleInstall (or vim +BundleInstall +qall for CLI lovers)

    Windows users: see Vundle for Windows

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

  4. Consider donating

    Thank you for supporting this project!

Why Vundle

Vundle allows you to:

Vundle also:

Docs

See the :h vundle Vimdoc for more details.

People using Vundle

see Examples

FAQ

see the wiki

Contributors

see Vundle contributors

Thank you!

Inspiration and ideas from

Also

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

TODO:

Vundle is a work in progress, so any ideas and patches are appreciated.

  • ✓ activate newly added bundles on .vimrc reload or after :BundleInstall
  • ✓ use preview window for search results
  • ✓ Vim documentation
  • ✓ put Vundle in bundles/ too (will fix Vundle help)
  • ✓ tests
  • ✓ improve error handling
  • allow specifying revision/version?
  • handle dependencies
  • show description in search results
  • search by description as well
  • make it rock!