Back to Noctalia

IPC & Keybinds

v5-ipc.md

latest2.6 KB
Original Source

IPC & Keybinds

IPC commands let you control Noctalia from a terminal, a compositor keybind, a script, or a hook.

All commands use this shape:

Terminal window

noctalia msg <command>

For example:

Terminal window

noctalia msg dock-togglenoctalia msg volume-upnoctalia msg panel-toggle launchernoctalia msg screenshot-region

Command lists

Section titled “Command lists”

ShellStatus, config reload, settings, window switcher, and session actions.

SurfacesBar, panels, dock, desktop widgets, and lockscreen widgets.

Media & UINotifications, clipboard, media controls, wallpaper, theme, and screenshots.

PluginsPlugin event dispatch and plugin/source management.

System ControlsVolume, microphone, brightness, night light, Wi-Fi, Bluetooth, caffeine, power profile, and display power.

Compositor keybinds

Section titled “Compositor keybinds”

A compositor keybind only needs to launch a Noctalia command. The command part is compositor-agnostic:

Terminal window

noctalia msg panel-toggle launchernoctalia msg panel-toggle control-centernoctalia msg settings-togglenoctalia msg volume-up

Use your compositor’s normal exec, spawn, or command-binding syntax to run those commands.

NiriNiri bind syntax, overview integration, wallpaper backdrop, and blur.

HyprlandHyprland Lua bind syntax, persistent workspaces, and blur.

Sway / ScrollSway-style bind syntax for Noctalia launcher, panels, settings, audio, and brightness.

MangoMango effects and bind syntax for Noctalia launcher, panels, settings, audio, and brightness.

Discovering commands

Section titled “Discovering commands”

Not sure what else you can control? You can see all IPC commands via this terminal command:

Terminal window

noctalia msg --help

Using IPC in config

Section titled “Using IPC in config”

Some config fields accept normal shell commands. Idle behaviors and hooks also accept the noctalia: shorthand:

[idle.behavior.lock]timeout = 660command = "noctalia:session lock"
[hooks]started = "noctalia msg panel-toggle launcher"

Both styles call the same command registry. Use noctalia msg ... in a terminal or compositor keybind, and noctalia:... where a Noctalia config field documents that shorthand.