vim-plug

:hibiscus: Minimalist Vim Plugin Manager

Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star blank 374f33e4d622a2930833db3cbea26b5d03dc44961a6ecab0b9e13276d97d6682Star blank 374f33e4d622a2930833db3cbea26b5d03dc44961a6ecab0b9e13276d97d6682 (1 ratings)
Rated 3.0 out of 5
Subscribe to updates I use vim-plug


Statistics on vim-plug

Number of watchers on Github 10145
Number of open issues 44
Average time to close an issue 4 days
Main language VimL
Average time to merge a PR 1 day
Open pull requests 20+
Closed pull requests 30+
Last commit 7 months ago
Repo Created about 5 years ago
Repo Last Updated 6 months ago
Size 8.43 MB
Organization / Authorjunegunn
Latest Release0.9.1
Contributors21
Page Updated
Do you use vim-plug? Leave a review!
View open issues (44)
View vim-plug activity
View on github
Latest Open Source Launches
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating vim-plug for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)
What people are saying about vim-plug Leave a review
I can't install it correctly

vim-plugtravis-ci

A minimalist Vim plugin manager.

Pros.

  • Easier to setup: Single file. No boilerplate code required.
  • Easier to use: Concise, intuitive syntax
  • Super-fast parallel installation/update (with any of +job, +python, +python3, +ruby, or Neovim)
  • Creates shallow clones to minimize disk space usage and download time
  • On-demand loading for faster startup time
  • Can review and rollback updates
  • Branch/tag/commit support
  • Post-update hooks
  • Support for externally managed plugins

Installation

Download plug.vim and put it in the autoload directory.

Vim

Unix
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
    https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim

You can automate the process by putting the command in your Vim configuration file as suggested here.

Windows (PowerShell)
md ~\vimfiles\autoload
$uri = 'https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
(New-Object Net.WebClient).DownloadFile(
  $uri,
  $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath(
    "~\vimfiles\autoload\plug.vim"
  )
)

Neovim

Unix
curl -fLo ~/.local/share/nvim/site/autoload/plug.vim --create-dirs \
    https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
Windows (PowerShell)
md ~\AppData\Local\nvim\autoload
$uri = 'https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
(New-Object Net.WebClient).DownloadFile(
  $uri,
  $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath(
    "~\AppData\Local\nvim\autoload\plug.vim"
  )
)

Getting Help

  • See tutorial page to learn the basics of vim-plug
  • See tips and FAQ pages for common problems and questions
  • See requirements page for debugging information & tested configurations
  • Create an issue

Usage

Add a vim-plug section to your ~/.vimrc (or ~/.config/nvim/init.vim for Neovim):

  1. Begin the section with call plug#begin()
  2. List the plugins with Plug commands
  3. call plug#end() to update &runtimepath and initialize plugin system
    • Automatically executes filetype plugin indent on and syntax enable. You can revert the settings after the call. e.g. filetype indent off, syntax off, etc.

Example

" Specify a directory for plugins
" - For Neovim: ~/.local/share/nvim/plugged
" - Avoid using standard Vim directory names like 'plugin'
call plug#begin('~/.vim/plugged')

" Make sure you use single quotes

" Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
Plug 'junegunn/vim-easy-align'

" Any valid git URL is allowed
Plug 'https://github.com/junegunn/vim-github-dashboard.git'

" Multiple Plug commands can be written in a single line using | separators
Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'

" On-demand loading
Plug 'scrooloose/nerdtree', { 'on':  'NERDTreeToggle' }
Plug 'tpope/vim-fireplace', { 'for': 'clojure' }

" Using a non-master branch
Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' }

" Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
Plug 'fatih/vim-go', { 'tag': '*' }

" Plugin options
Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }

" Plugin outside ~/.vim/plugged with post-update hook
Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }

" Unmanaged plugin (manually installed and updated)
Plug '~/my-prototype-plugin'

" Initialize plugin system
call plug#end()

Reload .vimrc and :PlugInstall to install plugins.

Commands

