QMK Userspace

This is my personal QMK playground for experimenting with keymaps, features, and modules outside the main QMK repository. It contains the firmware configurations I use for my keyboards and may change whenever I find a new idea to try.

Setup

After completing the standard qmk setup, clone this repository and configure it as the userspace overlay:

cd qmk_userspace
git submodule update --init --recursive
qmk config user.overlay_dir="$(realpath .)"

Build

Build every target listed in qmk.json:

qmk userspace-compile

Or build a single keymap:

qmk compile -kb <keyboard> -km xylo04

Pushing changes also runs the GitHub Actions workflow and publishes the resulting firmware to the repository's Releases page.

Build targets

Manage the targets in qmk.json with:

qmk userspace-list
qmk userspace-add -kb <keyboard> -km <keymap>
qmk userspace-remove -kb <keyboard> -km <keymap>

The QMK repository and revision used by GitHub Actions are configured in .github/workflows/build_binaries.yaml.