Description:

qmk 1.1.5

QMK CLI

A program to help users work with QMK Firmware.
Features

Interact with your qmk_firmware tree from any location
Use qmk clone to pull down anyone's qmk_firmware fork
Setup your build environment with qmk setup
Use qmk console to 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 compile
qmk info
qmk flash
qmk 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 qmk
qmk 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

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter