https://github.com/qmk/qmk_distro_msys

A Windows one-click installer for the QMK CLI
https://github.com/qmk/qmk_distro_msys

keyboard-firmware msys2 qmk qmk-cli qmk-msys

Last synced: 8 days ago
JSON representation

A Windows one-click installer for the QMK CLI

• Host: GitHub
• URL: https://github.com/qmk/qmk_distro_msys
• Owner: qmk
• License: gpl-3.0
• Created: 2020-12-26T00:20:03.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2025-05-29T01:55:06.000Z (10 months ago)
• Last Synced: 2025-06-10T01:37:01.338Z (9 months ago)
• Topics: keyboard-firmware, msys2, qmk, qmk-cli, qmk-msys
• Language: Inno Setup
• Homepage: https://msys.qmk.fm/
• Size: 9.4 MB
• Stars: 216
• Watchers: 5
• Forks: 68
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# QMK MSYS

> A Windows one-click installer for the QMK CLI

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

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/qmk/qmk_distro_msys/build.yml?logo=github&style=for-the-badge)](https://github.com/qmk/qmk_distro_msys/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)

Want to get started with [QMK Firmware](https://qmk.fm) 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](./docs/public/terminal.png)

## Documentation

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

1. Open the `QMK MSYS` shortcut

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.