I3_client - i3 IPC client, written in Erlang

, ,

This is an i3 IPC client implementation, written in Erlang, with zero dependencies. All the messages and events exposed by i3 and Sway are currently supported.

It’s a very early release but it’s fully featured. My next two priorities are improving the test coverage and extending the documentation with examples. Nevertheless, I’ll be happy to hear from early users.

Notable features

  • Variant negotiation - rudimentary capability checks but the fundamentals are ther
  • Automatic reconnection - opt-in but nice to have
  • Multiplexing - a single connection can handle request-response and out-of-band events.

Example

The following example shows how to start a client connection, subscribe to events and run commands. All using the same connection, all idiomatic OTP behaviour.

iex> {:ok, pid} = :i3_client.start_link([])
iex> {:ok, ref} = :i3_client.subscribe(pid, ["window"])
iex> {:ok, _} = :i3_client.run_command(pid, "focus right")
iex> flush()
{:i3_event, ^pid, ^ref, "window", "..."} # Pseudocode but you get the idea

Hex: i3_client | Hex
Source:

7 Likes