mirror of
https://github.com/qmk/qmk_cli.git
synced 2026-08-03 07:46:45 -04:00
Zach White
23 lines
717 B
Markdown
23 lines
717 B
Markdown
# QMK CLI
|
|
[](https://github.com/qmk/qmk_cli/actions?query=workflow%3A%22CLI+Setup%22)
|
|
A program to help users work with [QMK Firmware](https://qmk.fm/).
|
|
|
|
# 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`
|