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!

Quickstart

  • python3 -m pip install qmk
  • qmk setup

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-0.3.3.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

qmk-0.3.3-py2.py3-none-any.whl (13.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: qmk-0.3.3.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.11

File hashes

Hashes for qmk-0.3.3.tar.gz
Algorithm Hash digest
SHA256 cbe79d36cadcc227e6571dec9218fd5d123c58169621647f27775a3befca65eb
MD5 154d866fa2eefb80c0670539d70d2587
BLAKE2b-256 7ecc0c024ca5d7f0aba53cec961bd5eba24d3a5ff8fd04c82d7dbcf1d983a857

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qmk-0.3.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.11

File hashes

Hashes for qmk-0.3.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 899e8f491928acbb8aef161b55affdb79bab2e686d99a7ca527b82a7339f9702
MD5 06a4d2cc9e35637b7a937bbbcda3fa2c
BLAKE2b-256 6054074c215b1a2210255a0f66a524477add3eb909090c858913820657444fcc

See more details on using hashes here.

Supported by

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