https://github.com/qmk/qmk_distro_wsl

A pre-configured WSL distro for working with the QMK CLI
https://github.com/qmk/qmk_distro_wsl

keyboard-firmware qmk qmk-cli qmk-wsl wsl2

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/qmk/qmk_distro_wsl
• Owner: qmk
• License: gpl-3.0
• Created: 2021-01-26T15:07:18.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-02-20T14:18:28.000Z (over 1 year ago)
• Last Synced: 2025-06-02T09:22:38.980Z (about 1 year ago)
• Topics: keyboard-firmware, qmk, qmk-cli, qmk-wsl, wsl2
• Language: Python
• Homepage: https://wsl.qmk.fm/
• Size: 9.34 MB
• Stars: 33
• Watchers: 4
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# QMK WSL

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

[![Latest Release](https://img.shields.io/github/v/release/qmk/qmk_distro_wsl?color=3D87CE&label=Latest&sort=semver&style=for-the-badge)](https://github.com/qmk/qmk_distro_wsl/releases/latest)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/qmk/qmk_distro_wsl/build.yml?logo=github&style=for-the-badge)](https://github.com/qmk/qmk_distro_wsl/actions?query=workflow%3ACI+branch%3Amain)

[![Discord](https://img.shields.io/discord/440868230475677696.svg?logo=discord&logoColor=white&color=7289DA&style=for-the-badge)](https://discord.gg/qmk)

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](./docs/public/terminal.png)

## Documentation

1. Install [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install-win10)

1. Install the [latest release](https://github.com/qmk/qmk_distro_wsl/releases/latest)

1. Run [`qmk setup`](https://docs.qmk.fm/#/newbs_getting_started?id=set-up-qmk)

1. Run [`qmk compile`](https://docs.qmk.fm/#/newbs_getting_started?id=_4-test-your-build-environment)

1. Profit!

Full documentation is available at .

## Official Website

[qmk.fm](https://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.