mirror of
https://github.com/qmk/qmk_cli.git
synced 2026-07-25 16:42:55 -04:00
dependabot[bot]
39a271132b
* Bump docker/build-push-action from 6.18.0 to 7.0.0 Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 6.18.0 to 7.0.0. - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](https://github.com/docker/build-push-action/compare/v6.18.0...v7.0.0) --- updated-dependencies: - dependency-name: docker/build-push-action dependency-version: 7.0.0 dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Apply suggestions from code review Co-authored-by: Joel Challis <git@zvecr.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joel Challis <git@zvecr.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!
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 qmkqmk 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