Skip to content

Hyprland

Library and CLI tool for monitoring the Hyprland socket.

Usage

You can browse the Hyprland reference.

CLI

sh
astal-hyprland # starts monitoring

Library

js
import Hyprland from "gi://AstalHyprland"

const hyprland = Hyprland.get_default()

for (const client of hyprland.get_clients()) {
  print(client.title)
}
py
from gi.repository import AstalHyprland as Hyprland

hyprland = Hyprland.get_default()

for client in hyprland.get_clients():
    print(client.get_title())
lua
local Hyprland = require("lgi").require("AstalHyprland")

local hyprland = Hyprland.get_default()

for _, c in ipairs(hyprland.clients) do
    print(c.title)
end
vala
// Not yet documented

Installation

  1. install dependencies

    sh
    sudo pacman -Syu meson vala valadoc json-glib gobject-introspection
    sh
    sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
    sh
    sudo apt install meson valac valadoc libjson-glib-dev gobject-introspection
  2. clone repo

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

    sh
    meson setup build
    meson install -C build

Released under the LGPL v2.1 License