Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Vundle, the plug-in manager for Vim

branch: master

Add filetype on in readme with OS X note.

Apparently the default vim in OS X will exit 1 after editing if you try to `filetype off` before you `filetype on`.
latest commit cbc6faf1bc
Mat Schaffer authored June 05, 2011
Octocat-spinner-32 autoload
Octocat-spinner-32 doc
Octocat-spinner-32 test test June 03, 2011
Octocat-spinner-32 README.md
README.md

About

Vundle is short for V**imb**undle 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 on                    " required on OS X!
     filetype off                   " required!
    
     set rtp+=~/.vim/bundle/vundle/
     call vundle#rc()
    
     " let Vundle manage Vundle
     Bundle 'gmarik/vundle'         " required! 
    
     " 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! 
     " or 
     " filetype plugin on          " to not use the indentation settings set by plugins
    
     "
     " 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
    
    
  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

  • Q Why am I asked for username/pass?

    A This is the case of invalid name used with Bundle, which leads to attempt to clone nonexistent repo:

    git clone http://github.com/gmarik/non_existin_repo
    Cloning into non_existin_repo...
    Username: 
    Password: 
    fatal: Authentication failed
    
  • Q My configuration is bundle dependant, so when I try to install plugins for the first time I get errors. How do I fix that?

    A Fix your Chicken or Egg dilemma

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!
Something went wrong with that request. Please try again.