Waybar README

The project's README from github.com/Alexays/Waybar. As one markdown file: README.md.

Waybar

License Donate CI Release

Waybar

Highly customizable Wayland bar for Sway and wlroots-based compositors.
Available in all major distributions.

Installation · Wiki · Configuration · Styling · Examples · FAQ

Features

Compositor integration

Compositor Workspaces / Tags Window Layout Language Mode
Sway ✅ ✅ ✅ ✅
River ✅ ✅ ✅ ✅
Hyprland ✅ ✅ ✅ ✅
Niri ✅ ✅ ✅
Mango ✅ ✅ ✅ ✅ ✅
DWL ✅ ✅
Wayfire ✅ ✅

DWL requires the dwl IPC patch.

Modules

…and more. Every module is documented on the wiki (see the Modules sidebar).

Getting started

git clone https://github.com/Alexays/Waybar
cd Waybar
meson setup build
ninja -C build
./build/waybar          # run without installing

Waybar launches with a sensible default config. To make it yours, copy the default config and stylesheet into ~/.config/waybar/ and edit them. The Configuration and Styling guides cover every option, and Examples has ready-to-use community setups.

Installation

Waybar is packaged by most distributions:

Packaging status

An Ubuntu PPA with more recent versions is available here.

Building from source

git clone https://github.com/Alexays/Waybar
cd Waybar
meson setup build
ninja -C build
ninja -C build install   # optional
Runtime dependencies
gtkmm3       jsoncpp      libsigc++    fmt          wayland
chrono-date  spdlog       xkbregistry  libgtk-3-dev upower

libpulse             [Pulseaudio module]
libnl                [Network module]
libappindicator-gtk3 [Tray module]
libdbusmenu-gtk3     [Tray module]
libmpdclient         [MPD module]
libsndio             [sndio module]
libevdev             [KeyboardState module]
Build dependencies
cmake   meson   scdoc   wayland-protocols
Install dependencies — Ubuntu
sudo apt install \
  clang-tidy gobject-introspection libdbusmenu-gtk3-dev libevdev-dev \
  libfmt-dev libgirepository1.0-dev libgtk-3-dev libgtkmm-3.0-dev \
  libinput-dev libjsoncpp-dev libmpdclient-dev libnl-3-dev libnl-genl-3-dev \
  libpulse-dev libsigc++-2.0-dev libspdlog-dev libwayland-dev scdoc upower \
  libxkbregistry-dev
Install dependencies — Arch
pacman -S --asdeps \
  gtkmm3 jsoncpp libsigc++ fmt wayland chrono-date spdlog gtk3 \
  gobject-introspection libgirepository libpulse libnl libappindicator-gtk3 \
  libdbusmenu-gtk3 libmpdclient sndio libevdev libxkbcommon upower meson \
  cmake scdoc wayland-protocols glib2-devel

Contributing

Contributions are welcome — see CONTRIBUTING.md. The style guidelines are Google's C++ style.

Docs live in the man pages. Module documentation is written in man/ (scdoc) and auto-synced to the wiki. Edit the man page, not the wiki — see .github/wiki.

[!CAUTION] Distributions of Waybar are only released on the official GitHub page.
Waybar does not have an official website. Do not trust any site claiming to be official.

License

Waybar is licensed under the MIT license. See LICENSE for details.

Waybar (Alexays/Waybar)

system-monitor
Searching Database…

12.1K ·GitHub
What is this?Waybar is a highly customizable status bar built for Wayland compositors like Sway, Hyprland, River, and other wlroots-based setups, with modules for things like battery, network, audio, and the clock.
Is this a GUI app I run, or a library I code against?It is a standalone GTK-based bar application that runs as part of your Wayland session, not a library or script you embed in a project.
How do I get it running?Install it through your Linux distribution's package manager (an Ubuntu PPA offers newer builds), or build it from source yourself, then copy the default config and stylesheet into ~/.config/waybar/ and edit them to your liking.
Do I need a specific Wayland compositor like Sway to use it?Yes — Waybar targets Wayland/wlroots compositors specifically, with confirmed support for Sway, River, Hyprland, Niri, Mango, DWL, and Wayfire; it does not run on X11.
Does every feature work the same on every compositor?No — feature coverage differs per compositor (e.g. window title, layout, or mode indicators aren't available everywhere), and DWL support specifically needs an extra IPC patch applied first.
What modules does Waybar include out of the box?It bundles modules for power and hardware (battery, UPower, CPU, memory, disk, temperature), connectivity (network, Bluetooth, GPS, WWAN), audio and media (PulseAudio, WirePlumber, MPD, MPRIS), plus desktop extras like clock, system tray, idle inhibitor, and custom scripts.
Can I style it to match my theme?Yes, it ships with a default config and CSS stylesheet you copy into ~/.config/waybar/, and the Styling guide plus a community Examples page cover full visual customization.
Where should I download Waybar from?Only from the official GitHub page or your distro's official package repository — the project explicitly warns that it has no official website, so any other site claiming to be one should not be trusted.
Creator
Alexays
Size
7.3 MB
Stars
12.1K
Age
8y
Commits · 90 Days