aboutsummaryrefslogtreecommitdiffstats
path: root/docs/newbs_getting_started.md
diff options
context:
space:
mode:
authorNathan Cain2025-05-07 16:41:37 +0200
committerGitHub2025-05-07 16:41:37 +0200
commit32204095e52c5492f8eabc2821b779564a430d74 (patch)
tree1ba7f1d8ac384499ba0ecde7fd0d2e942392e09f /docs/newbs_getting_started.md
parent396fb4dde75a10486c538ac173afb8d35c33a868 (diff)
Docs update for installing qmk with uv (#24995)
Diffstat (limited to 'docs/newbs_getting_started.md')
-rw-r--r--docs/newbs_getting_started.md6
1 files changed, 6 insertions, 0 deletions
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:
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.