mirror of
https://github.com/qmk/qmk_cli.git
synced 2026-07-25 16:42:55 -04:00
af2ef5d90f3adf19cd64643690fa33a89065f679
Bumps [actions/checkout](https://github.com/actions/checkout) from 6 to 7. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v6...v7) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
QMK CLI
A program to help users work with QMK Firmware.
Features
- Interact with your qmk_firmware tree from any location
- Use
qmk cloneto pull down anyone'sqmk_firmwarefork - Setup your build environment with
qmk setup - Use
qmk consoleto 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 compileqmk infoqmk flashqmk lint- ...and many more!
Quickstart
Follow our documentation to get started.
Packages
We provide "install and go" packages for many Operating Systems.
macOS
Using Homebrew:
brew install qmk/qmk/qmk
Windows
Download our custom MSYS2 installer here: https://msys.qmk.fm/
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
Languages
Python
91.6%
Dockerfile
4.6%
Shell
3.8%