/qmk_api

QMK API, information on keyboards and keymaps, and a compile service.

Primary LanguagePythonOtherNOASSERTION

QMK Compiler API

JSON API for building a customized firmware.

Join the chat at https://gitter.im/qmk/qmk_compiler_api

Goals

  • Make it easy for apps to compile custom firmware
  • Generate a compiled firmware for any QMK keyboard

Style

We follow the style guidelines for QMK and have provided a yapf config in setup.cfg.

How Do I Use This API?

Our documentation lives on GitBook and can be found here:

https://docs.compile.qmk.fm