qmk_distro_wsl icon indicating copy to clipboard operation
qmk_distro_wsl copied to clipboard

A pre-configured WSL distro for working with the QMK CLI

QMK WSL

A pre-configured WSL distro for working with the QMK CLI

Latest Release GitHub Workflow Status Discord

Based on the exact same environment as QMK uses for CI, this installer package aims to give you a QMK build environment with as little effort as possible.

terminal example

Documentation

  1. Install WSL2
  2. Install the latest release
  3. Run qmk setup
  4. Run qmk compile
  5. Profit!

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.