QMK Configurator is an online tool used for easily creating firmware files for keyboards supported in qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families

What is QMK Firmware? QMK ( Quantum Mechanical Keyboard ) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices.

This page describes the support for Compatible Microcontrollers in QMK. If you have not yet you should read the Keyboard Guidelines to get a sense of how keyboards fit into QMK. QMK has a number of features to simplify working with keyboards. For most, you don't have to write a single line of code. To get started, run qmk new-keyboard:

The simplest way to flash your keyboard will be with the QMK Toolbox. However, the Toolbox is currently only available for Windows and macOS. If you're using Linux (or just wish to flash the firmware from the command line), skip to the Flash your …

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes. Need help? Check out the support page to see how you can get help using QMK.

Most people new to QMK only have 1 keyboard. You can set this keyboard as your default with the qmk config command. For example, to set your default keyboard to clueboard/66/rev4 :

The QMK Configurator is an online graphical user interface that generates QMK Firmware .hex or .bin files. It should be noted that Configurator cannot produce firmwares for keyboards using a different controller than they were designed for, i.e. an RP2040 controller on …

This guide is suitable for everyone who wants to build a keyboard firmware using the source code. If you are already a programmer you will find the process very familiar and easier to follow. There are 3 main sections to this guide: Setup Your Environment; Building Your …

Now that your QMK build environment is set up, you can build a firmware for your keyboard. Start by trying to build the keyboard's default keymap. You should be able to do that with a command in this format: