Browse Source

Merge remote-tracking branch 'origin/master' into develop

QMK Bot 1 year ago
parent
commit
084ed078d6
2 changed files with 18 additions and 0 deletions
  1. 12 0
      docs/cli.md
  2. 6 0
      docs/newbs_getting_started.md

+ 12 - 0
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
 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}
 ### 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.9 (or later) installed and have installed pip. Then install QMK with this command:
 If your system is not listed above you can install QMK manually. First ensure that you have Python 3.9 (or later) installed and have installed pip. Then install QMK with this command:

+ 6 - 0
docs/newbs_getting_started.md

@@ -101,6 +101,12 @@ Install the QMK CLI by running:
 python3 -m pip install --user qmk
 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
 #### 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.
 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.