Skip to content
forked from qmk/qmk_cli

A program to help users work with QMK

License

Notifications You must be signed in to change notification settings

rawlingsr/qmk_cli

 
 

Repository files navigation

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
  • Integrates with qmk_firmware for additional functionality:
    • qmk compile
    • qmk console
    • qmk flash
    • qmk lint
    • ...and many more!

Quickstart

  • python3 -m pip install qmk
  • qmk setup

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

About

A program to help users work with QMK

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 90.2%
  • Shell 7.7%
  • Dockerfile 2.1%