mirror of https://github.com/qmk/qmk_cli.git synced 2026-07-25 16:42:55 -04:00

T

Zach White 45a231af0c Add qmk console to the global cli (#84 )

* add qmk console to the global cli

* lazy load hid and usb.core

* lazy load hid and usb.core

2021-08-10 11:25:00 -07:00

.github

Switch to installing the locally built package (#80 )

2021-07-15 21:39:39 -07:00

.vscode

add vscode settings

2021-06-21 22:14:55 -07:00

qmk_cli

Add qmk console to the global cli (#84 )

2021-08-10 11:25:00 -07:00

.editorconfig

Initial version of installable qmk_cli

2019-06-30 15:45:29 -07:00

.gitignore

Add a very lightly tested qmk setup

2019-07-01 00:11:18 -07:00

ci_tests

switch the pip command

2021-07-07 21:19:59 -07:00

Dockerfile

fix the docker build

2021-07-16 13:06:44 -07:00

LICENSE

Initial commit

2019-06-30 12:00:34 -07:00

MANIFEST.in

rip out toml

2019-07-15 11:08:14 -07:00

qmk

Use flit to package instead of setuptools

2019-06-30 20:03:14 -07:00

README.md

Add qmk console to the global cli (#84 )

2021-08-10 11:25:00 -07:00

release

remove the release script

2021-05-10 12:42:11 -07:00

requirements-dev.txt

Bump bleach from 3.3.1 to 4.0.0 (#88 )

2021-08-04 11:22:09 -07:00

requirements.txt

Use flit to package instead of setuptools

2019-06-30 20:03:14 -07:00

SECURITY.md

Create SECURITY.md

2021-06-23 20:27:04 -07:00

setup.cfg

New release: 0.2.1 → 0.2.2

2021-07-16 20:08:42 +00:00

setup.py

switch to the qmk-dotty-dict package (#77 )

2021-07-11 09:22:22 -07:00

README.md

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
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