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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: qmk-0.3.0.tar.gz
  • Upload date:
  • Size: 12.5 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.0.tar.gz
Algorithm Hash digest
SHA256 70458d6a941f24349bccf8dae8ecc36f73c0256e1ad4ba452d380625db2612a8
MD5 ec298a183a9d7b792bc06ed3f972e32d
BLAKE2b-256 22ef5830d1b453a5a53ef62b0660ac691d1a9cdb74c05eded9524d3e27c45c1c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qmk-0.3.0-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.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d086709af38f1ff059d9adf450f743ff469be47f0bb8273effc745a537cc405a
MD5 f1dd7f8b8b0a9803e03fa0fdde011ea2
BLAKE2b-256 57d2dca8d49efa8586a85fedaf91a487e9f63519c00e419f368fd9379facbd95

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