vim-airline/README.md

vim-airline

Lean & mean statusline for vim that's light as air.

Features

• Tiny core written with extensibility in mind (open/closed principle).
• Integrates with a variety of plugins, including: vim-bufferline, fugitive, unite, ctrlp, minibufexpl, gundo, undotree, nerdtree, tagbar, vim-gitgutter, vim-signify, syntastic, lawrencium and virtualenv.
• Looks good with regular fonts and provides configuration points so you can use unicode or powerline symbols.
• Optimized for speed; it loads in under a millisecond.
• Extensive suite of themes for popular colorschemes including solarized (dark and light), tomorrow (all variants), base16 (all variants), molokai, jellybeans and others; have a look at the screenshots in the wiki.
• Supports 7.2 as the minimum Vim version.
• Stable release cycle; bleeding edge changes happen on the dev branch, and after they have gone through a full regression test will eventually be merged in the stable master branch. Releases typically occur every 2 weeks.

Straightforward customization

If you don't like the defaults, you can replace all sections with standard statusline syntax. Give your statusline that you've built over the years a face lift.

Automatic truncation

Sections are automatically hidden when the window size shrinks.

Extensible pipeline

Completely transform the statusline to your liking. Build out the statusline as you see fit by extracting colors from the current colorscheme's highlight groups.

Seamless integration

vim-airline integrates with a variety of plugins out of the box. These extensions will be lazily loaded if and only if you have the other plugins installed (and of course you can turn them off).

ctrlp.vim

unite.vim

tagbar

csv.vim

syntastic

hunks (vim-gitgutter & vim-signify)

virtualenv

Extras

vim-airline also supplies some supplementary stand-alone extensions.

whitespace

Rationale

There's already powerline, why yet another statusline?

• 100% vimscript; no python needed.

What about vim-powerline?

• vim-powerline has been deprecated in favor of the newer, unifying powerline, which is under active development; the new version is written in python and expands its capabilities to tools outside of vim, such as bash, zsh, and tmux.
• vim-powerline uses different font codes, so if you want to use it with a powerline themed tmux (for example), it will not work.

Where did the name come from?

I wrote the initial version on an airplane, and since it's light as air it turned out to be a good name. Thanks for flying vim!

Installation

This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:

• Pathogen
• git clone https://github.com/bling/vim-airline ~/.vim/bundle/vim-airline
• NeoBundle
• NeoBundle 'bling/vim-airline'
• Vundle
• Bundle 'bling/vim-airline'
• VAM
• call vam#ActivateAddons([ 'vim-airline' ])
• manual
• copy all of the files into your ~/.vim directory

Configuration

:help airline

Integrating with powerline fonts

For the nice looking powerline symbols to appear, you will need to install a patched font. Instructions can be found in the official powerline documentation. Prepatched fonts can be found in the powerline-fonts repository.

Finally, enable them in vim-airline by adding let g:airline_powerline_fonts = 1 to your vimrc.

FAQ

Solutions to common problems can be found in the Wiki.

Screenshots

A full list of screenshots for various themes can be found in the Wiki.

Bugs

Tracking down bugs can take a very long time due to different configurations, versions, and operating systems. To ensure a timely response, please help me out by doing the following:

• Reproduce it with this minivimrc repository to rule out any configuration conflicts.
• A link to your vimrc or a gist which shows how you configured the plugin(s).
• And so I can reproduce; your :version of vim, and the commit of vim-airline you're using.

Contributions

Contributions and pull requests are welcome. Please take note of the following guidelines:

• Adhere to the existing style as much as possible; notably, 2 space indents and long-form keywords.
• Keep the history clean! squash your branches before you submit a pull request. pull --rebase is your friend.
• Any changes to the core should be tested against Vim 7.2.
• If you submit a theme, please create a screenshot so it can be added to the Wiki.

License

MIT License. Copyright (c) 2013 Bailey Ling.