QMK MSYS

# Frequently Asked Questions

# Why is <action> so slow?

This is a general issue with MSYS2. File IO heavy operations, such as git queries or compilation are just generally slower under MSYS2. Current QMK build processes exaggerate the problem (for example in its discovery of available keyboards). More advanced users might be better served by one of the other available environments (opens new window).

This issue (opens new window) is tracking QMKs portion of the problem.

# Can I run this alongside regular MSYS2?

As it installs to its own location, both can be installed at the same time. However its worth noting the home directory would be shared between the two.

# Can I install additional tools?

Anything available to MSYS2 can also installed to QMK MSYS. For more details, refer to the MSYS2 documentation (opens new window).

# How do I keep my environment up to date?

Periodic updates will be available to cover both major MSYS2, and QMK CLI updates. Installing the most recent release (opens new window) will ensure you have the latest requirements to build QMK firmware.

Interim updates have to be performed manually. This can done within the terminal by running the following commands:

Here be dragons 
# Update the package database and core system packages with:
pacman -Syu  

# If needed, close QMK MSYS, run it again from Start menu. Update the rest with:
pacman -Su

# How do I configure Windows Terminal?

Windows Terminal (opens new window), which supports various shells, can also be extended to support QMK MSYS. Just tick the "Add QMK MSYS profile to Windows Terminal" checkbox during installation.

If you would prefer to do this manually, create a new empty profile in Windows Terminal settings:

  • Name: QMK MSYS
  • Command line: %SystemDrive%/QMK_MSYS/shell_connector.cmd
  • Icon: %SystemDrive%/QMK_MSYS/icon.ico

Note that this example assumes that you have QMK MSYS installed to the default location (generally C:\QMK_MSYS).

# More Coming Soon...

Need help with something?

The best place to get quick support is going to be on our Discord (opens new window). There is usually somebody online, and there are a bunch of very helpful people there.

← Contributing →