astal/docs/libraries/hyprland.md

Hyprland

Library and CLI tool for monitoring the Hyprland socket.

Installation

1. install dependencies

:::code-group

sudo pacman -Syu meson vala json-glib gobject-introspection

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

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

:::

2. clone repo

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

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 Hyprland reference.

CLI

astal-hyprland # starts monitoring

Library

:::code-group

import Hyprland from "gi://AstalHyprland";

const hyprland = Hyprland.get_default()

console.log(hyprland.get_clients().map(c => c.title))

# Not yet documented

-- Not yet documented

// Not yet documented

:::