Vundle.vim README

The project's README from github.com/VundleVim/Vundle.vim. As one markdown file: README.md.

Help Maintain Vundle

Table of Contents

About

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

Vundle allows you to...

Vundle automatically...

Vundle is undergoing an interface change, please stay up to date to get latest changes.

Gitter-chat for discussion and support.

Vundle-installer

Quick Start

  1. Introduction:

    Installation requires Git and triggers git clone for 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. See Tips for some advanced configurations.

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

  2. Set up Vundle:

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

  3. Configure Plugins:

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

    set nocompatible              " be iMproved, required
filetype off                  " required

" set the runtime path to include Vundle and initialize
set rtp+=~/.vim/bundle/Vundle.vim
call vundle#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.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'
" 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
call vundle#end()            " required
filetype plugin indent on    " 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:

    Launch vim and run :PluginInstall

    To install from command line: vim +PluginInstall +qall

  5. (optional) For those using the fish shell: add set shell=/bin/bash to your .vimrc

Docs

See the :h vundle Vimdoc for more details.

Changelog

See the changelog.

People Using Vundle

see Examples

Contributors

see Vundle contributors

Thank you!

Inspiration & Ideas

Also

TODO

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

Vundle.vim (VundleVim/Vundle.vim)

Searching Database…

23.9K ·GitHub
Vundle.vim
What is this?Vundle (short for Vim bundle) is a plugin manager for Vim that lets you declare plugins in your .vimrc and then install, update, search, or clean them up.
Is it a standalone app or a Vim plugin itself?It's a Vim plugin (a .vim script) that manages your other Vim plugins; there's no separate application, everything runs inside Vim.
How do I get it running?Clone Vundle with git into ~/.vim/bundle/Vundle.vim, add the Vundle setup block plus your plugin list to the top of your .vimrc, then launch Vim and run :PluginInstall (or vim +PluginInstall +qall from the command line).
Do I need anything besides Vim installed?You need Git, since every plugin install is done via git clone; Curl is additionally required if you want to use the search feature.
Any setup gotchas I should know about?Windows users should follow a separate Windows setup guide instead of the standard steps, and if you use the Fish shell you need extra configuration, typically adding set shell=/bin/bash to your .vimrc.
Does it work the same on macOS, Linux, and Windows?Yes, Vundle was developed and tested with Vim 7.3 on OS X, Linux, and Windows.
What commands does Vundle add inside Vim?It adds commands like :PluginInstall to install configured plugins, :PluginUpdate to update them, :PluginSearch to find Vim scripts by name, and :PluginClean to remove unused ones, plus an interactive mode to run all of these with a single keypress.
Does Vundle auto-reload plugins after editing .vimrc?Yes, newly added bundles are activated on .vimrc reload or after running :PluginInstall, and Vundle regenerates help tags automatically after installing or updating.
What inspired Vundle's design?It drew ideas from pathogen.vim and Bundler, and aims to be as KISS (Keep It Simple, Stupid) as possible.
Where do installed plugins actually get stored?By default, plugins are git-cloned into the ~/.vim/bundle/ directory.
What are similar projects?vim-plug, vim-pathogen, lazy.nvim, vimrc, vim-fugitive, yazi, tpm, neovim
Which topics is it in?plugin-manager, vim script, vim, package-manager, git, plugin, productivity, command-line-tool, terminal, self-hosted, cross-platform, developer-tools
Creator
VundleVim
Size
0.9 MB
Stars
23.9K
Updated
CommitJul 30
Age
15y
Commits · 90 Days