glazewm

GlazeWM-js ·

JS library for inter-process communication (IPC) with GlazeWM. Programmatically query GlazeWM's state, subscribe to events, and run WM commands with a simple and type-safe API.

The library is packaged for CommonJS and ESM. Can be used from both NodeJS and the browser (e.g. in an Electron or Tauri application).

Installation

ws needs to be additionally installed on NodeJS. The built-in Websocket API is used on browsers.

Using npm:

npm i ws
npm i glazewm

Using yarn:

yarn add ws
yarn add glazewm

Example usage

import { WmClient } from 'glazewm';

const client = new WmClient();

// Listen for connection events to the IPC server.
client.onConnect(() => console.log('Connected!'));
client.onDisconnect(() => console.log('Disconnected!'));
client.onError(() => console.log('Connection error!'));

// Get monitors, active workspaces, and windows.
const monitors = await client.getMonitors();
const workspaces = await client.getWorkspaces();
const windows = await client.getWindows();

// Run a WM command.
await client.runCommand('focus workspace 1');

// Run a WM command with a given context container. This way we can target the
// container to operate on. If no context container is specified, it defaults to
// the currently focused container.
await client.runCommand('move left', windows[0]);

// Listen to a WM event (e.g. whenever the focused container changes).
await client.subscribe(
  WmEventType.FocusChanged,
  (event: FocusChangedEvent) => console.log(event),
);

// Listen to multiple WM events.
await client.subscribeMany(
  [WmEventType.WorkspaceActivated, WmEventType.WorkspaceDeactivated],
  (event: WorkspaceActivatedEvent | WorkspaceDeactivatedEvent) =>
    console.log(event),
);