Help Maintain Vundle

Table of Contents

• About
• Quick Start
• Docs
• Changelog
• People Using Vundle
• Contributors
• Inspiration & Ideas
• Also
• TODO

About

Vundleis short forVim bundleand is aVimplugin manager.

Vundleallows you to...

• keep track of andconfigureyour plugins right in the.vimrc
• installconfigured plugins (a.k.a. scripts/bundle)
• updateconfigured plugins
• searchby name all availableVim scripts
• cleanunused plugins up
• run the above actions in asingle keypresswithinteractive mode

Vundleautomatically...

• manages theruntime pathof your installed scripts
• regenerateshelp tagsafter installing and updating

Vundleis undergoing aninterface change,please stay up to date to get latest changes.

for discussion and support.

Quick Start

1. Introduction:

   Installation requiresGitand triggersgit clonefor each configured repository to~/.vim/bundle/by default. Curl is required for search.

   If you are using Windows, go directly toWindows setup.If you run into any issues, please consult theFAQ. SeeTipsfor some advanced configurations.

   Using non-POSIX shells, such as the popular Fish shell, requires additional setup. Please check theFAQ.

2. Set upVundle:

   git clone https://github /VundleVim/Vundle.vim.git~/.vim/bundle/Vundle.vim

3. Configure Plugins:

   Put this at the top of your.vimrcto use Vundle. You may have to create a.vimrcfile if it doesn't already exist at~/.vimrc.Remove plugins you don't need, they are for illustration purposes.

   setnocompatible"be iMproved, required
   filetypeoff"required
   
   "set the runtime path to include Vundle and initialize
   setrtp+=~/.vim/bundle/Vundle.vim
   callvundle#begin()
   "alternatively, pass a path where Vundle should install plugins
   "call vundle#begin('~/some/path/here')
   
   "let Vundle manage Vundle, required
   Plugin'VundleVim/Vundle.vim'
   
   "The following are examples of different formats supported.
   "Keep Plugin commands between vundle#begin/end.
   "plugin on GitHub repo
   Plugin'tpope/vim-fugitive'
   "plugin from http://vim-scripts.org/vim/scripts.html
   "Plugin 'L9'
   "Git plugin not hosted on GitHub
   Plugin'git://git.wincent /command-t.git'
   "git repos on your local machine (i.e. when working on your own plugin)
   Plugin'file:///home/gmarik/path/to/plugin'
   "The sparkup vim script is in a subdirectory of this repo called vim.
   "Pass the path to set the runtimepath properly.
   Plugin'rstacruz/sparkup',{'rtp':'vim/'}
   "Install L9 and avoid a Naming conflict if you've already installed a
   "different version somewhere else.
   "Plugin 'ascenator/L9', {'name': 'newL9'}
   
   "All of your Plugins must be added before the following line
   callvundle#end()"required
   filetypepluginindenton"required
   "To ignore plugin indent changes, instead use:
   "filetype plugin on
   "
   "Brief help
   ":PluginList - lists configured plugins
   ":PluginInstall - installs plugins; append `!` to update or just:PluginUpdate
   ":PluginSearch foo - searches for foo; append `!` to refresh local cache
   ":PluginClean - confirms removal of unused plugins; append `!` to auto-approve removal
   "
   "see:h vundle for more details or wiki for FAQ
   "Put your non-Plugin stuff after this line

4. Install Plugins:

   Launchvimand run:PluginInstall

   To install from command line:vim +PluginInstall +qall

5. (optional) For those using the fish shell: addset shell=/bin/bashto your.vimrc

Docs

See the:h vundleVimdoc for more details.

Changelog

See thechangelog.

People Using Vundle

seeExamples

Contributors

seeVundle contributors

Thank you!

Inspiration & Ideas

• pathogen.vim
• Bundler
• Scott Bronson

Also

• Vundle was developed and tested withVim7.3 on OS X, Linux and Windows
• Vundle tries to be asKISSas possible

TODO

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

• activate newly added bundles on.vimrcreload or after:PluginInstall
• use preview window for search results
• Vim documentation
• put Vundle inbundles/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!