qmk_distro_msys icon indicating copy to clipboard operation
qmk_distro_msys copied to clipboard

A Windows one-click installer for the QMK CLI

QMK MSYS

A Windows one-click installer for the QMK CLI

Latest Release GitHub Workflow Status Discord

Want to get started with QMK Firmware quickly? Running Windows 8/10 and want to avoid installation headaches? Look no further!

Bundling MSYS2 + QMK CLI together, this installer package aims to give you a QMK build environment with as little effort as possible.

terminal example

Documentation

  1. Install the latest release
  2. Open the QMK MSYS shortcut
  3. Run qmk setup
  4. Run qmk compile
  5. Profit!

Full documentation is available at https://msys.qmk.fm/.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.