summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2025-05-07 14:42:14 +0000
committerQMK Bot <hello@qmk.fm>2025-05-07 14:42:14 +0000
commit084ed078d682b49ee3d26db032bedf9a6fbbd384 (patch)
treee54bee9d6efd56e23b6991e0566159f4fa97987d
parentb76bf29d251c55bb746d8ab5d0c04fd6a16a7fb5 (diff)
parent32204095e52c5492f8eabc2821b779564a430d74 (diff)
Merge remote-tracking branch 'origin/master' into develop
-rw-r--r--docs/cli.md12
-rw-r--r--docs/newbs_getting_started.md6
2 files changed, 18 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`
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.9 (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.9 (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 9ebcccc77f..1d2b60781b 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -101,6 +101,12 @@ Install the QMK CLI by running:
101python3 -m pip install --user qmk 101python3 -m pip install --user qmk
102``` 102```
103 103
104Alternatively, 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):
105
106```sh
107uv tool install qmk
108```
109
104#### Community Packages 110#### Community Packages
105 111
106These 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. 112These 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.