Files
komorebi/docs/usage/quickstart-and-autostart.md
T
LGUG2Z c6874ff5db feat(cli): quickstart, autostart and the config commands
komorebic quickstart writes an example komorebi.json and applications.json into
the config home, asking before it writes over a file, so a new user has a
configuration to start from. komorebic enable-autostart writes the XDG autostart
entry that has Plasma start komorebi at login, with the komorebi.json it is
given if any, and disable-autostart takes it away; the NixOS module does the
same job for a machine that has it.

komorebic replace-configuration makes the running daemon start over from another
komorebi.json: it pauses its window manager and brings back the windows it hid,
the back of a stack, so that none is out of sight for the new one to miss, then
makes the window manager again from the file, with the monitors and the windows
the backend has, and watches the new file in place of the old one. A file that
does not read is logged and the daemon carries on as it was.
2026-10-28 07:20:37 -07:00

2.5 KiB

Quickstart and autostart

Quickstart

komorebic quickstart writes two example files into the config home (~/.config/komorebi, or $KOMOREBI_CONFIG_HOME), which it makes if it has to:

When a file is there already, quickstart asks before it writes over it, and leaves the file alone unless the answer is y or yes. It prints the files it wrote, and then tells you to run komorebic start.

komorebic quickstart
komorebic start

Starting komorebi with Plasma

On NixOS, the module starts komorebi with every Plasma session. Elsewhere, komorebic enable-autostart writes an XDG autostart entry, ~/.config/autostart/komorebi.desktop ($XDG_CONFIG_HOME/autostart), which Plasma runs at login, after its workspace has started:

komorebic enable-autostart
komorebic enable-autostart --config ~/mine.json

The entry runs komorebi, or komorebi --config with the file --config names, as the session finds komorebi on its PATH. komorebic disable-autostart takes the entry away again, and says so when there is none.

Do not use both the module and the entry: the session bus gives its name to one komorebi, and the second exits.

Starting over with another file

komorebic replace-configuration makes the running daemon start over from another komorebi.json:

komorebic replace-configuration ~/work.json

The daemon makes its window manager again from the file, as it does at start: it brings back the windows it had hidden, the back of a stack, so that none is out of sight, loads the monitors and the windows that are open from KWin, gives the monitors the entries of the file and tiles them, and from then on watches the new file and not the one it had. It is not the same as changing the file the daemon watches, which Configuration describes: the windows that were in a workspace go where the new file puts them, not where they were. A file that is not a komorebi.json is logged, and the daemon carries on as it was.