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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: qmk-0.3.2.tar.gz
  • Upload date:
  • Size: 12.2 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.2.tar.gz
Algorithm Hash digest
SHA256 edfa1e831e0a8a986b7dac78d1293990800eab869c2acf40cffb1fcfcbacf00e
MD5 19070a591bc2c933b99a3b2d6f751ed5
BLAKE2b-256 1bdd2cfbca724e161e750f4ec530fb4c79d9fc8b1e09b67bf33d5ab61b30388b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qmk-0.3.2-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.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 85fa0eb9cea0cd0425115922c6160e8dfa73de303d99be0c02259bf74f5bed7e
MD5 801fa4ff9d51094bdc00ad835d6d0d23
BLAKE2b-256 b15b87e3b1104bb72ec3584dd5f7c040e64a8c3c9a44614d1788fa0a1d8aba45

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