Cutieguwu/qmk_cli-mirror

mirror of https://github.com/qmk/qmk_cli.git synced 2026-08-03 07:46:45 -04:00

Files

T

Zach White 9c6123483b housekeeping

2021-03-28 16:23:15 -07:00

773 B

Raw Permalink Blame History

QMK CLI

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 your qmk_firmware for additional functionality:
- qmk c2json
- qmk compile
- qmk flash
- qmk json2c
- qmk lint
- qmk new-keymap

Quickstart

python3 -m pip install qmk
qmk setup

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