Astal

Appearance

River ​

Library and CLI tool for monitoring the River Wayland Compositor.

Installation ​

  1. install dependencies
sh
sudo pacman -Syu meson json-glib gobject-introspection
sh
sudo dnf install meson gcc json-glib-devel gobject-introspection-devel
sh
sudo apt install meson libjson-glib-dev gobject-introspection
  1. clone repo
sh
git clone https://github.com/aylur/astal.git
cd astal/lib/river
  1. install
sh
meson setup build
meson install -C build

TIP

Most distros recommend manual installs in /usr/local, which is what meson defaults to. If you want to install to /usr instead which most package managers do, set the prefix option:

sh
meson setup --prefix /usr build

Usage ​

You can browse the River reference.

CLI ​

sh
astal-river --help

Library ​

js
import River from "gi://AstalRiver"

const river = River.get_default()

for (const output of river.get_outputs()) {
    print(output.name)
}
py
from gi.repository import AstalRiver as River

river = River.get_default()

for output in river.get_outputs():
    print(output.get_name())
lua
local River = require("lgi").require("AstalRiver")

local river = River.River.get_default()

for _, o in ipairs(river.outputs) do
    print(o.name)
end
vala
// Not yet documented