3步搭好QMK开发环境:从工具链到QMK固件编译完整走通
【免费下载链接】qmk_firmwareOpen-source keyboard firmware for Atmel AVR and Arm USB families项目地址: https://gitcode.com/GitHub_Trending/qm/qmk_firmware
QMK 是面向机械键盘的开源固件,支持 Atmel AVR 与 Arm USB 系列芯片。本文带你用三步搭好 QMK 开发环境:装编译器工具链、装 QMK CLI、初始化固件仓库,再用一次试编译验证。完成后即可开始 QMK 固件编译、自定义键位与固件刷写,Windows、macOS、Linux/WSL 全程约半小时。
环境认知:搭好 QMK 开发环境后能做什么
装环境本质上只装三样东西:AVR/ARM 交叉编译器、qmk 命令行工具、固件仓库源码。三者就位后,你可以:
- 为自己的键盘编写键位映射,执行 QMK 固件编译;
- 用
qmk compile一条命令产出可烧录的.hex固件; - 通过 USB 把固件写入芯片,立即生效。
路线决策:一张表选对你的安装方式
先按系统对号入座,后文主线安装直接照此执行:
| 平台 | 推荐路线 | 理由 |
|---|---|---|
| Windows | QMK MSYS 一体安装包 | MSYS2、qmk CLI、AVR/ARM 工具链全部内置,开箱即用 |
| macOS | Homebrew Tap | 两条 brew 命令装齐全部依赖,自动解析 |
| Linux / WSL | 系统包管理器 + pip/uv | apt/dnf/pacman 装工具链,pip 装 CLI |
| FreeBSD | pkg | 官方包系统直接提供 AVR/ARM 工具链 |
⚠️ Windows 不建议手工拼凑 MSYS2 组件;macOS 不建议单独找编译器包,用 Tap 最省心。
三步主线:工具链 → QMK CLI → 固件仓库
所有平台都是同一个顺序,只是每步的命令不同。
第 1 步:安装 AVR/ARM 交叉编译器工具链
Windows(QMK MSYS):安装程序已内置 AVR-GCC、ARM-GCC 与 DFU 烧录工具,无需再装 ✅ macOS:工具链会随 QMK 的 formula 一起安装,也不用单独处理。
Linux 与 FreeBSD 用各自包管理器安装:
# Ubuntu/Debian sudo apt install -y avr-libc avrdude binutils-avr gcc-avr gcc-arm-none-eabi binutils-arm-none-eabi # Fedora sudo dnf install -y avr-libc avrdude avr-gcc avr-binutils arm-none-eabi-gcc arm-none-eabi-binutils # Arch Linux sudo pacman -S avr-libc avrdude avr-gcc arm-none-eabi-gcc arm-none-eabi-binutils # FreeBSD(含 avrdude 等烧录工具) sudo pkg install -y avr-gcc avr-libc arm-none-eabi-gcc arm-none-eabi-newlib avrdude dfu-programmer dfu-util成功的标志:avr-gcc --version与arm-none-eabi-gcc --version都能打印版本号。
⚠️ 两个平台差异各记一句:Apple Silicon(M 系列)芯片没有预编译工具链,需在本地编译,首次安装多花 30~60 分钟;WSL2 下要在 Windows 端装 usbipd 做 USB 直通,物理键盘才能被识别,编译 QMK 本身不受影响。
第 2 步:一条命令装好 QMK CLI
Windows 用户在完成 QMK MSYS 安装后已自带 CLI(安装时选默认路径C:\QMK_MSYS,建议勾选“添加到 Windows Terminal”)。其余平台:
# macOS:Homebrew 安装 QMK(官方 Tap,两条命令) brew tap qmk/qmk brew install qmk/qmk/qmk # Linux / WSL:pip 安装到用户目录 python3 -m pip install --user qmk # 有 uv 的话也可以:uv tool install qmk # FreeBSD sudo python3 -m pip install qmkArch Linux 走官方仓库也行:sudo pacman -S qmk,开发版yay -S qmk-git。
成功的标志:which qmk有输出。若提示找不到命令,说明 CLI 安装目录不在 PATH 里,补两行即可:
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc source ~/.bashrc第 3 步:用 qmk setup 初始化固件仓库
qmk setup是必做的收尾一步:克隆仓库、装构建依赖、生成配置文件,提示统一回答y。
# 方式一:一条命令初始化(推荐,默认克隆到 ~/qmk_firmware) qmk setup # 方式二:手动克隆后构建 git clone https://gitcode.com/GitHub_Trending/qm/qmk_firmware # 仓库想放别处 qmk setup -H ~/qmk_firmware_custom维护自己 fork 的开发者可以指向它:qmk setup <你的用户名>/qmk_firmware。
成功的标志:命令结束出现仓库目录,进入后能看到Makefile、keyboards/等主目录文件。
验证 QMK 固件编译:试编译与默认配置
qmk --version qmk compile -kb planck/rev6 -km default qmk config user.keyboard=planck/rev6 user.keymap=default成功的标志:编译结束出现类似The firmware size is fine - 26356/28672的提示,且目录里多出planck_rev6_default.hex文件 ✅
常用配置项(qmk config 键=值设置):
| 配置项 | 作用 | 示例 |
|---|---|---|
user.keyboard | 默认键盘,后续直接qmk compile即可 | clueboard/66/rev4 |
user.keymap | 默认键位映射名 | default |
user.name | 你的 GitHub 用户名 | 自行填写 |
常见问题速查:现象、原因、解决
| 现象 | 可能原因 | 解决办法 |
|---|---|---|
qmk: command not found | CLI 目录不在 PATH | export PATH="$HOME/.local/bin:$PATH"并写入~/.bashrc |
| Windows 安装程序无法启动 | 系统兼容性问题 | 以管理员身份运行安装程序 |
| Windows 下载中断或误报 | 网络不稳/杀毒拦截 | 临时关闭实时保护,将 QMK_MSYS 目录加入排除列表 |
| macOS 安装长时间无输出 | Apple Silicon 本地编译工具链 | 属正常现象,等待 30~60 分钟 |
| 键盘 USB 设备无反应 | 缺少 udev 权限 | 为厂商号feed建立 udev 规则并重载规则 |
| 编译报依赖缺失 | 子模块不完整 | 执行qmk git-submodule,或重跑qmk setup -y |
| Windows 编译速度慢 | 实时扫描拖慢读写 | 排除仓库目录 + 使用 SSD |
搭好之后:接下来做三件事
至此,你可以编译仓库里任何受支持键盘的固件了。建议按顺序推进:先读键位映射文档、改一遍keymap.c,完成第一次键位定制;再装 QMK Toolbox,把刚编译出的.hex刷进键盘;平时维护用git pull更新仓库(macOS 可加brew upgrade qmk更新 CLI),有卡壳的地方再回头翻上面的速查表。
【免费下载链接】qmk_firmwareOpen-source keyboard firmware for Atmel AVR and Arm USB families项目地址: https://gitcode.com/GitHub_Trending/qm/qmk_firmware
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考