wlrctl(1)
Control Wayland compositors and their outputs using the wlr-control protocol.
Synopsis
wlrctl [COMMAND] [OPTIONS]Description
wlrctl is a utility for controlling Wayland compositors that support the wlr-control protocol, commonly used with wlroots-based compositors like Sway, Hyprland, and River. It allows you to interact with displays, outputs, and other compositor features from the command line.
The command operates through subcommands that target specific compositor features such as output management, DPMS control, and workspace manipulation depending on compositor capabilities.
Common options
| Flag | What it does |
|---|---|
--help | Show help message and exit |
--version | Print version information |
-s, --socket | Specify the Wayland socket to connect to (default: auto-detect) |
--verbose | Enable verbose output for debugging |
--json | Output results in JSON format where applicable |
Examples
List all connected outputs and their current configuration
wlrctl output listSet the DP-1 output to 2560x1440 resolution at 60Hz
wlrctl output DP-1 set-mode 2560x1440@60Position the HDMI-1 output at coordinates 2560,0 relative to other outputs
wlrctl output HDMI-1 set-position 2560 0Set the built-in display scaling factor to 1.5x
wlrctl output eDP-1 set-scale 1.5List outputs with JSON-formatted details for scripting
wlrctl output --json list