diff options
| author | Ivan Molodetskikh <yalterz@gmail.com> | 2024-03-29 14:13:01 +0400 |
|---|---|---|
| committer | Ivan Molodetskikh <yalterz@gmail.com> | 2024-03-29 14:13:01 +0400 |
| commit | 0470a833a19b4a18df4d67662a1a64264fad436c (patch) | |
| tree | dfd33f1291ec8ef9d65a0477025ab8945f337df5 /wiki | |
| parent | 092420ec5a54f1cd5f4f59b75a60f5cfa7cceacd (diff) | |
| download | niri-0470a833a19b4a18df4d67662a1a64264fad436c.tar.gz niri-0470a833a19b4a18df4d67662a1a64264fad436c.tar.bz2 niri-0470a833a19b4a18df4d67662a1a64264fad436c.zip | |
Move IPC into wiki
Diffstat (limited to 'wiki')
| -rw-r--r-- | wiki/IPC.md | 12 | ||||
| -rw-r--r-- | wiki/_Sidebar.md | 1 |
2 files changed, 13 insertions, 0 deletions
diff --git a/wiki/IPC.md b/wiki/IPC.md new file mode 100644 index 00000000..853c3c3f --- /dev/null +++ b/wiki/IPC.md @@ -0,0 +1,12 @@ +You can communicate with the running niri instance over an IPC socket. +Check `niri msg --help` for available commands. + +The `--json` flag prints the response in JSON, rather than formatted. +For example, `niri msg --json outputs`. + +For programmatic access, check the [niri-ipc sub-crate](./niri-ipc/) which defines the types. +The communication over the IPC socket happens in JSON. + +> [!TIP] +> If you're getting parsing errors from `niri msg` after upgrading niri, make sure that you've restarted niri itself. +> You might be trying to run a newer `niri msg` against an older `niri` compositor. diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md index 23aa65cb..da8566f1 100644 --- a/wiki/_Sidebar.md +++ b/wiki/_Sidebar.md @@ -2,6 +2,7 @@ * [Example systemd Setup](./Example-systemd-Setup.md) * [Important Software](./Important-Software.md) * [Layer‐Shell Components](./Layer%E2%80%90Shell-Components.md) +* [`niri msg`](./IPC.md) * [VSCode, Chromium, WezTerm](./Application-Issues.md) * [Xwayland](./Xwayland.md) |