Keychron QMK Firmware

Official QMK firmware for Keychron and Lemokey keyboards. This repository contains the firmware source, build configurations, and keymaps for 63+ boards across the Q, Q HE, Q Max, K HE, K Max, K Pro, V, V Max, C Pro, S, X, and Lemokey series.

Why Open Source?

Keychron is the first major keyboard brand to fully open-source both its firmware and hardware design. We believe you should be able to see, verify, and modify every line of code that runs on your keyboard. Open source means full transparency — no black boxes between you and your hardware.

We also want to build something bigger than what any single company can do alone. By opening our firmware to the community, developers and enthusiasts can push what keyboards are capable of — custom keymaps, new features, creative workflows — and those contributions make every Keychron keyboard better for everyone.

Features

• Hall Effect magnetic switch support — adjustable actuation and rapid trigger on HE boards
• Wireless connectivity — Bluetooth 5.1 and 2.4 GHz firmware for wireless models
• Keychron Launcher — remap keys, tune HE settings, and configure lighting from your browser with no setup
• RGB Matrix lighting — per-key RGB effects and customization
• Multiple layout variants — ANSI, ISO, and JIS for every supported board
• Full QMK feature set — layers, tap-dance, combos, macros, encoders, OLED, and more

Getting Started

Option A: Use Keychron Launcher (no code required)

If you just want to remap keys, tune Hall Effect settings, or change lighting, you don't need to build firmware:

1. Open Keychron Launcher in a Chromium-based browser such as Google Chrome, Microsoft Edge, Brave, Opera, or Vivaldi
2. Connect your Keychron keyboard via USB
3. Remap keys, configure layers, adjust lighting, and fine-tune HE sensitivity — changes apply instantly

Keychron Launcher works out of the box with no JSON import required, and supports features beyond VIA such as Hall Effect actuation point tuning and rapid trigger configuration. Safari and other non-Chromium browsers will not work with Keychron Launcher.

Option B: Build from source

Set up your build environment and compile custom firmware:

python3 -m pip install qmk
qmk setup Keychron/qmk_firmware
qmk compile -kb keychron/q1_he/ansi_encoder -km keychron
qmk flash -kb keychron/q1_he/ansi_encoder -km keychron

More build examples:

make keychron/q1_he/ansi_encoder:keychron
make keychron/k8_pro/ansi/rgb:keychron
make keychron/v1_max/ansi_encoder:keychron:flash

See the QMK build environment setup and make guide for details. New to QMK? Start with the Complete Newbs Guide.

Supported Keyboards

All board definitions live under keyboards/keychron/ and keyboards/lemokey/.

Each board folder contains its own readme.md with exact build targets, product links, and reset instructions.

Hardware Design

For PCB files, schematics, and hardware design resources, see the companion repository:

Keychron-Keyboards-Hardware-Design

Community and Support

• Join the community
  Join the Keychron Discord to share builds, ask questions, and help grow the hardware modding community.
• Keychron Website
• Keychron on Reddit
• QMK Discord
• QMK Documentation

Contributing

Contributions are welcome — whether it's a new keymap, a bug fix, or documentation improvement. See docs/contributing.md for guidelines on submitting pull requests.

License

This project is licensed under the GNU General Public License v2.0.

This repository tracks the upstream QMK firmware with Keychron-specific board definitions and firmware additions.