qmk setup on openSUSE

Setting up qmk on OpenSUSE to flash your keyboards, isn't as straight forward, mainly because its not able to install the missing dependencies automagically. This will be a little guide on how to do the complete setup as described on their website[1].

Dependencies

To install the required dependencies run the following:

zypper in cross-arm-none-gcc14 cross-avr-gcc14 avrdude dfu-programmer dfu-util avr-libc 

These are the needed compilers and flashing utilities.

qmk CLI install

For the CLI tool, there are a few community packages you can find on OBS. But you can also install it via pip. To install it this way, you first need python3 and git installed, if you don't have that yet run:

zypper in python3 git

Then go to the directory, where you want to have qmk installed and run:

python3 -m venv venv
source venv/bin/activate
pip install qmk

This will create a python virtual environment and install qmk into it. Whenever you want to use qmk in a new terminal session, you have to run the `source venv/bin/active` command from the qmk directory again.

qmk setup

For the initial setup simply run the following command. The `--home` option will set a subdir named `qmk_firmware` as the target the setup will clone the firmware to. The default is to clone it straight into your home dir, which i didn't want.

qmk setup --home ./qmk_firmware/

Answer the questions that come up. After the command finished, check if the output gives you any additional things to do. I for example had to copy the udev file, to have the correct udev rules setup.

cp /path/to/qmk/qmk_firmware/util/udev/50-qmk.rules /etc/udev/rules.d/

flashing

Now you should be able to flash your keyboard. For example to flash a json from the configurator simply do:

qmk flash <path-to-json>

Happy typing!

[1] qmk newbs docs

---

Back to the main page

This page is best viewed on gemini.