From 27e891ff90ea672ef2f714a5ca19fb46c3a0ea3e Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Thu, 5 Sep 2024 11:15:39 -0500 Subject: [PATCH] Document how to disable path modifications during install (#7090) Closes https://github.com/astral-sh/uv/issues/6932 --- docs/getting-started/installation.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 501140538..1236d38a7 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -54,6 +54,15 @@ Request a specific version by including it in the URL: $ powershell -c "irm https://astral.sh/uv/0.4.5/install.ps1 | iex" ``` +!!! tip + + The installer will update your shell profiles to ensure the uv binary is on your `PATH`. To + disable this behavior, set `INSTALLER_NO_MODIFY_PATH=1`. For example: + + ``` + INSTALLER_NO_MODIFY_PATH=1 bash -c 'curl -LsSf https://astral.sh/uv/install.sh | sh' + ``` + ### PyPI For convenience, uv is published to [PyPI](https://pypi.org/project/uv/). @@ -117,6 +126,11 @@ When uv is installed via the standalone installer, it can update itself on-deman $ uv self update ``` +!!! tip + + Updating uv will re-run the installer and can modify your shell profiles. To disable this + behavior, set `INSTALLER_NO_MODIFY_PATH=1`. + When another installation method is used, self-updates are disabled. Use the package manager's upgrade method instead. For example, with `pip`: