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
  • Check that your environment is correctly setup with qmk doctor
  • Dispatches to qmk_firmware/bin/qmk for additional functionality:
    • qmk compile-json
    • More to come

Quickstart

Full documentation: https://docs.qmk.fm/#/tutorial

Basic steps:

  • python3 -m pip install qmk
  • qmk setup

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

Uploaded Source

Built Distribution

qmk-0.0.43-py2.py3-none-any.whl (9.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: qmk-0.0.43.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.8.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

File hashes

Hashes for qmk-0.0.43.tar.gz
Algorithm Hash digest
SHA256 0e1ada32779e47e0a65b0d8f2ff3ca76820ba36b785bf260e1d6971845c169ef
MD5 8a832e22956af41a17d76213a5b54980
BLAKE2b-256 2589f3b0eb01ef9ddd9323d8a5c683c2fe001779a4866f5f1fa589dbaa32e784

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qmk-0.0.43-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.8.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

File hashes

Hashes for qmk-0.0.43-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8c959e92127f33051e6d45517af2f5408e404fb9b4acd4fde4b9d6242504b199
MD5 8182df0982a94e70acaea16e55b286ce
BLAKE2b-256 c40a2987ec884da9a7e380bac19ffd4931bd3229322b9d1f07397473796e22ce

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