OSSForks/qmk_cli
1
0
Fork 0
mirror of https://github.com/carlos-sousa-tech/qmk_cli.git synced 2026-01-20 14:12:56 +00:00
Code Issues Projects Releases Packages Wiki Activity
A program to help users work with QMK
364 commits 1 branch 0 tags 415 KiB
Find a file
Exact
QMK Bot 0dd2280781 New release: 1.1.8 → 1.2.0
2025-11-27 12:59:23 +00:00
.github Align QMK distrib search with qmk_firmware. (#219) 2025-11-27 23:35:47 +11:00
.vscode add vscode settings 2021-06-21 22:14:55 -07:00
qmk_cli New release: 1.1.8 → 1.2.0 2025-11-27 12:59:23 +00:00
.bumpversion.cfg New release: 1.1.8 → 1.2.0 2025-11-27 12:59:23 +00: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 Disable qmk config -a test due to deficient milc. 2024-02-23 21:10:12 +11:00
Dockerfile Global install of QMK bootstrap distribution. (#216) 2025-11-27 07:07:38 +00: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
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 Update build status badge 2024-10-28 02:43:10 +00:00
release remove the release script 2021-05-10 12:42:11 -07:00
requirements-dev.txt remove non-direct dependencies 2021-08-23 15:13:24 -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: 1.1.8 → 1.2.0 2025-11-27 12:59:23 +00:00
trigger_packages Fixup package rebuild trigger for qmk_fpm. 2024-02-23 22:02:32 +11:00

README.md

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

Packages

We provide "install and go" packages for many Operating Systems.

Linux

Packages for several distributions available here: https://github.com/qmk/qmk_fpm

macOS

Using Homebrew:

brew install qmk/qmk/qmk

Windows

Download our custom MSYS2 installer here: https://msys.qmk.fm/

Quickstart

  • python3 -m pip install qmk
  • qmk setup

Building

We follow PEP517, you can install using build:

Setup:

python3 -m pip install build

Build:

python3 -m build

You can read more about working with PEP517 packages in the Python Packaging User Guide.

Documentation

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