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!

Quickstart

Follow our documentation to get started.

Packages

We provide "install and go" packages for many Operating Systems.

macOS

Using Homebrew:

brew install qmk/qmk/qmk

Windows

Download our custom MSYS2 installer here: https://msys.qmk.fm/

Building

We follow PEP517, you can install using build:

Setup:

python3 -m pip install --group dev

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