- Notifications
You must be signed in to change notification settings - Fork1.9k
🌺 Minimalist Vim Plugin Manager
License
junegunn/vim-plug
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A minimalist Vim plugin manager.
- Minimalist design
- Just one file with no dependencies. Super easy to set up.
- Concise, intuitive syntax that you can learn within minutes. No boilerplate code required.
- No feature bloat
- Extremely stable with flawless backward compatibility
- Works perfectly with all versions of Vim since 2006 and all versions of Neovim ever released
- Super-fast parallel installation/update
- Creates shallow clones to minimize disk space usage and download time
- On-demand loading forfaster startup time
- Can review and rollback updates
- Branch/tag/commit support
- Post-update hooks
- Support for externally managed plugins
Download plug.vimand put it in the "autoload" directory.
Click to see the instructions
curl -fLo~/.vim/autoload/plug.vim --create-dirs \ https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vimYou can automate the process by putting the command in your Vim configurationfile as suggestedhere.
iwr-useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim|` ni$HOME/vimfiles/autoload/plug.vim-Force
sh -c'curl -fLo "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/autoload/plug.vim --create-dirs \ https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
curl -fLo~/.var/app/io.neovim.nvim/data/nvim/site/autoload/plug.vim --create-dirs \ https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vimiwr-useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim|` ni"$(@($env:XDG_DATA_HOME,$env:LOCALAPPDATA)[$null-eq$env:XDG_DATA_HOME])/nvim-data/site/autoload/plug.vim"-Force
Add a vim-plug section to your~/.vimrc (or~/.config/nvim/init.vim for Neovim)
- Begin the section with
call plug#begin() - List the plugins with
Plugcommands - End the section with
call plug#end()
For example,
callplug#begin()" List your plugins herePlug'tpope/vim-sensible'callplug#end()
Reload the file or restart Vim, then you can,
:PlugInstallto install the plugins:PlugUpdateto install or update the plugins:PlugDiffto review the changes from the last update:PlugCleanto remove plugins no longer in the list
Note
That's basically all you need to know to get started. The rest of thedocument is for advanced users who want to know more about the features andoptions.
Tip
plug#end() automatically executesfiletype plugin indent on andsyntax enable. We believe this is a good default for most users, but if you don'twant this behavior, you can revert the settings after the call.
callplug#end()filetypeindentoff" Disable file-type-specific indentationsyntaxoff" Disable syntax highlighting
- Seetutorial page to learn more about the basics of vim-plug
- Seetips andFAQ pages for common problems and questions
The following examples demonstrate the additional features of vim-plug.
callplug#begin()" The default plugin directory will be as follows:" - Vim (Linux/macOS): '~/.vim/plugged'" - Vim (Windows): '~/vimfiles/plugged'" - Neovim (Linux/macOS/Windows): stdpath('data') . '/plugged'" You can specify a custom plugin directory by passing it as the argument" - e.g. `call plug#begin('~/.vim/plugged')`" - Avoid using standard Vim directory names like 'plugin'" Make sure you use single quotes" Shorthand notation for GitHub; translates to https://github.com/junegunn/seoul256.vim.gitPlug'junegunn/seoul256.vim'" Any valid git URL is allowedPlug'https://github.com/junegunn/vim-easy-align.git'" Using a tagged release; wildcard allowed (requires git 1.9.2 or above)Plug'fatih/vim-go', {'tag':'*' }" Using a non-default branchPlug'neoclide/coc.nvim', {'branch':'release' }" Use 'dir' option to install plugin in a non-default directoryPlug'junegunn/fzf', {'dir':'~/.fzf' }" Post-update hook: run a shell command after installing or updating the pluginPlug'junegunn/fzf', {'dir':'~/.fzf','do':'./install --all' }" Post-update hook can be a lambda expressionPlug'junegunn/fzf', {'do': {->fzf#install() } }" If the vim plugin is in a subdirectory, use 'rtp' option to specify its pathPlug'nsf/gocode', {'rtp':'vim' }" On-demand loading: loaded when the specified command is executedPlug'preservim/nerdtree', {'on':'NERDTreeToggle' }" On-demand loading: loaded when a file with a specific file type is openedPlug'tpope/vim-fireplace', {'for':'clojure' }" Unmanaged plugin (manually installed and updated)Plug'~/my-prototype-plugin'" Call plug#end to update &runtimepath and initialize the plugin system." - It automatically executes `filetype plugin indent on` and `syntax enable`callplug#end()" You can revert the settings after the call like so:" filetype indent off " Disable file-type-specific indentation" syntax off " Disable syntax highlighting" Color schemes should be loaded after plug#end()." We prepend it with 'silent!' to ignore errors when it's not yet installed.silent!colorscheme seoul256
In Neovim, you can write your configuration in a Lua script file namedinit.lua. The following code is the Lua script equivalent to the Vim scriptexample above.
localvim=vimlocalPlug=vim.fn['plug#']vim.call('plug#begin')-- Shorthand notation for GitHub; translates to https://github.com/junegunn/seoul256.vim.gitPlug('junegunn/seoul256.vim')-- Any valid git URL is allowedPlug('https://github.com/junegunn/vim-easy-align.git')-- Using a tagged release; wildcard allowed (requires git 1.9.2 or above)Plug('fatih/vim-go', { ['tag']='*'})-- Using a non-default branchPlug('neoclide/coc.nvim', { ['branch']='release'})-- Use 'dir' option to install plugin in a non-default directoryPlug('junegunn/fzf', { ['dir']='~/.fzf'})-- Post-update hook: run a shell command after installing or updating the pluginPlug('junegunn/fzf', { ['dir']='~/.fzf', ['do']='./install --all'})-- Post-update hook can be a lambda expressionPlug('junegunn/fzf', { ['do']=function()vim.fn['fzf#install']()end })-- If the vim plugin is in a subdirectory, use 'rtp' option to specify its pathPlug('nsf/gocode', { ['rtp']='vim'})-- On-demand loading: loaded when the specified command is executedPlug('preservim/nerdtree', { ['on']='NERDTreeToggle'})-- On-demand loading: loaded when a file with a specific file type is openedPlug('tpope/vim-fireplace', { ['for']='clojure'})-- Unmanaged plugin (manually installed and updated)Plug('~/my-prototype-plugin')vim.call('plug#end')-- Color schemes should be loaded after plug#end().-- We prepend it with 'silent!' to ignore errors when it's not yet installed.vim.cmd('silent! colorscheme seoul256')
| Command | Description |
|---|---|
PlugInstall [name ...] [#threads] | Install plugins |
PlugUpdate [name ...] [#threads] | Install or update plugins |
PlugClean[!] | Remove unlisted plugins (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 |
| 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 remove and do not update unless explicitly specified |
| 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 | -tabnew | Command to open plug window |
g:plug_pwindow | vertical rightbelow new | Command to open preview window inPlugDiff |
g:plug_url_format | https://git::@github.com/%s.git | printf format to build repo URL (Only applies to the subsequentPlug commands) |
D-PlugDiffS-PlugStatusR- Retry failed update or installation tasksU- Update plugins in the selected rangeq- Abort the running tasks or close the window:PlugStatusL- Load plugin
:PlugDiffX- Revert the update
There are some plugins that require extra steps after installation or update.In that case, use thedo option to describe the task to be performed.
Plug'Shougo/vimproc.vim', {'do':'make' }Plug'ycm-core/YouCompleteMe', {'do':'./install.py' }
If the value starts with:, it will be recognized as a Vim command.
Plug'fatih/vim-go', {'do':':GoInstallBinaries' }
To call a Vim function, you can pass a lambda expression like so:
Plug'junegunn/fzf', {'do': {->fzf#install() } }
If you need more control, you can pass a reference to a Vim function thattakes a dictionary 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!ifa:info.status=='installed'||a:info.force!./install.pyendifendfunctionPlug'ycm-core/YouCompleteMe', {'do':function('BuildYCM') }
A post-update hook is executed inside the directory of the plugin and only runwhen the repository has changed, but you can force it to run unconditionallywith the bang-versions of the commands:PlugInstall! andPlugUpdate!.
Tip
Make sure to escape BARs and double-quotes when you write thedo optioninline as they are mistakenly recognized as command separator or the start ofthe trailing comment.
Plug'junegunn/fzf', {'do':'yes \| ./install' }
But you can avoid the escaping if you extract the inline specification using avariable (or any Vim script expression) as follows:
letg:fzf_install='yes | ./install'Plug'junegunn/fzf', {'do':g:fzf_install }
The installer takes the following steps when installing/updating a plugin:
git cloneorgit fetchfrom its origin- Check out branch, tag, or commit and optionally
git mergeremote branch - If the plugin was updated (or installed for the first time)
- Update submodules
- Execute post-update hooks
The commands with the! suffix ensure that all steps are run unconditionally.
" NERD tree will be loaded on the first invocation of NERDTreeToggle commandPlug'preservim/nerdtree', {'on':'NERDTreeToggle' }" Multiple commandsPlug'junegunn/vim-github-dashboard', {'on': ['GHDashboard','GHActivity'] }" Loaded when clojure file is openedPlug'tpope/vim-fireplace', {'for':'clojure' }" Multiple file typesPlug'kovisoft/paredit', {'for': ['clojure','scheme'] }" On-demand loading on both conditionsPlug'junegunn/vader.vim', {'on':'Vader','for':'vader' }" Code to execute when the plugin is lazily loaded on demandPlug'junegunn/goyo.vim', {'for':'markdown' }autocmd!User goyo.vimechom'Goyo is now loaded!'
Note
You probably don't need to.
A properly implemented Vim plugin should already load lazily without anyhelp from a plugin manager (:help autoload). So there are few cases wherethese options actually make much sense. Making a plugin load faster isthe responsibility of the plugin developer, not the user. If you finda plugin that takes too long to load, consider opening an issue on theplugin's issue tracker.
Let me give you a perspective. The time it takes to load a plugin is usuallyless than 2 or 3ms on modern computers. So unless you use a very largenumber of plugins, you are unlikely to save more than 50ms. If you havespent an hour carefully setting up the options to shave off 50ms, youwill have to start Vim 72,000 times just to break even. You should askyourself if that's a good investment of your time.
Make sure that you're tackling the right problem by breaking down thestartup time of Vim using--startuptime.
vim --startuptime /tmp/log
On-demand loading should only be used as a last resort. It is basicallya hacky workaround and is not always guaranteed to work.
Tip
You can pass an empty list toon orfor option to disable the loadingof the plugin. You can manually load the plugin usingplug#load(NAMES...)function.
Seehttps://github.com/junegunn/vim-plug/wiki/tips#loading-plugins-manually
- Jan Edmund Lazo - Windows support
- Jeremy Pallats - Python installer
MIT
About
🌺 Minimalist Vim Plugin Manager