---
type: "post"
id: "wl-sidebar-is-an-open-source-rust-utility-647a62"
slug: "wl-sidebar-is-an-open-source-rust-utility-647a62"
title: "wl-sidebar is an open-source Rust utility that runs a Wayland application as a slide-out panel anchored to a"
description: "wl-sidebar is an open-source Rust utility that runs a Wayland application as a slide-out panel anchored to a screen edge, reserving workspace while it is visible."
retrieval_nugget: "wl-sidebar is an open-source Rust utility that runs a Wayland application as a slide-out panel anchored to a screen edge, reserving workspace while it is visible. For builders using compatible compositors, it turns ordinary apps such as terminals or note tools into configurable, keyboard-toggleable desktop surfaces, with important compatibility and trust caveats."
published_at: "2026-11-17"
updated_at: "2026-11-17"
record_date: "2026-11-17"
date_kind: "published_at"
topics: ["open-source"]
entities: ["wl-sidebar","Wayland","wl-proxy","Umbriel","niri"]
related_patterns: []
novelty_label: "new_fact"
what_changed: "A new Wayland utility runs applications in a space-saving sidebar attached to the screen edge."
prior_refs: ["https://newruntime.com/posts/waytator-screenshots-and-video-recording-on-wayland-d8839b/"]
source_url: "https://github.com/isaksamsten/wl-sidebar"
source_urls: ["https://github.com/isaksamsten/wl-sidebar"]
schema_version: "newruntime-agent-readable-v0.2"
stable_id: "post:wl-sidebar-is-an-open-source-rust-utility-647a62"
status: "published"
visuals: []
editor: {"role":"editor","name":"Andrey Reshetnikov","profile":"https://newruntime.com/owner-profile.md","profile_json":"https://newruntime.com/owner-profile.json","same_as":["https://www.linkedin.com/in/reshetnikov1/","https://t.me/lapetuse"]}
routes: {"html":"https://newruntime.com/posts/wl-sidebar-is-an-open-source-rust-utility-647a62/","markdown":"https://newruntime.com/posts/wl-sidebar-is-an-open-source-rust-utility-647a62.md","json":"https://newruntime.com/posts/wl-sidebar-is-an-open-source-rust-utility-647a62.json"}
markdown_url: "https://newruntime.com/posts/wl-sidebar-is-an-open-source-rust-utility-647a62.md"
---

# wl-sidebar is an open-source Rust utility that runs a Wayland application as a slide-out panel anchored to a

## Retrieval answer

wl-sidebar is an open-source Rust utility that runs a Wayland application as a slide-out panel anchored to a screen edge, reserving workspace while it is visible. For builders using compatible compositors, it turns ordinary apps such as terminals or note tools into configurable, keyboard-toggleable desktop surfaces, with important compatibility and trust caveats.

## Summary
wl-sidebar is an open-source Rust utility that runs a Wayland application as a slide-out panel anchored to a screen edge, reserving workspace while it is visible. For builders using compatible compositors, it turns ordinary apps such as terminals or note tools into configurable, keyboard-toggleable desktop surfaces, with important compatibility and trust caveats.

## What happened
The wl-sidebar GitHub README describes a tool that proxies an application's Wayland connection and translates its `xdg_toplevel` surface into `zwlr_layer_surface_v1`, the layer-shell surface type used for anchored desktop elements. Other traffic—including buffers, input, popups and clipboard operations—passes through unchanged. The app slides in from a chosen screen edge; by default, the compositor reserves space for it while shown, so it does not cover the surrounding windows. The project is built on wl-proxy, with translation code adapted from wl-proxy's wl-paper app, and is licensed under GPL-3.0.

Users define named sidebars in `~/.config/wl-sidebar/config.toml` (or `$XDG_CONFIG_HOME/wl-sidebar/config.toml`). A definition specifies an application command, edge and size. Size can be a pixel value or a fraction of an output's usable area; an optional output field selects a monitor. The README's examples configure an Alacritty terminal on the left at 400 pixels wide and an Obsidian window on the right at 30% width. A command can be an argument array or a string run with `sh -c`.

The command-line interface supports `--toggle NAME` to start and show a sidebar, or toggle one already running; `--start --hidden NAME` to launch it in the background; `--close NAME` to stop it; and `--list` to show configured panels and their state. Background processes are stopped with SIGTERM and then SIGKILL after three seconds, and the whole process group is signalled so wrapper-script helpers exit too. `--run` runs a sidebar in the foreground for debugging or a service manager such as systemd. Keybindings can call `wl-sidebar --toggle` from compositors such as Umbriel or niri.

