QMK CLI
A program to help users work with QMK Firmware.
Features
- Interact with your qmk_firmware tree from any location
- Use
qmk cloneto pull down anyone'sqmk_firmwarefork - Setup your build environment with
qmk setup - Use
qmk consoleto get debugging information from your keyboard(s) - Check that your environment is correctly setup with
qmk doctor - Integrates with qmk_firmware for additional functionality:
qmk compileqmk infoqmk flashqmk lint- ...and many more!
Packages
We provide "install and go" packages for many Operating Systems.
Linux
Packages for several distributions available here: https://github.com/qmk/qmk_fpm
macOS
Using Homebrew:
brew install qmk/qmk/qmk
Windows
Download our custom MSYS2 installer here: https://msys.qmk.fm/
Quickstart
python3 -m pip install qmkqmk setup
Building
We 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.
Documentation
Full documentation: https://docs.qmk.fm/#/tutorial
Release files for qmk 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| qmk-1.2.0.tar.gz | 14.2 kB | Without provenance | Details for qmk-1.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| qmk-1.2.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for qmk-1.2.0-py2.py3-none-any.whl |
Total release size: 29.5 kB
Release files / qmk-1.2.0.tar.gz
| Download URL | qmk-1.2.0.tar.gz |
|---|---|
| Size | 14.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
164bd16c4c401b2b765ee4f017bcfa8141942ddf362961c4cba1975d8cb28a48
|
|
BLAKE2b-256 checksum How to use checksums |
ddd25719002aad78ac452f3fbd0f195c6f3d0429c4fe338b294b7b02a446b826
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / qmk-1.2.0-py2.py3-none-any.whl
| Download URL | qmk-1.2.0-py2.py3-none-any.whl |
|---|---|
| Size | 15.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
77fa04a24d36feb7f19f19f190eaf350b78a5caf5ef6a783251902e853fd1809
|
|
BLAKE2b-256 checksum How to use checksums |
0b424df974e0378fe66bd2fa8361cce3f3243208a601d49772f7a91d209a2175
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for qmk 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
