rofi README

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

Please match the documentation and scripts to the version of rofi used

Also see the locally installed documentation (manpages).

Rofi

A window switcher, Application launcher and dmenu replacement.

https://user-images.githubusercontent.com/84911063/139428874-fe182dd6-82c6-49b8-8da1-920ddda3d1ed.mp4

Rofi started as a clone of simpleswitcher, written by Sean Pringle - a popup window switcher roughly based on superswitcher. Simpleswitcher laid the foundations, and therefore Sean Pringle deserves most of the credit for this tool. Rofi (renamed, as it lost the simple property) has been extended with extra features, like an application launcher and ssh-launcher, and can act as a drop-in dmenu replacement, making it a very versatile tool. Thanks to the great work of lbonn, who added Wayland support in his fork and maintained it for years, Rofi now officially supports Wayland (since 2025).

Rofi, like dmenu, will provide the user with a textual list of options where one or more can be selected. This can either be running an application, selecting a window, or options provided by an external script.

What is rofi not?

Rofi is not:

Table of Contents

Features

Its main features are:

Modes

Rofi has several built-in modes implementing common use cases and can be extended by scripts (either called from Rofi or calling Rofi) or plugins.

Below is a list of the different modes:

Rofi is known to work on Linux and BSD.

Wayland support

Build

Please follow the build instructions to build rofi.

Wayland support is enabled by default, along with X11/xcb.

rofi can also be built without X11/xcb or wayland, but at least one backend should be enabled:

meson build -Dxcb=disabled
meson build -Dwayland=disabled

Usage

Rofi should automatically select the xcb or wayland backend depending on the environment it is run on.

To force the use of the xcb backend (if enabled during build), the -x11 option can be used:

rofi -x11 ...

Missing features in Wayland mode

Due to the different architecture and available APIs in Wayland mode, some original rofi features are difficult or impossible to replicate

Wayland DPI

On wayland, the output is only known after the first surface is shown. This makes sizing rofi windows in absolute size (mm) very difficult, a problem unique for rofi, as the actual DPI is unknown beforehand. This can be worked around by manually passing the right DPI via configuration system. If the dpi config option is set to 0 and only one monitor is connected rofi will use the DPI of the only connected monitor or if you have multiple monitors and you specify a monitor name, it will use the DPI of that monitor.

Manpage

For more up to date information, please see the manpages. The other sections and links might have outdated information as they have relatively less maintenance than the manpages. So, if you come across any issues please consult manpages, discussion and issue tracker before filing new issue.

Installation

Please see the installation guide for instructions on how to install Rofi.

Quickstart

Usage

This section just gives a brief overview of the various options. To get the full set of options see the manpages section above

Running rofi

To launch rofi directly in a certain mode, specify a mode with rofi -show <mode>. To show the run dialog:

    rofi -show run

Or get the options from a script:

    ~/my_script.sh | rofi -dmenu

Specify an ordered, comma-separated list of modes to enable. Enabled modes can be changed at runtime. Default key is Ctrl+Tab. If no modes are specified, all configured modes will be enabled. To only show the run and ssh launcher:

    rofi -modes "run,ssh" -show run

The modes to combine in combi mode. For syntax to -combi-modes, see -modes. To get one merge view, of window,run, and ssh:

 rofi -show combi -combi-modes "window,run,ssh" -modes combi

Configuration

Generate a default configuration file

mkdir -p ~/.config/rofi
rofi -dump-config > ~/.config/rofi/config.rasi

This creates a file called config.rasi in the ~/.config/rofi/ folder. You can modify this file to set configuration settings and modify themes. config.rasi is the file rofi looks to by default.

Please see the configuration guide for a summary of configuration options. More detailed options are provided in the manpages.

Themes

Please see the themes manpages for a detailed description.

The latest bundled themes can be found here.

Screenshots

Rezlooks:

screenshot

Arthur:

screenshot2

Default theme:

default

Wiki

❗ The Wiki is currently unmaintained and might contain outdated data

Go to wiki .

Contents

Discussion places

The GitHub Discussions is the preferred location for discussions.

Stargazers over time

Stargazers over time

rofi (davatorium/rofi)

Searching Database…

16.5K ·GitHub
What is this?Rofi is a window switcher, application launcher and dmenu replacement for Linux and BSD. It pops up a searchable list where you can jump between open windows, launch apps, connect over SSH or browse files.
What can it actually do — is it just for switching windows?It has several built-in modes: run launches apps from $PATH, drun starts apps from their XDG desktop files, window switches between open windows, ssh connects to remote hosts, filebrowser opens files, keys lists keybindings, and combi merges several modes into one list.
How do I pull it up when I need it?Install it, then launch a specific mode with rofi -show — for example rofi -show run for the run dialog. Most people bind that command to a hotkey in their window manager.
Does it run on Wayland, or is it X11-only?Both. It builds with Wayland and X11/xcb backends enabled by default — at least one backend is required — and picks the right one automatically from your environment. You can force X11 with the -x11 option.
Does everything work the same on Wayland?Not quite. Wayland mode is missing a few X11 features: the -normal-window flag, fine-grained monitor selection with -monitor -n, some window-position offsets, fake transparency, and the window mode on KWin.
Will the window switcher work with my window manager, like i3?Window switching needs an EWMH-compatible window manager, with specific workarounds for i3 and bspwm; on Wayland it targets WMs from the wlr family. Rofi itself is known to work on Linux and BSD.
Why would I use this instead of plain dmenu?It's a drop-in dmenu replacement, so existing dmenu scripts keep working, but you also get RTL language support and Cairo drawing with Pango font rendering, plus script and plugin extensibility.
How do I configure it and change how it looks?Run rofi -dump-config to generate a default config.rasi in ~/.config/rofi/ — that's the file rofi loads by default, and it holds both settings and themes. Bundled themes ship with rofi, and the rofi-theme manpage covers theming in detail.
Can I add my own entries or modes?Yes. The script mode supports (limited) custom modes built from simple scripts, and rofi can be extended with plugins — scripts can either be called by rofi or call rofi themselves.
Does it remember which apps I use most?Optionally, yes: history-based ordering keeps your last 25 choices on top based on use. Match sorting can also be set to Levenshtein distance or fzf-like fuzzy ranking.
What are similar projects?Flow.Launcher, sway, i3, Wox, rustcast, Waybar, rift, DEsk
Creator
davatorium
Size
31.4 MB
Stars
16.5K
Age
13y
Commits · 90 Days