Where Does xremap Look for Its Config?
xremap takes its config as a positional file argument with no default search path; ~/.config/xremap/ is the convention.
Last updated
xremap treats config as an argument, not a discovery. You pass one or more YAML files positionally; multiples merge (modmap, keymap and modifiers fold into the first). There is no ~/.config auto-load to surprise you.
That explicitness shapes workflows: systemd units and launch scripts name the file, --watch=config reloads it live, and --validate-config lints it cold. Keep the file in ~/.config/xremap/ by convention and reference it absolutely everywhere.
Where xremap stores this, by platform
~/.config/xremap/config.yml
modmap, keymap, modes, devices. No default path: pass it every run. Multiple files merge; --watch=config plus device flags cover live reload and hotplug.
Frequently asked questions
Where is xremap's default config location?
There is none. Unlike most tools, xremap never searches; every invocation names its files (xremap config.yml). The community convention is ~/.config/xremap/, enforced by habit not code.
How do I check my config without grabbing devices?
Run xremap --validate-config config.yml. It performs full checks without touching devices, so no sudo dance is needed to catch syntax errors.
Notice an outdated path? Let us know.