FreshPorts -- sysutils/py-qmk: CLI program for working with QMK firmware

Port details

py-qmk CLI program for working with QMK firmware

1.1.5_1 sysutils =2 1.1.5Version of this port present on the latest quarterly branch.

There is no maintainer for this port.

Any concerns regarding this port should be directed to the FreeBSD Ports mailing list via ports@FreeBSD.org

Port Added: 2021-02-18 21:12:31

Last Update: 2025-03-08 04:05:21

Commit Hash: 06a08e6

People watching this port, also watch:: jdictionary, py311-Automat, py311-python-gdsii, py311-PyOpenGL, p5-Sane

Also Listed In: python

License: MIT

WWW:

https://github.com/qmk/qmk_cli

Description:

A program to help users work with QMK keyboard 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 - Check that your environment is correctly setup with qmk doctor

¦ ¦ ¦ ¦

Manual pages:

FreshPorts has no man page information for this port.

pkg-plist: as obtained via: make generate-plist

There is no configure plist information for this port.

Dependency lines:

${PYTHON_PKGNAMEPREFIX}qmk>0:sysutils/py-qmk@${PY_FLAVOR}

To install the port:

cd /usr/ports/sysutils/py-qmk/ && make install clean

To add the package, run one of these commands:

pkg install sysutils/py-qmk
pkg install py311-qmk

NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above.
NOTE: This is a Python port. Instead of py311-qmk listed in the above command, you can pick from the names under the Packages section.

PKGNAME: py311-qmk

Package flavors (<flavor>: <package>)

py311: py311-qmk

distinfo:

TIMESTAMP = 1719110823 SHA256 (qmk-1.1.5.tar.gz) = 2efe3c752230c6ba24b8719c3b6e85a5644bf8f7d0dd237757eda9b7b7e60b11 SIZE (qmk-1.1.5.tar.gz) = 12074

Packages (timestamps in pop-ups are UTC):

py39-qmk
ABI	aarch64	amd64	armv6	armv7	i386	powerpc	powerpc64	powerpc64le
FreeBSD:13:latest	-	-	-	-	-	-	-	-
FreeBSD:13:quarterly	-	-	-	-	-	-	1.0.0_1	1.0.0_1
FreeBSD:14:latest	-	-	-	-	-	1.0.0_1	-	1.0.0_1
FreeBSD:14:quarterly	-	-	-	-	-	-	1.0.0_1	1.0.0_1
FreeBSD:15:latest	-	-	n/a	-	n/a	-	1.0.0_1	-

py311-qmk
ABI	aarch64	amd64	armv6	armv7	i386	powerpc	powerpc64	powerpc64le
FreeBSD:13:latest	1.1.5_1	1.1.5_1	-	-	1.1.5_1	-	-	-
FreeBSD:13:quarterly	1.1.5_1	1.1.5_1	-	1.1.5_1	1.1.5_1	-	-	-
FreeBSD:14:latest	1.1.5_1	1.1.5_1	-	-	1.1.5_1	-	-	-
FreeBSD:14:quarterly	1.1.5	1.1.5_1	-	1.1.5	1.1.5_1	-	-	-
FreeBSD:15:latest	1.1.5_1	1.1.5_1	n/a	1.1.5_1	n/a	-	-	-

Dependencies

NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.

Build dependencies:

py311-setuptools>=63.1.0 : devel/py-setuptools@py311
python3.11 : lang/python311

Test dependencies:

python3.11 : lang/python311

Runtime dependencies:

py311-dotty-dict>=0 : devel/py-dotty-dict@py311
py311-flake8>=0 : devel/py-flake8@py311
py311-hid>=0 : comms/py-hid@py311
py311-hjson>=0 : textproc/py-hjson@py311
py311-jsonschema>=3 : devel/py-jsonschema@py311
py311-milc>=1.4.0 : devel/py-milc@py311
py311-nose2>=0 : devel/py-nose2@py311
py311-pygments>=0 : textproc/py-pygments@py311
py311-pyrsistent>=0 : devel/py-pyrsistent@py311
py311-pyusb>=0 : devel/py-pyusb@py311
py311-yapf>=0 : textproc/py-yapf@py311
arm-none-eabi-gcc>0 : devel/arm-none-eabi-gcc
avr-gcc>0 : devel/avr-gcc
avr-libc>0 : devel/avr-libc
avrdude>0 : devel/avrdude
dfu-programmer>0 : comms/dfu-programmer
dfu-util>0 : comms/dfu-util
git : devel/git
python3.11 : lang/python311

There are no ports dependent upon this port

Configuration Options:

No options to configure

Options name:

sysutils_py-qmk

USES:

python shebangfix

pkg-message:

For install:: Setup ===== Before finishing the setup of QMK by running `qmk setup`, it is advised to install the python3 package first: # pkg install python3 The reason for this is that the qmk_firmware scripts which are downloaded during the setup expect python3 to be installed (instead of /usr/local/bin/python3.11). Granting Write Permissions to USB Controllers ============================================= Flashing images to controllers as a non-root user requires some additional setup: 1. Add the user to the "operator" group: # pw groupmod operator -m piotr 2. Add the following ruleset to /etc/devfs.rules: [qmk=10] add path 'ttyU*' mode 0660 group operator 3. Enable "qmk" ruleset: # sysrc devfs_set_rulesets+="/dev=qmk" 4. Restart the devfs service to load the new rules: # service devfs restart

Master Sites:

Expand this list (2 items)

