Skip to content
A comprehensive Vim utility functions for Vim plugins
VimL Lua Other
Latest commit 49faf10 May 11, 2016 @thinca thinca Merge pull request #434 from hattya/Prelude/globpath
Prelude: improve globpath()

vital.vim Build Status Build status

Join the chat at

A comprehensive Vim utility functions for Vim plugins.

This is like a plugin which has both aspects of Bundler and jQuery at the same time.


If you are a Vim user who doesn't make Vim plugins, please ignore this page.

If you are a Vim plugin author, please check this out.

What vital.vim provides

Module Description
Assertion assertion library
Bitwise bitwise operators
ConcurrentProcess manages processes concurrently with vimproc
Data.Base64 base64 utilities library
Data.BigNum multi precision integer library
Data.Closure Provide Closure object
Data.Collection Utilities both for list and dict
Data.Counter Counter library to support convenient tallies
Data.Dict dictionary utilities library
Data.LazyList lazy list including file io
Data.List list utilities library
Data.Optional optional value library
Data.OrderedSet ordered collection library
Data.String string utilities library
Data.Tree tree utilities library
Database.SQLite sqlite utilities library
DateTime date and time library
Experimental.Functor Utilities for functor
Interpreter.Brainf__k Brainf**k interpreter
Locale.Message very simple message localization library
Lua.Prelude crucial functions for lua integration
Mapping Utilities for mapping
Math Mathematical functions
OptionParser Option parser library for Vim
Prelude crucial functions
Process Utilities for process
ProcessManager process manager with vimproc
Random.Mt19937ar random number generator using mt19937ar
Random.Xor128 random number generator using xor128
Random Random utility frontend library
System.Process A cross-platform process utilities
System.Cache An unified cache system
System.File filesystem utilities library
System.Filepath path string utilities library
Text.CSV CSV library
Text.INI INI file library
Text.LTSV LTSV library
Text.Lexer lexer library
Text.Parser parser library
Text.Sexp S-Expression parser
Text.TOML TOML library
Text.Table Character table library
Vim.Buffer Vim's buffer related stuff in general
Vim.BufferManager buffer manager
Vim.Compat Vim compatibility wrapper functions
Vim.Python +python/+python3 compatibility functions
Vim.Message Vim message functions
Vim.Search Vim's [I like function
Vim.ScriptLocal Get script-local things
Vim.ViewTracer Trace window and tabpage
Vim.Guard Guard options/variables
Web.HTML HTML parser written in pure Vim script
Web.HTTP simple HTTP client library
Web.JSON JSON parser written in pure Vim script
Web.URI URI manipulation library
Web.XML XML parser written in pure Vim script

... and more ...

Let's get started

Install modules for your own plugin

Use :Vitalize to install modules. Please see the help for more details.

:Vitalize --name=your_plugin_name $HOME/.vim/bundle/your_plugin_dir/

You can also install only specified modules; recommended for making your repository size small, assuming you are going to upload it to a remote repository

:Vitalize --name=your_plugin_name $HOME/.vim/bundle/your_plugin_dir/ Data.String Data.List

Use vital functions

Assuming your Vim plugin name is ujihisa. You can define your utility function set ujihisa#util just by

let s:V = vital#of('ujihisa')
function! ujihisa#util#system(...)
  return call(s:V.system, a:000, s:V)

and then you can call functions by ujihisa#util#system(), without taking care of vital.vim itself. It's all hidden.

Vital has module system. The below is an example to import/load a module Data.OrderedSet and to call a function f() of the module.

" Recommented way
let s:V = vital#of('ujihisa')
let s:O = s:V.import('Data.OrderedSet')
call s:O.f()


" Recommended way only if you rarely use the module
let s:V = vital#of('ujihisa')
call s:V.load('Data.OrderedSet')
call s:V.Data.OrderedSet.f()


" Available, but we don't recommend this very much
let s:V = vital#of('ujihisa')
call s:V.import('Data.OrderedSet', s:)
call s:f()

We recommend you to use a capital letter for a Vital module dictionary to assign.

Plugins Using vital.vim

A lot of vim plugins are using vital.vim


It is not necessary but we recommend to add a badge to your project README to make the vital.vim developers happy ;-) The following is a markdown snippet.

[![Powered by vital.vim](](

The badge uses so you can customize the looks as like:

  • Powered by vital.vim (Default)
  • Powered by vital.vim by adding ?style=plastic
  • Powered by vital.vim by adding ?style=flat
  • Powered by vital.vim by adding ?style=flat-square

If you want to become a vital developer

Become a vital.vim Developer





Japanese original text:

What's NYSL? and Why did we chose it?

NYSL is a very loose license like a Beer License, or more like WTFPL. See NYSL for details. (English and Japanese)

First, vital.vim is a bundling (static) library. We think everyone should be able to use it easily, without worrying about licensing stuff too much.

Second, In Japan, Strict Public Domain might be invalid. You outside Japan may interpret simply the license as Public Domain.

That's why we chose NYSL.

(See about the discussion.)

Something went wrong with that request. Please try again.