Vundle is short for Vim bundle and is a Vim plugin manager.
Vundle allows you to...
- keep track of and configure your plugins right in the
.vimrc - install configured plugins (a.k.a. scripts/bundle)
- update configured plugins
- search by name all available Vim scripts
- clean unused plugins up
- run the above actions in a single keypress with interactive mode
Vundle automatically...
- manages the runtime path of your installed scripts
- regenerates help tags after installing and updating
Vundle is undergoing an interface change, please stay up to date to get latest changes.
Introduction:
Installation requires Git and triggers
git clonefor each configured repository to~/.vim/bundle/by default. Curl is required for search.If you are using Windows, go directly to Windows setup. If you run into any issues, please consult the FAQ.
Set up Vundle:
$ git clone https://github.com/gmarik/vundle.git ~/.vim/bundle/vundleConfigure Plugins:
Put this at the top of your
.vimrcto use Vundle. Remove plugins you don't need, they are for illustration purposes.setnocompatible" be iMproved, requiredfiletypeoff" required" set the runtime path to include Vundle and initializesetrtp+=~/.vim/bundle/vundle/callvundle#rc() " alternatively, pass a path where Vundle should install plugins"let path = '~/some/path/here'"call vundle#rc(path)" let Vundle manage Vundle, requiredPlugin'gmarik/vundle'" The following are examples of different formats supported." Keep Plugin commands between here and filetype plugin indent on." scripts on GitHub reposPlugin'tpope/vim-fugitive'Plugin'Lokaltog/vim-easymotion'Plugin'tpope/vim-rails.git'" The sparkup vim script is in a subdirectory of this repo called vim." Pass the path to set the runtimepath inside the repo properly.Plugin'rstacruz/sparkup', {'rtp': 'vim/'} " Pass the path to set the plugin's runtimepath dir.Plugin'joonty/vim-sauce', {'bundle_dir' : '~/plugin_dir/'} Plugin'tpope/vim-fugitive'" Invalid a Plugin Unplug 'tpope/vim-fugitive'" scripts from http://vim-scripts.org/vim/scripts.htmlPlugin'L9'Plugin'FuzzyFinder'" scripts not on GitHubPlugin'git://git.wincent.com/command-t.git'" git repos on your local machine (i.e. when working on your own plugin)Plugin'file:///home/gmarik/path/to/plugin'" ...filetypepluginindenton" required" To ignore plugin indent changes, instead use:"filetype plugin on"" Brief help" :PluginList - list configured plugins" :PluginInstall(!) - install (update) plugins" :PluginSearch(!) foo - search (or refresh cache first) for foo" :PluginClean(!) - confirm (or auto-approve) removal of unused plugins"" see :h vundle for more details or wiki for FAQ" NOTE: comments after Plugin commands are not allowed." Put your stuff after this line
Install Plugins:
Launch
vimand run:PluginInstallTo install from command line:
vim +PluginInstall +qall
See the :h vundle Vimdoc for more details.
see Examples
Thank you!
- Vundle was developed and tested with Vim 7.3 on OS X, Linux and Windows
- Vundle tries to be as KISS as possible
Vundle is 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 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!
