Config API
Use gnoblin.configure for settings, named shortcuts and autostart commands. The reference pages list the supported fields and defaults.
On this page
Functions
gnoblin.configure— set compositor, input and window-management options.gnoblin.window_rule— add a window or layer-surface rule.gnoblin.animation— register a named animation.gnoblin.config— find the config file, read the bundled default and restore it.gnoblin.load— load another Lua config file.gnoblin.snapshot— inspect a copy of the config while it loads.gnoblin.array— mark a Lua table as a list.gnoblin.on— handle compositor and input events.- Lua runtime API — inspect and control the running session.
The named views gnoblin.configure.shortcuts and gnoblin.configure.autostart read or update entries by name. See the shortcuts and autostart guides. Lua's require loader is covered under gnoblin.load.
First config
On first login, gnoblin copies the packaged reference config to
~/.config/gnoblin/init.lua when that file does not exist. It does not replace
an existing config. Edit that file to configure Gnoblin.
Shell
gnoblinctl config path
gnoblinctl config reloadSee configuration recipes for complete examples and the guides for task-based instructions.