aboutsummaryrefslogtreecommitdiff
path: root/docs/cli.md
diff options
context:
space:
mode:
authorQMK Bot <[email protected]>2025-05-07 14:42:14 +0000
committerQMK Bot <[email protected]>2025-05-07 14:42:14 +0000
commit084ed078d682b49ee3d26db032bedf9a6fbbd384 (patch)
treee54bee9d6efd56e23b6991e0566159f4fa97987d /docs/cli.md
parentb76bf29d251c55bb746d8ab5d0c04fd6a16a7fb5 (diff)
parent32204095e52c5492f8eabc2821b779564a430d74 (diff)
downloadqmk_firmware-084ed078d682b49ee3d26db032bedf9a6fbbd384.tar.gz
qmk_firmware-084ed078d682b49ee3d26db032bedf9a6fbbd384.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/cli.md')
-rw-r--r--docs/cli.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md
index 36983d5e00..ab25a480ab 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.9 (or later) installed and have installed pip. Then install QMK with this command: