nirius 0.3.0

Utility commands for the niri wayland compositor
Documentation

Nirius: utility commands for niri

builds.sr.ht status License GPL 3 or later dependency status Hits-of-Code

Some utility commands for the niri wayland compositor. You have to start the niriusd daemon and then issue commands using the nirius utility. The daemon is best started by adding spawn-at-startup "niriusd" to niri's config.kdl.

Commands

  • focus [OPTIONS]: Focuses a matching window if there is one, otherwise exits non-zero. What windows match is specified using the options --app-id (-a) and --title (-t), both regular expressions. If there are multiple matching windows, the command cycles through them.
  • focus-or-spawn [OPTIONS] [COMMAND]...: Same behavior as focus except that it spawns COMMAND instead of exiting non-zero if no matching window exists.
  • toggle-mark: Marks or unmarks a window. Marked windows can be focused using focus-marked.
  • focus-marked: Focuses the marked window or cycles through all marked windows.
  • list-marked: Lists all marked windows on stdout.
  • nop: Does nothing except having the side-effect of clearing the list of already visited windows captured during a sequence of focus, focus-or-spawn, or focus-marked commands.
  • toggle-follow-mode: Enables or disables follow mode for the currently focused window. When switching to another workspace, all windows in follow mode are moved to that workspace. (The main use-case for follow mode are floating video player windows, e.g., firefox Picture-in-Picture windows.)

Questions & Patches

For asking questions, sending feedback, or patches, refer to my public inbox (mailinglist). Please mention the project you are referring to in the subject, e.g., nirius (or other projects in different repositories).

Bugs

It compiles, therefore there are no bugs. Oh well, if you still found one or want to request a feature, you can do so here.

Build status

builds.sr.ht status

License

Nirius is licensed under the GPLv3 (or later).