Collapse this list.

Number of commits found: 22

Commit	Credits	Log message
Commit History - (may be incomplete: for full details, see links to repositories near top of page)
1.1.5_1 08 Mar 2025 04:05:21	Charlie Li (vishwin)	python: bump all USE_PYTHON=distutils consumers after RUN_DEPENDS removal Any missed ports, feel free to bump. Any ports that need setuptools at runtime can have the devel/py-setuptools manually added back to RUN_DEPENDS, but understand that this practice is deprecated; see CHANGES for details.
1.1.5 23 Jun 2024 04:26:37	Wen Heping (wen)	sysutils/py-qmk: Update to 1.1.5 PR: 279597 Reported by: uqs@
1.0.0_1 28 Apr 2024 20:26:08	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Return to the pool
1.0.0_1 23 Apr 2023 09:09:58	Gerald Pfeifer (gerald)	*: Bump PORTREVISIONs for math/mpc update to 1.3.1
1.0.0 11 Jan 2023 15:58:34	Dmitry Marakasov (amdmi3)	/: rename CHEESESHOP to PYPI in MASTER_SITES PR: 267994 Differential revision: D37518 Approved by: bapt
07 Sep 2022 21:58:51	Stefan Eßer (se)	Remove WWW entries moved into port Makefiles Commit b7f05445c00f has added WWW entries to port Makefiles based on WWW: lines in pkg-descr files. This commit removes the WWW: lines of moved-over URLs from these pkg-descr files. Approved by: portmgr (tcberner)
1.0.0 07 Sep 2022 21:10:59	Stefan Eßer (se)	Add WWW entries to port Makefiles It has been common practice to have one or more URLs at the end of the ports' pkg-descr files, one per line and prefixed with "WWW:". These URLs should point at a project website or other relevant resources. Access to these URLs required processing of the pkg-descr files, and they have often become stale over time. If more than one such URL was present in a pkg-descr file, only the first one was tarnsfered into the port INDEX, but for many ports only the last line did contain the port specific URL to further information. There have been several proposals to make a project URL available as a macro in the ports' Makefiles, over time. (Only the first 15 lines of the commit message are shown above )
1.0.0 16 Feb 2022 10:18:16	Ulrich Spörlein (uqs)	sysutils/py-qmk: Upgrade to 1.0.0 Differential Revision: https://reviews.freebsd.org/D33655
0.1.1 09 Jul 2021 14:53:31	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Update to 0.1.1 - Redirect test results to /dev/null. We don't need them.
0.1.0 27 Jun 2021 14:44:57	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Update to 0.1.0
0.0.52 24 Jun 2021 11:15:33	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Update to 0.0.52
0.0.51 28 May 2021 20:03:19	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Update to 0.0.51
0.0.49 25 May 2021 10:34:36	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Update to 0.0.49
0.0.48 12 May 2021 18:45:50	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Fix tests
0.0.48 11 May 2021 13:29:00	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Update to 0.0.48
0.0.46 11 May 2021 09:04:19	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Update to 0.0.46
0.0.45 30 Apr 2021 12:25:30	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Use devfs setup instructions It's better to recommend using devfs_set_rulesets instead of devfs_system_ruleset to change device file permissions under /dev.
0.0.45 15 Apr 2021 09:36:26	Mateusz Piotrowski (0mp)	sysutils/py-qmk: Update to 0.0.45 Also add a simple test target.
0.0.40 07 Apr 2021 08:09:01	Mathieu Arnold (mat)	One more small cleanup, forgotten yesterday. Reported by: lwhsu
0.0.40 06 Apr 2021 14:31:07	Mathieu Arnold (mat)	Remove # $FreeBSD$ from Makefiles.
0.0.40 02 Mar 2021 22:20:45	0mp	Update to 0.0.40 Also, explain how to configure USB for qmk flash.
0.0.39 18 Feb 2021 21:06:54	0mp	Add sysutils/py-qmk A program to help users work with QMK keyboard 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 - Check that your environment is correctly setup with qmk doctor WWW: https://github.com/qmk/qmk_cli

Number of commits found: 22

Login
User Login Create account

Servers and bandwidth provided by
New York Internet, iXsystems, and RootBSD

This site
What is FreshPorts? About the authors Issues FAQ How big is it? Security Policy Privacy Blog Contact

Search
Enter Keywords: more...

Latest Vulnerabilities

gitlab	Apr 24
redis	Apr 24
redis62	Apr 24
redis72	Apr 24
valkey	Apr 24
chromium	Apr 23
ungoogled-chromium	Apr 23
navidrome	Apr 22
erlang	Apr 20
erlang-runtime21	Apr 20
erlang-runtime22	Apr 20
erlang-runtime23	Apr 20
erlang-runtime24	Apr 20
erlang-runtime25	Apr 20
erlang-runtime26	Apr 20

14 vulnerabilities affecting 332 ports have been reported in the past 14 days

^* - modified, not new

All vulnerabilities

Last processed:
2025-04-25 06:28:01 UTC

Ports
Home Categories Deleted ports Sanity Test Failures Newsfeeds

Statistics

Graphs
NEW Graphs (Javascript)

Calculated hourly:

Port count	33285
Broken	124
Deprecated	367
Ignore	241
Forbidden	1
Restricted	2
No CDROM	1
Vulnerable	36
Expired	32
Set to expire	311
Interactive	0
new 24 hours	4
new 48 hours	5
new 7 days	22
new fortnight	39
new month	87