Guide · Open source
How to use eww: install, configure and build custom widgets
Updated · written with AI from the project's own documentation and checked against our catalogue data
Eww (Elkowars Wacky Widgets) is a standalone widget system written in Rust. It lets you build custom on-screen widgets such as bars and panels for a desktop running almost any window manager. This guide explains what eww is for, how to get the source and what you need installed, and where to find the documentation for writing your own widgets.
ewwelkowar/eww · ★ 12.7k · MIT Install options & downloads Quick start
- 1Check your system. Confirm you run Linux with a window manager you want to customize, since eww targets Linux window managers.
- 2Install prerequisites. Install a Rust toolchain and the GTK3 development libraries.
- 3Clone the repository. Run git clone https://github.com/elkowar/eww to get the source code.
- 4Read the install instructions. Follow the build and install steps in the documentation at https://elkowar.github.io/eww.
- 5Study the example bar. Open examples/eww-bar to see how a working bar is structured.
- 6Write your first widget. Adapt the example to your own layout, checking the syntax against the current docs.
- 7Share or contribute. Share your setup with the community, or follow the README's contribution steps to add widgets or features.
What eww is and who it suits
Eww is a widget system, not a ready-made desktop. You describe the widgets you want, and eww draws them on screen. The project's README says it is made to implement custom widgets in any window manager.
It fits Linux users who run a tiling or minimal window manager and want a custom bar or panel. It also suits people who enjoy designing their own desktop look and are comfortable editing configuration files.
- Good fit: replacing a default status bar with a fully customized one.
- Good fit: building a personalized desktop setup.
- Poor fit: anyone who wants a desktop that works with no configuration, because widgets must be written by hand.
- Poor fit: Windows or macOS users, since the README frames eww around Linux window managers and GTK.
What you need before installing eww
The project's install method is clone-and-build. The prerequisites listed for it are a Rust toolchain and the GTK3 development libraries. Install both before you try to build.
The README points to the documentation site for full install instructions, so check there for the exact build steps.
- A Rust toolchain.
- GTK3 development libraries.
Clone the eww repository
The first install command in the README clones the source code from GitHub. Run it in the directory where you want the project folder to live.
git clone https://github.com/elkowar/ewwLearn the configuration with examples and docs
Eww is configured by writing your own widgets, so the examples folder and the documentation are where you learn the format. The repository includes a basic bar in the examples/eww-bar folder.
Some examples in the README still use the old configuration syntax, so compare an example's syntax against the current documentation before copying it. A beginner-friendly introductory guide by Dharmx is also linked from the README.
- Start with the basic bar at examples/eww-bar.
- Check the documentation at https://elkowar.github.io/eww for the current syntax.
- Read the community guide linked from the README for a beginner walk-through.
Compare eww with other bar tools
Eww is one of several tools for custom bars. The comparable projects named for it are Polybar, Waybar, AGS and Eluna. Eww's distinguishing point, from the README, is that it is a standalone widget system that works with any window manager, rather than a bar tied to one environment.
Pick eww if you want to design widgets yourself. If you want a bar that is simpler to set up, look at the other tools in this list.
What people use it for
- Building a custom top or bottom bar for a tiling window manager.
- Designing a vertical bar or side panel for a personalized desktop.
- Replacing a default status bar with a fully custom widget layout.
- Sharing a desktop setup with the Linux customization community.
Frequently asked questions
Is eww free to use?
Eww is released under the MIT licence, as stated on its project page. The MIT licence allows you to use and modify the code under its terms.
How do I install eww?
The README's install method is clone-and-build. Start with git clone https://github.com/elkowar/eww, install a Rust toolchain and GTK3 development libraries, then follow the instructions in the documentation at elkowar.github.io/eww.
What do I need to run eww?
The listed prerequisites are a Rust toolchain and the GTK3 development libraries. The project is also framed around Linux window managers.
Does eww work on Windows or macOS?
The README frames eww around Linux window managers and GTK, so it is aimed at Linux. Windows and macOS users should look for tools built for their own systems.
Is eww a good alternative to Polybar or Waybar?
Eww is a standalone widget system you configure yourself, while Polybar and Waybar are bar tools. Choose eww if you want to design custom widgets, and choose one of the others if you want a bar with less setup.
Why does my eww config not work with the examples?
The README notes that some examples still use an old configuration syntax. Check the current documentation at elkowar.github.io/eww and update the syntax before debugging further.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Eww suits Linux users who run a tiling or minimal window manager, enjoy designing their own desktop and are comfortable writing configuration by hand. If you want a ready-made desktop, a Windows or macOS setup, or a configuration format with fully stable documentation, pick a different tool.
Install options & downloads