Get qmk_firmware on macOS and Linux Now!
Open-source keyboard firmware for Atmel AVR and Arm USB families
Get qmk_firmware with one command
Pick your system, reveal the step-by-step guide, copy the command, paste it into your terminal and press Enter. This command comes from the project's public source.
Not available for Windows yet.
qmk_firmware doesn't publish an install command for Windows anywhere we can verify, so there's nothing for us to show you. We won't invent one. It does document one for macOS and Linux — switch to that tab.
Pastes into PowerShell and installs qmk_firmware on your Windows machine in one step. Runs as your normal user account, and needs no administrator rights.
Not available for macOS yet.
qmk_firmware doesn't publish an install command for macOS or Linux anywhere we can verify, so there's nothing for us to show you. We won't invent one.
Pastes into your terminal and installs qmk_firmware on your macOS or Linux machine in one step — no manual setup, no build tools. It fetches the project's own install script and runs it, which is the standard way these tools ship — worth a read if you like to know what's running.
How to set up qmk_firmware, step by step
Open Terminal. On a Mac it's in Applications ▸ Utilities, or press Cmd+Space and type Terminal. On Linux, press Ctrl+Alt+T. Paste the command and press Enter.
Run qmk_firmware --help to see the available commands, and
qmk_firmware --version to confirm the install worked. If your shell complains about
permissions, that project usually documents a corrected command on its own site.
This downloads the project's shell installer and pipes it straight into your shell, which executes it without saving a file. Same caveat: it's the project's script, but read it first if you want to be sure.
About qmk_firmware
Planck Preonic ErgoDox EZ Clueboard Cluepad Atreus
From qmk_firmware's own README.
About qmk_firmware
Open-source keyboard firmware for Atmel AVR and Arm USB families
| Category | Developer tool |
|---|---|
| Install method | shell one-liner (curl | bash) |
| Windows | no install command published |
| macOS / Linux | documented install command available |
| Price | Free and open source |
| Command verified | From project source |
| Popularity | 21k stars on the project's public repository |
On mobile
qmk_firmware is a command-line tool, so there is no phone app for it — a phone has no shell to run it in. You'll need a desktop, or a remote shell into a machine that has one.
qmk_firmware is developed by its own authors. This page is an independent reference; we are not affiliated with or sponsored by the project. The command shown here was reproduced from the project's public documentation — always check the project's own documentation before running anything.