krisgry / dein.vim

:zap: Dark powered Vim/Neovim plugin manager

dein.vim

About

Dein.vim is a dark powered Vim/Neovim plugin manager.

Requirements

• Vim 7.4 or above or NeoVim.
• "xcopy" command in $PATH (Windows)
• "git" command in $PATH (if you want to install github or vim.org plugins)

Quick start

Note: You must define the installation directory before to use dein. It depends on your usage. For example, "~/.vim/bundles" or "~/.cache/dein" or "~/.local/share/dein". dein.vim has not define the default installation directory. You must not set the installation directory under "~/.vim/plugin" or "~/.config/nvim/plugin".

If you are using Unix/Linux or Mac OS X.

Note: {directory} is just placeholder.

1. Run below script.

   $ curl https://raw.githubusercontent.com/Shougo/dein.vim/master/bin/installer.sh > installer.sh
   $ sh ./installer.sh {specify the installation directory}
   

2. Edit your .vimrc like this.

   if &compatible
     set nocompatible
   endif
   set runtimepath+={path to dein.vim directory}
   
   if dein#load_state({path to plugin base path directory})
     call dein#begin({path to plugin base path directory})
   
     call dein#add({path to dein.vim directory})
     call dein#add('Shougo/deoplete.nvim')
     if !has('nvim')
       call dein#add('roxma/nvim-yarp')
       call dein#add('roxma/vim-hug-neovim-rpc')
     endif
     ...
   
     call dein#end()
     call dein#save_state()
   endif
   
   filetype plugin indent on
   syntax enable

3. Open vim and install dein

   :call dein#install()

Concept

• Faster than NeoBundle

• Simple

• No commands, Functions only to simplify the implementation

• Easy to test and maintain

• No Vundle/NeoBundle compatibility

• neovim/Vim8 asynchronous API installation support

• Local plugin support

• Non github plugins support

• Go like clone directory name ex:"github.com/{user}/{repository}"

• Merge the plugins directories automatically to avoid long 'runtimepath'

Future works (not implemented yet)

• Other types support (zip, svn, hg, ...)

• Metadata repository support

Options

Some common options. For a more detailed list, run :h dein-options

Option	Type	Description
name	string	A name for the plugin. If it is omitted, the tail of the repository name will be used
rev	string	The revision number or branch/tag name for the repo
build	string	Command to run after the plugin is installed
on_ft	string or list	Load a plugin for the current filetype
on_cmd	string or list	Load the plugin for these commands