A program to help users work with QMK Firmware.
qmk clone to pull down anyone's qmk_firmware forkqmk setupqmk console to get debugging information from your keyboard(s)qmk doctorqmk compileqmk infoqmk flashqmk lintWe provide "install and go" packages for many Operating Systems.
Packages for several distributions available here: https://github.com/qmk/qmk_fpm
Using Homebrew:
brew install qmk/qmk/qmk
Download our custom MSYS2 installer here: https://msys.qmk.fm/
python3 -m pip install qmkqmk setupWe follow PEP517, you can install using build:
Setup:
python3 -m pip install build
Build:
python3 -m build
You can read more about working with PEP517 packages in the Python Packaging User Guide.
Full documentation: https://docs.qmk.fm/#/tutorial
FAQs
A program to help users work with QMK Firmware.
We found that qmk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.