Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/polybar/polybar

A fast and easy-to-use status bar
https://github.com/polybar/polybar

bar bspwm cpp hacktoberfest i3wm linux polybar window-manager x11

Last synced: 5 days ago
JSON representation

A fast and easy-to-use status bar

Awesome Lists containing this project

README 

        


  Polybar

  Polybar






A fast and easy-to-use tool for creating status bars.








GitHub All Releases




















**[Documentation](https://github.com/polybar/polybar/wiki/) | [Installation](#installation) | [Support](SUPPORT.md) | [Donate](#donations)**



**Polybar** aims to help users build beautiful and highly customizable status bars

for their desktop environment, without the need of having a black belt in shell scripting.



![default configuration screenshot](doc/_static/default.png)



## Table of Contents



* [Introduction](#introduction)

* [Getting Help](#getting-help)

* [Contributing](#contributing)

* [Getting started](#getting-started)

  * [Installation](#installation)

  * [First Steps](#first-steps)

* [Community](#community)

* [Contributors](#contributors)

* [Donations](#donations)

  * [Sponsors](#sponsors)

  * [Backers](#backers)

* [License](#license)

* [Signatures](#signatures)



## Introduction



The main purpose of **Polybar** is to help users create awesome status bars.

It has built-in functionality to display information about the most commonly used services.

Some of the services included so far:



- Systray icons

- Window title

- Playback controls and status display for [MPD](https://www.musicpd.org/) using [libmpdclient](https://www.musicpd.org/libs/libmpdclient/)

- [ALSA](https://www.alsa-project.org/main/index.php/Main_Page) and [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) volume controls

- Workspace and desktop panel for [bspwm](https://github.com/baskerville/bspwm) and [i3](https://github.com/i3/i3)

- Workspace module for [EWMH compliant](https://specifications.freedesktop.org/wm-spec/wm-spec-1.3.html#idm140130320786080) window managers

- Keyboard layout and indicator status

- CPU and memory load indicator

- Battery display

- Network connection details

- Backlight level

- Date and time label

- Time-based shell script execution

- Command output tailing

- User-defined menu tree

- Inter-process messaging

- And more...



[See the wiki for more details](https://github.com/polybar/polybar/wiki).



## Getting Help



If you find yourself stuck, have a look at our [Support](SUPPORT.md) page for resources where you can find help.



## Contributing



Read our [contributing guidelines](CONTRIBUTING.md) for how to get started with contributing to polybar.



## Getting started



### Installation





    Packaging status




Polybar is already available in the package manager for many repositories.

We list some of the more prominent ones here.

Also click the [image on the

right](https://repology.org/project/polybar/versions) to see a more complete

list of available polybar packages.



If you are using **Debian** (bullseye/11/stable) or later, you can install [polybar](https://tracker.debian.org/pkg/polybar)

using `sudo apt install polybar`. Newer releases of polybar are sometimes provided in the [backports](https://wiki.debian.org/Backports)

repository for stable users, you need to enable [backports](https://wiki.debian.org/Backports) and then install using

`sudo apt -t bullseye-backports install polybar`.



If you are using **Ubuntu** 20.10 (Groovy Gorilla) or later, you can install polybar

using `sudo apt install polybar`.



If you are using **Arch Linux**, you can install

[polybar](https://archlinux.org/packages/extra/x86_64/polybar/) to get the

latest stable release using `sudo pacman -S polybar`. The latest unstable

changes are also available in the

[`polybar-git`](https://aur.archlinux.org/packages/polybar-git) package in the

AUR.



If you are using **Manjaro**, you can install [polybar](https://software.manjaro.org/package/polybar) to get the latest stable release using `sudo pacman -S polybar`.



If you are using **Void Linux**, you can install [polybar](https://github.com/void-linux/void-packages/blob/master/srcpkgs/polybar/template) using `xbps-install -S polybar`.



If you are using **NixOS**, polybar is available in both the stable and unstable channels and can be installed with the command `nix-env -iA nixos.polybar`.



If you are using **Slackware**, polybar is available from the [SlackBuilds](https://slackbuilds.org/repository/14.2/desktop/polybar/) repository.



If you are using **Source Mage GNU/Linux**, polybar spell is available in test grimoire and can be installed via `cast polybar`.



If you are using **openSUSE Leap** polybar is available from the

[X11:Utilities](https://build.opensuse.org/package/show/X11:Utilities/polybar) repository or **openSUSE Tumbleweed** `polybar` is available from the official repositories and can be installed via `zypper`.

The package is available for openSUSE Leap 15.5 and above.



If you are using **FreeBSD**, [polybar](https://www.freshports.org/x11/polybar) can be installed using `pkg install polybar`. Make sure you are using the `latest` package branch.



If you are using **Gentoo**, both release and git-master versions are available in the [main](https://packages.gentoo.org/packages/x11-misc/polybar) repository.



If you are using **Fedora**, you can install [polybar](https://src.fedoraproject.org/rpms/polybar) using `sudo dnf install polybar`.



If you can't find your distro here, you will have to [build from source](https://github.com/polybar/polybar/wiki/Compiling).



### First Steps

[See the wiki for details on how to run and configure polybar](https://github.com/polybar/polybar/wiki).



## Community

Want to get in touch?



* Visit our [Discussion page](https://github.com/polybar/polybar/discussions)

* Join our Gitter room at [`gitter.im/polybar/polybar`](https://gitter.im/polybar/polybar)

* We have our own subreddit at [`r/polybar`](https://www.reddit.com/r/polybar)

* Chat with us in the `#polybar` IRC channel on the [`irc.libera.chat:6697`](https://libera.chat/) server



## Contributors



### Maintainers

* Patrick Ziegler [**@patrick96**](https://github.com/patrick96)



### Owner

* Michael Carlberg [**@jaagr**](https://github.com/jaagr/)



### Former Maintainers

* [**@Lomadriel**](https://github.com/Lomadriel)

* [**@NBonaparte**](https://github.com/NBonaparte)

* Chase Geigle [**@skystrife**](https://github.com/skystrife)



### Logo Design by

* [**@Tobaloidee**](https://github.com/Tobaloidee)



### [All Contributors](https://github.com/polybar/polybar/graphs/contributors)



## Donations



Polybar accepts donations through [open collective](https://opencollective.com/polybar).



[Become a backer](https://opencollective.com/polybar) and support polybar!

### Sponsors
































































### Backers
































































## License



Polybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/polybar/polybar/blob/master/LICENSE).



## Signatures



Release archives and tags are signed by a maintainer using GPG. Currently

everything is signed by [Patrick Ziegler](https://www.patrickziegler.ch/gpg)

with fingerprint `1D5791352D51A228D4DDDBA4521E5E03AEBCA1A7`