astal/docs/libraries/river.md

River

Library and CLI tool for monitoring the River Wayland Compositor.

Installation

1. install dependencies

:::code-group

sudo pacman -Syu meson json-glib gobject-introspection

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

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

:::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:

meson setup --prefix /usr build

:::

Usage

You can browse the River reference.

CLI

astal-river --help

Library

:::code-group

// Not yet documented

# Not yet documented

-- Not yet documented

// Not yet documented

:::