Files
komorebi/docs/linux/usage/quickstart-and-autostart.md
T
LGUG2Z d781028a2a refactor(repo): move the KDE and macOS docs under docs/ (pure move)
komorebi-for-kde/docs/ -> docs/linux/
komorebi-for-mac/docs/ -> docs/macos/

The Windows docs stay where they are (docs/). Renames only, so links and include paths
that named the old directories are broken at this revision; they are fixed in the revision
that fixes the paths of the whole layout move.
2026-11-05 15:03:27 -08:00

2.7 KiB

Quickstart and autostart

Quickstart

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

  • komorebi.json, which is docs/komorebi.example.json: eight workspaces on the first monitor, each with another layout, and some padding;
  • applications.json, which is komorebic/applications.json, the rules komorebi.json names for the applications that need them;
  • skhdrc, which is docs/skhdrc.sample: the key bindings of the sample, in the format of skhd, which the daemon and komorebic hotkeys compile read from there.

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.