From 32204095e52c5492f8eabc2821b779564a430d74 Mon Sep 17 00:00:00 2001 From: Nathan Cain <13713501+nathanscain@users.noreply.github.com> Date: Wed, 7 May 2025 09:41:37 -0500 Subject: [PATCH] Docs update for installing qmk with uv (#24995) --- docs/cli.md | 12 ++++++++++++ docs/newbs_getting_started.md | 6 ++++++ 2 files changed, 18 insertions(+) diff --git a/docs/cli.md b/docs/cli.md index 7d4c10cedd7..b46180cddec 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -18,6 +18,18 @@ export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment ``` +### Install Using uv {#install-using-uv} + +If you have installed [uv](https://docs.astral.sh/uv/), the QMK CLI can be installed and managed as a uv tool: + +``` +uv tool install qmk +export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` +qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment +``` + +This installation can be updated via `uv tool upgrade qmk`. See [Upgrading tools](https://docs.astral.sh/uv/guides/tools/#upgrading-tools) for more information. + ### Install Using pip {#install-using-easy_install-or-pip} If your system is not listed above you can install QMK manually. First ensure that you have Python 3.7 (or later) installed and have installed pip. Then install QMK with this command: diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index 9ebcccc77f2..1d2b60781b8 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -101,6 +101,12 @@ Install the QMK CLI by running: python3 -m pip install --user qmk ``` +Alternatively, install the QMK CLI as a [uv](https://docs.astral.sh/uv/) managed tool, kept isolated in a virtual environment (requires uv to be installed): + +```sh +uv tool install qmk +``` + #### Community Packages These packages are maintained by community members, so may not be up to date or completely functional. If you encounter problems, please report them to their respective maintainers.