wlr-which-key

wlr-which-key

Keymap manager for wlroots-based compositors. Inspired by which-key.nvim.

Installation

From Source

cargo install wlr-which-key --locked

Usage

wlr-which-key [config_name]                    # Start with default menu
wlr-which-key --initial-keys "p s"             # Navigate to submenu or execute command

Configuration

Default config file: $XDG_CONFIG_HOME/wlr-which-key/config.yaml or ~/.config/wlr-which-key/config.yaml. Run wlr-which-key --help for more info.

Keybindings may be single characters (e.g. a, B) or xkb key labels (without the XKB_KEY_ prefix, e.g. Return, Insert). Ctrl, Alt, and Mod4/Logo modifiers are supported (like Ctrl+Return or Ctrl+Alt+a or Mod4+Return or Logo+Return). A key may also be a list of strings, in which case a keybinding will match if any of the keys match (e.g. key: [Left, h]) will match both left arrow and 'h'.

When executed a command will normally end the wlr_which_key process. If you want certain commands to keep the UI open after they execute then configure those specific commands with (keep_open: true).

Example config:

…

Old config format (v1.1.0 and earlier)

…