summaryrefslogtreecommitdiff
path: root/docs/cli.md
diff options
context:
space:
mode:
authorNathan Cain <13713501+nathanscain@users.noreply.github.com>2025-05-07 09:41:37 -0500
committerGitHub <noreply@github.com>2025-05-07 15:41:37 +0100
commit32204095e52c5492f8eabc2821b779564a430d74 (patch)
tree1ba7f1d8ac384499ba0ecde7fd0d2e942392e09f /docs/cli.md
parent396fb4dde75a10486c538ac173afb8d35c33a868 (diff)
Docs update for installing qmk with uv (#24995)
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 7d4c10cedd..b46180cdde 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`
18qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment 18qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
19``` 19```
20 20
21### Install Using uv {#install-using-uv}
22
23If you have installed [uv](https://docs.astral.sh/uv/), the QMK CLI can be installed and managed as a uv tool:
24
25```
26uv tool install qmk
27export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
28qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
29```
30
31This installation can be updated via `uv tool upgrade qmk`. See [Upgrading tools](https://docs.astral.sh/uv/guides/tools/#upgrading-tools) for more information.
32
21### Install Using pip {#install-using-easy_install-or-pip} 33### Install Using pip {#install-using-easy_install-or-pip}
22 34
23If 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: 35If 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: