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

T

Zach White f8fe363999 Modernize the qmk_cli package (#91 )

* bring our package into the future

* trigger the OS packages upon a successful build

* fix windows

* trim deps

* remove the qmk_cli module from setup

2021-08-12 09:53:28 -07:00

.github

Modernize the qmk_cli package (#91 )

2021-08-12 09:53:28 -07:00

.vscode

add vscode settings

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

qmk_cli

New release: 0.2.2 → 0.3.0

2021-08-11 02:54:39 +00:00

.editorconfig

…

.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

…

MANIFEST.in

rip out toml

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

pyproject.toml

Modernize the qmk_cli package (#91 )

2021-08-12 09:53:28 -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

Modernize the qmk_cli package (#91 )

2021-08-12 09:53:28 -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

Modernize the qmk_cli package (#91 )

2021-08-12 09:53:28 -07:00

trigger_packages

Modernize the qmk_cli package (#91 )

2021-08-12 09:53:28 -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