QMK CLI

CLI Setup

A program to help users work with QMK Firmware.

Features

  • Interact with your qmk_firmware tree from any location
  • Use qmk clone to pull down anyone's qmk_firmware fork
  • Setup your build environment with qmk setup
  • Use qmk console to get debugging information from your keyboard(s)
  • Check that your environment is correctly setup with qmk doctor
  • Integrates with qmk_firmware for additional functionality:
    • qmk compile
    • qmk info
    • qmk flash
    • qmk lint
    • ...and many more!

Packages

We provide "install and go" packages for many Operating Systems.

Linux

Packages for several distributions available here: https://github.com/qmk/qmk_fpm

macOS

Using Homebrew:

brew install qmk/qmk/qmk

Windows

Download our custom MSYS2 installer here: https://msys.qmk.fm/

Quickstart

  • python3 -m pip install qmk
  • qmk setup

Building

We follow PEP517, you can install using build:

Setup:

python3 -m pip install build

Build:

python3 -m build

You can read more about working with PEP517 packages in the Python Packaging User Guide.

Documentation

Full documentation: https://docs.qmk.fm/#/tutorial

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for qmk from gravatar.com qmk Avatar for skully from gravatar.com skully

Credits

Author: skullydazed

License

MIT License (MIT License)

Requires

Python >=3.9

Classifiers

Report project as malware

Release files for qmk 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qmk 1.2.0
File Size Uploaded
qmk-1.2.0.tar.gz 14.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qmk 1.2.0
File Interpreter ABI Platform
qmk-1.2.0-py2.py3-none-any.whl 15.4 kB Python 2, Python 3 none any Details

Total release size: 29.5 kB

Release files / qmk-1.2.0.tar.gz

Download URL qmk-1.2.0.tar.gz
Size 14.2 kB
Tags Source
SHA-256 checksum
How to use checksums 		164bd16c4c401b2b765ee4f017bcfa8141942ddf362961c4cba1975d8cb28a48
BLAKE2b-256 checksum
How to use checksums 		ddd25719002aad78ac452f3fbd0f195c6f3d0429c4fe338b294b7b02a446b826
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / qmk-1.2.0-py2.py3-none-any.whl

Download URL qmk-1.2.0-py2.py3-none-any.whl
Size 15.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums 		77fa04a24d36feb7f19f19f190eaf350b78a5caf5ef6a783251902e853fd1809
BLAKE2b-256 checksum
How to use checksums 		0b424df974e0378fe66bd2fa8361cce3f3243208a601d49772f7a91d209a2175
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.2.0 CPython/3.9.25

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files

1.1.8

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.4.0

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.52

2 release files

0.0.51

2 release files

0.0.50

2 release files

0.0.49

2 release files

0.0.48

2 release files

0.0.46

2 release files

0.0.45

2 release files

0.0.44

2 release files

0.0.43

2 release files

0.0.42

2 release files

0.0.41

2 release files

0.0.40

2 release files

0.0.39

2 release files

0.0.38

2 release files

0.0.37

2 release files

0.0.36

2 release files

0.0.35

2 release files

0.0.34

2 release files

0.0.33

2 release files

0.0.32

2 release files

0.0.31

2 release files

0.0.30

2 release files

0.0.29

2 release files

0.0.28

2 release files

0.0.27

2 release files

0.0.26

2 release files

0.0.25

2 release files

0.0.24

2 release files

0.0.23

2 release files

0.0.22

2 release files

0.0.21

2 release files

0.0.20

2 release files

0.0.19

2 release files

0.0.18

2 release files

0.0.17

2 release files

0.0.16

2 release files

0.0.15

2 release files

0.0.14

2 release files

0.0.13

2 release files

0.0.12

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page