Command Description
PlugInstall [name ...] [#threads] Install plugins
PlugUpdate [name ...] [#threads] Install or update plugins
PlugClean[!] Remove unused directories (bang version will clean without prompt)
PlugUpgrade Upgrade vim-plug itself
PlugStatus Check the status of plugins
PlugDiff Examine changes from the previous update and the pending changes
PlugSnapshot[!] [output path] Generate script for restoring the current snapshot of the plugins

Plug options

Option Description
branch/tag/commit Branch/tag/commit of the repository to use
rtp Subdirectory that contains Vim plugin
dir Custom directory for the plugin
as Use different name for the plugin
do Post-update hook (string or funcref)
on On-demand loading: Commands or <Plug>-mappings
for On-demand loading: File types
frozen Do not update unless explicitly specified

Global options

Flag Default Description
g:plug_threads 16 Default number of threads to use
g:plug_timeout 60 Time limit of each task in seconds (Ruby & Python)
g:plug_retries 2 Number of retries in case of timeout (Ruby & Python)
g:plug_shallow 1 Use shallow clone
g:plug_window vertical topleft new Command to open plug window
g:plug_pwindow above 12new Command to open preview window in PlugDiff
g:plug_url_format https://git::@github.com/%s.git printf format to build repo URL (Only applies to the subsequent Plug commands)

Keybindings

  • D - PlugDiff
  • S - PlugStatus
  • R - Retry failed update or installation tasks
  • U - Update plugins in the selected range
  • q - Close the window
  • :PlugStatus
    • L - Load plugin
  • :PlugDiff
    • X - Revert the update

Example: A small sensible Vim configuration

call plug#begin()
Plug 'tpope/vim-sensible'
call plug#end()

On-demand loading of plugins

" NERD tree will be loaded on the first invocation of NERDTreeToggle command
Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }

" Multiple commands
Plug 'junegunn/vim-github-dashboard', { 'on': ['GHDashboard', 'GHActivity'] }

" Loaded when clojure file is opened
Plug 'tpope/vim-fireplace', { 'for': 'clojure' }

" Multiple file types
Plug 'kovisoft/paredit', { 'for': ['clojure', 'scheme'] }

" On-demand loading on both conditions
Plug 'junegunn/vader.vim',  { 'on': 'Vader', 'for': 'vader' }

" Code to execute when the plugin is lazily loaded on demand
Plug 'junegunn/goyo.vim', { 'for': 'markdown' }
autocmd! User goyo.vim echom 'Goyo is now loaded!'

for option is generally not needed as most plugins for specific file types usually don't have too much code in plugin directory. You might want to examine the output of vim --startuptime before applying the option.

Post-update hooks

There are some plugins that require extra steps after installation or update. In that case, use do option to describe the task to be performed.

Plug 'Shougo/vimproc.vim', { 'do': 'make' }
Plug 'Valloric/YouCompleteMe', { 'do': './install.py' }

If the value starts with :, it will be recognized as a Vim command.

Plug 'fatih/vim-go', { 'do': ':GoInstallBinaries' }

If you need more control, you can pass a reference to a Vim function that takes a single argument.

function! BuildYCM(info)
  " info is a dictionary with 3 fields
  " - name:   name of the plugin
  " - status: 'installed', 'updated', or 'unchanged'
  " - force:  set on PlugInstall! or PlugUpdate!
  if a:info.status == 'installed' || a:info.force
    !./install.py
  endif
endfunction

Plug 'Valloric/YouCompleteMe', { 'do': function('BuildYCM') }

Both forms of post-update hook are executed inside the directory of the plugin and only run when the repository has changed, but you can force it to run unconditionally with the bang-versions of the commands: PlugInstall! and PlugUpdate!.

Make sure to escape BARs and double-quotes when you write do option inline as they are mistakenly recognized as command separator or the start of the trailing comment.

Plug 'junegunn/fzf', { 'do': 'yes \| ./install' }

But you can avoid the escaping if you extract the inline specification using a variable (or any Vimscript expression) as follows:

let g:fzf_install = 'yes | ./install'
Plug 'junegunn/fzf', { 'do': g:fzf_install }

PlugInstall! and PlugUpdate!

The installer takes the following steps when installing/updating a plugin:

  1. git clone or git fetch from its origin
  2. Check out branch, tag, or commit and optionally git merge remote branch
  3. If the plugin was updated (or installed for the first time)
    1. Update submodules
    2. Execute post-update hooks

The commands with ! suffix ensure that all steps are run unconditionally.

Articles

License

MIT

vim-plug open issues Ask a question     (View All Issues)
  • almost 2 years Noticed removal of plugfile support has any progress been made in terms of plugin dependencies?
  • almost 2 years MacVim becomes unresponsive for parallel Update/installs
  • almost 2 years Use `--shallow-submodules` on git 2.9.0 or above
  • almost 2 years PlugInstall breaks if Vim started from Git-for-Windows (MSYS2)
  • about 2 years Shallow clones of submodules
  • about 2 years superfrozen feature to prevent also installation
  • about 2 years Cannot install or update jedi-vim
  • about 2 years Installing plugins over ssh gives error E440
  • over 2 years Notify about available plugin updates and vim-plug upgrade
  • over 2 years vim-plug timeout on Linux subsystem (beta), Windows 10
  • over 2 years vim-plug fails to PlugUpdate if no master branch exists
  • over 2 years Plans for using native plugin manager when available?
  • over 2 years Vim-plug should quit when it's the last open window
  • over 2 years autocmd User sometimes doesn't work?
  • over 2 years PlugInstall parallel install on Neovim Windows does nothing
  • almost 3 years On new plugin install, display gets stuck on "Cloning into..."
  • almost 3 years Add global option to disable .old backup file
  • over 3 years Neovim Possibly Including vim-plug
  • over 3 years Travis Spends Most Time Building Vim
  • almost 4 years Handle Remote Plugins for neovim.
  • about 4 years Parallel installer on Windows GVim does not show progress
vim-plug open pull requests (View All Pulls)
  • Fix #416: Add an issue and PR template.
  • Refactor duplicate logic in installers
  • support do vim command
  • Fix install plugins in Cygwin or MSYS2 vim with enabled git core.auto…
  • Add option to disable automatic submodule pulling
  • Deferred loading on autocmd (#event[#pattern])
  • Display not-loaded status with all plugins that have a dir
  • git_validate: better error with checkout being ahead/diverged
  • use job for s:system() on vim8
  • tests: harden/fix closing/counting of windows
  • Improve tests
  • s:dobufread: use count with finddir
  • Handle new "Already up to date" msg from Git
  • Travis: rename vim72 to vim74
  • Clarify the usage instructions
  • Fetch all tags if there is `tag` spec.
  • Use s:path with s:rtp always
  • Do not trigger filetypeindent/filetypeplugin autocmds by default
  • Add a note to the installation section about following the usage section
  • Make directions a little more explicit
vim-plug questions on Stackoverflow (View All Questions)
  • Can't install vim-plug
  • Error when running any vim-plug command
  • Vim plug-in that enables <C-S-CR> for openning arbitray link/address, regardelss of http-address or directory?
  • Is there a Vim plug-in similar to fuzzyfinder_textmate and Command-T which does _not_ require Ruby support?
  • Vim Plug-ins for debugging Ruby 2.0.0?
  • Is there any Vim plug-in that can show the file hierarchy?
vim-plug list of languages used
vim-plug latest release notes
0.9.1 0.9.1

Notable changes

  • Interactive PlugClean using d-operator
    • dd, dip, ...
  • g:plug_pwindow for customizing preview window layout (PlugDiff)
  let g:plug_window = '-tabnew'
  let g:plug_pwindow = 'vertical rightbelow new'
  • Added support for { 'do': ':VimCommand' } notation
    • e.g. Plug 'fatih/vim-go', { 'do': ':GoInstallBinaries' }
  • Plug command exported as plug# function
    • e.g. call plug#('junegunn/seoul256.vim')
0.9.0 0.9.0

:PlugUpgrade to get the latest vim-plug.

Thanks to all that have contributed to vim-plug (listed in alphabetical order).

  • @beatrupp
  • @hobarrera
  • @itspriddle
  • @simonweil
  • @srstevenson
  • @starcraftman
  • @yous

Notable changes

  • #476 Support wildcards in tag option (Junegunn Choi)
    • ProTip: { 'tag: '*' } will point to the latest tagged release
  • #463 Make Plug{Install,Update}! trigger post-fetch checkout, submodule update (Chayoung You)
    • Use PlugInstall! to switch branches or tags without contacting the remote
    • Also can be used for retrying failed submodule update
  • #462 Detect plugins that are diverged from their origins (Junegunn Choi)
    • PlugStatus will detect such plugins and PlugClean will try to remove them
  • #428 PlugDiff to include graphical representation of commit history (Junegunn Choi)
  • #371 Add as option (Junegunn Choi)
    • Used to resolve name conflict

Bug fixes and improvements

  • #474 Load ftdetect files in filetypedetect augroup (Junegunn Choi)
  • #460 Fall back to Python installer if Ruby is broken (Junegunn Choi)
  • #459 Clear message on retry (Junegunn Choi)
  • #455 git config should read local .git/config instead of $GIT_CONFIG (Junegunn Choi)
  • Use on User autocmd if possible (Junegunn Choi)
  • #451 Reset colors for git show (Simon Weil)
  • #430 Refactor duplicate logic in installers (Junegunn Choi)
  • #445 Remove redundant checks of git --version in Neovim installer (Junegunn Choi)
  • #439 Do not proceed if getcwd() returns an empty string (Junegunn Choi)
  • #434 Use runtime to load syntax file during ft-based ODL (Junegunn Choi)
  • #419 Avoid multiple syntax enable during Vim startup (Joshua Priddle)
  • #410 Do not load irrelevant syntax files (Junegunn Choi)
  • #407 Rename script-local function to generate better error message (Junegunn Choi)
  • #394 Disable mappings during update (Jeremy Pallats/starcraft.man)
  • #392 Better error message when git executable is not found (Junegunn Choi)
  • #386 Only highlight vim-plug buffers if syntax enabled (Scott Stevenson)
0.8.0 0.8.0

:PlugUpgrade to get the latest vim-plug.

New features:

  • Added commit option for fine-grained version control
  • Fixed issues with parallel installer on Windows and enabled it by default

Improvements:

  • Changed PlugSnapshot to create Vim script using the new commit option
  • PlugDiff to show pending updates for plugins locked on commit or on tag
  • Enhanced output format of post-update hooks

Issues resolved:

  • Fixed Ruby installer to unshallow tagged plugin on update (#350)
  • Fixed output format of Neovim installer (#340)
  • Remapped q in plug window to bd (#336)
  • Fixed freeze in Python installer (#318)
  • Case-sensitive validation of on arguments (#314)
  • Fixed post-update hook not to run on error
  • Fixed for option to load syntax files (#272)
  • Fixed UnicodeDecodeError from Python installer (#262)
  • set nomodifiable on commit preview window (#255)

Screenshots:

  • New PlugDiff output
  • New PlugSnapshot output
  • Parallel installer on Windows (thanks to @mattn)
Other projects in VimL