Powerline is a statusline plugin for vim, and provides statuslines and prompts for several other applications, including zsh, bash, tmux, IPython, Awesome and Qtile.
Go to file
Kim Silkebækken aa05f22652 Update README 2013-08-05 10:56:27 +02:00
docs Fix documented path to fontpatcher.py 2013-06-28 13:55:28 +02:00
font Combine vim modelines and Python encoding declarations 2013-03-11 10:40:09 +01:00
packages Fix Arch Linux AUR package upload issues 2013-07-31 16:11:20 +02:00
powerline Merge remote-tracking branch 'tmurph/feature/504-battery-segment' into develop 2013-07-31 15:28:54 +02:00
scripts Fix typo in scripts/powerline 2013-05-06 19:13:31 +04:00
tests Merge remote-tracking branch 'tmurph/feature/504-battery-segment' into develop 2013-07-31 15:28:54 +02:00
tools Improve generate_gradients tool 2013-04-13 19:33:41 +04:00
.gitignore Fix problems with merging vim.Dictionary 2013-05-23 18:36:51 +04:00
.local.vimrc Also ignore trailing whitespaces 2013-04-07 04:16:57 +04:00
.travis.yml Do not restrict branches to `tests` branch 2013-03-03 21:03:56 +01:00
CONTRIBUTING.rst Add initial CONTRIBUTING document 2013-03-15 15:23:41 +01:00
LICENSE Change license from CC BY-SA to the MIT license 2013-03-08 17:58:06 +01:00
MANIFEST.in Include bindings in package 2013-01-23 07:40:19 +01:00
README.rst Update README 2013-08-05 10:56:27 +02:00
setup.py Fix #604 2013-07-20 18:44:18 +05:30

README.rst

Powerline
=========

:Author: Kim Silkebækken (kim.silkebaekken+vim@gmail.com)
:Source: https://github.com/Lokaltog/powerline
:Version: beta
:Build status:
    .. image:: https://api.travis-ci.org/Lokaltog/powerline.png?branch=develop
       :target: `travis-build-status`_
       :alt: Build status

.. _travis-build-status: https://travis-ci.org/Lokaltog/powerline

**Powerline is a statusline plugin for vim, and provides statuslines and 
prompts for several other applications, including zsh, bash, tmux, IPython, 
Awesome and Qtile.**

Features
--------

* **Extensible and feature rich, written in Python.** Powerline was 
  completely rewritten in Python to get rid of as much vimscript as 
  possible. This has allowed much better extensibility, leaner and better 
  config files, and a structured, object-oriented codebase with no mandatory
  third-party dependencies other than a Python interpreter.
* **Stable and testable code base.** Using Python has allowed unit testing 
  of all the project code. The code is tested to work in Python 2.6+ and 
  Python 3.
* **Support for prompts and statuslines in many applications.** Originally 
  created exclusively for vim statuslines, the project has evolved to 
  provide statuslines in tmux and several WMs, and prompts for shells like 
  bash/zsh and other applications. It's simple to write renderers for any 
  other applications that Powerline doesn't yet support.
* **Configuration and colorschemes written in JSON.** JSON is 
  a standardized, simple and easy to use file format that allows for easy 
  user configuration across all of Powerline's supported applications.
* **Fast and lightweight, with daemon support for even better performance.**
  Although the code base spans a couple of thousand lines of code with no 
  goal of "less than X lines of code", the main focus is on good performance 
  and as little code as possible while still providing a rich set of 
  features. The new daemon also ensures that only one Python instance is 
  launched for prompts and statuslines, which provides excellent 
  performance.

*But I hate Python / I don't need shell prompts / this is just too much 
hassle for me / what happened to the original vim-powerline project / …*

You should check out some of the Powerline derivatives. The most lightweight
and feature-rich alternative is currently Bailey Ling's `vim-airline 
<https://github.com/bling/vim-airline>`_ project.

------

* Consult the `documentation 
  <https://powerline.readthedocs.org/en/latest/>`_ for more information and 
  installation instructions.
* Check out `powerline-fonts <https://github.com/Lokaltog/powerline-fonts>`_ 
  for pre-patched versions of popular, open source coding fonts.

Screenshots
-----------

Vim statusline
^^^^^^^^^^^^^^

**Mode-dependent highlighting**

* .. image:: https://raw.github.com/Lokaltog/powerline/develop/docs/source/_static/img/pl-mode-normal.png
     :alt: Normal mode
* .. image:: https://raw.github.com/Lokaltog/powerline/develop/docs/source/_static/img/pl-mode-insert.png
     :alt: Insert mode
* .. image:: https://raw.github.com/Lokaltog/powerline/develop/docs/source/_static/img/pl-mode-visual.png
     :alt: Visual mode
* .. image:: https://raw.github.com/Lokaltog/powerline/develop/docs/source/_static/img/pl-mode-replace.png
     :alt: Replace mode

**Automatic truncation of segments in small windows**

* .. image:: https://raw.github.com/Lokaltog/powerline/develop/docs/source/_static/img/pl-truncate1.png
     :alt: Truncation illustration
* .. image:: https://raw.github.com/Lokaltog/powerline/develop/docs/source/_static/img/pl-truncate2.png
     :alt: Truncation illustration
* .. image:: https://raw.github.com/Lokaltog/powerline/develop/docs/source/_static/img/pl-truncate3.png
     :alt: Truncation illustration

----

The font in the screenshots is `Pragmata Pro`_ by Fabrizio Schiavi.

.. _`Pragmata Pro`: http://www.fsd.it/fonts/pragmatapro.htm