Installation is via `cargo install --git https://github.com/isaksamsten/wl-sidebar`; Rust 1.89 or newer is required. The compositor must support `zwlr_layer_shell_v1`; the README names Umbriel, niri, sway, Hyprland, river and KDE Plasma, and explicitly says GNOME does not support it. Fading requires `wp_alpha_modifier_v1`. The README also documents trade-offs: some multi-monitor compositors do not clip sliding surfaces to a monitor edge, and certain focus or fade configurations disable explicit sync. For Flatpak apps, wl-sidebar hides the sandbox's `wp_security_context_v1` protocol so the app connection passes through the proxy; the README warns that the compositor then treats it like an unsandboxed program and says to use this mode only for trusted apps.

## What the archive adds
New Runtime covered [Waytator](https://newruntime.com/posts/waytator-screenshots-and-video-recording-on-wayland-d8839b/) on 2026-10-25, a separate Wayland-focused utility for screenshots, recording and lightweight editing. wl-sidebar is a new event in the adjacent ecosystem, not a new fact about Waytator: it uses Wayland for a different job, presenting existing applications as reserved-space edge panels.

## Trend signal
This does not yet fit a pattern New Runtime tracks. wl-sidebar is a focused desktop utility that proxies a Wayland surface into a compositor layer, rather than a material example of agent integration, runtime security boundaries or an agent-oriented capability interface.

## Why it matters
The tool makes a desktop workflow configurable without requiring the application itself to implement a sidebar mode. A builder can place a terminal, notes app or another Wayland-native program at an edge, define its dimensions and focus behavior, and wire it to a compositor keybinding. That can reduce the friction of switching between a main window and a persistent utility, especially on tiling or keyboard-driven desktops.

The useful idea is the separation between application and presentation: the app remains a normal Wayland client while a proxy changes how its top-level surface is exposed. But this is only practical for users whose compositor supports the required layer-shell protocol, and it carries configuration and app-specific workarounds. The Flatpak behavior deserves particular care: hiding the security-context protocol changes what the compositor can know about the app's sandbox status. This is a desktop productivity tool, not a general-purpose or AI-specific workflow, but it offers a concrete model for composing existing software into a more tailored interface.

## Limits and uncertainty
The repository reports 11 stars and no forks at the time represented by the GitHub page; those counts do not establish adoption or long-term maintenance. The README says the project is developed and tested on Umbriel and niri, while listing several other compatible compositors, but does not provide a cross-compositor test matrix. It gives no performance measurements, reliability data or user evaluations. Compatibility can also vary with app behavior: single-instance applications may open windows outside the proxy, and documented workarounds include separate browser profiles or environment changes. The security implications of removing Flatpak's security-context protocol are described, but there is no independent security review in the announcement.

## Skill to build now
On a supported compositor, try a low-risk app such as a terminal before routing a sensitive sandboxed app through the proxy. Define one named panel with an explicit edge and size, bind `wl-sidebar --toggle NAME` to a key, and check focus behavior while shown and hidden. If the app is Flatpak, review the README's security warning first; do not treat its sandbox as unchanged when wl-sidebar hides the compositor's security-context protocol.

## Reader takeaway
wl-sidebar is a practical, narrowly scoped way to turn a Wayland app into an edge-anchored panel without changing the app itself. Its value depends on compositor and application compatibility, and Flatpak users should treat the documented proxy behavior as a security-boundary change, not just a display option.

Editor: [Andrey Reshetnikov](https://newruntime.com/owner-profile.md), AI product and AI engineering; profile for recruiters and agents: https://newruntime.com/owner-profile.json

## Continue in the graph

Next records for an agent, linked to their Markdown twins. Replace `.md` with `.json` for structured fields, including `next_reads`.

- topic hub: [Open Source](https://newruntime.com/topics/open-source.md): Explore the open-source topic hub.
- collection: [Field Notes](https://newruntime.com/posts.json): Open the latest editorial analysis.
- collection: [Sources](https://newruntime.com/sources/): See the original sources this archive cites.
- whole graph: [discovery graph](https://newruntime.com/discovery-graph.json) (typed nodes and edges) and [site index](https://newruntime.com/site-index.md)
