River

Library and CLI tool for monitoring the River Wayland Compositor.

Usage

You can browse the River reference.

CLI

astal-river --help

Library

JavaScript

import River from "gi://AstalRiver"

const river = River.get_default()

for (const output of river.get_outputs()) {
  print(output.name)
}

Python

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

Installation

1. install dependencies

   Arch

   sudo pacman -Syu meson json-glib gobject-introspection

   Fedora

   sudo dnf install meson gcc json-glib-devel gobject-introspection-devel

   Ubuntu

   sudo apt install meson libjson-glib-dev gobject-introspection

2. clone repo

   git clone https://github.com/aylur/astal.git
   cd astal/lib/river

3. install

   meson setup build
   meson install -C build