https://github.com/qmk/qmk_cli

A program to help users work with QMK
https://github.com/qmk/qmk_cli

Last synced: 10 days ago
JSON representation

A program to help users work with QMK

• Host: GitHub
• URL: https://github.com/qmk/qmk_cli
• Owner: qmk
• License: mit
• Created: 2019-06-30T19:00:33.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T04:09:21.000Z (14 days ago)
• Last Synced: 2024-10-30T07:16:41.287Z (14 days ago)
• Language: Python
• Homepage:
• Size: 290 KB
• Stars: 143
• Watchers: 12
• Forks: 37
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# QMK CLI

[![CLI Setup](https://github.com/qmk/qmk_cli/actions/workflows/cli_setup.yml/badge.svg)](https://github.com/qmk/qmk_cli/actions/workflows/cli_setup.yml)

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`

* 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](https://brew.sh):

    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](https://pypi.org/project/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](https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project).

# Documentation

Full documentation: