Skip to main content

A program to help users work with QMK Firmware.

Project description

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 details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qmk-1.1.8.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

qmk-1.1.8-py2.py3-none-any.whl (14.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file qmk-1.1.8.tar.gz.

File metadata

  • Download URL: qmk-1.1.8.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for qmk-1.1.8.tar.gz
Algorithm Hash digest
SHA256 0b426b6bf20aeb5b67806b2e127303e26c9245cfe265581d6046cc5edc29059d
MD5 1741bf16868a71c95ed5a35adc03faf4
BLAKE2b-256 3b76633222ed56333f0f6c82c29cb4afaa1e3e21b938445a34337978263d1e38

See more details on using hashes here.

File details

Details for the file qmk-1.1.8-py2.py3-none-any.whl.

File metadata

  • Download URL: qmk-1.1.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for qmk-1.1.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 906150909f7db948c9f131f095b275fd66e1e6ce0e78410607ca02e1efa02de7
MD5 514e9d0d66935ac86a58bad62f810458
BLAKE2b-256 1656fd6a95bb67dc7fa5eb4434a6aab8b71d97f2c606d335414b748569f2afab

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page