From 5eba64a6415e3a51f6fa672efddcd8e11bf698ab Mon Sep 17 00:00:00 2001
From: Charlie Marsh <charlie.r.marsh@gmail.com>
Date: Thu, 7 Nov 2024 07:45:06 -0500
Subject: [PATCH] Add installer variables to environment reference (#8874)

## Summary

I decided to omit the new URL options from the installer configuration
page since they're pretty niche.
---
 crates/uv-static/src/env_vars.rs  | 22 +++++++++++++++++++++-
 docs/configuration/environment.md | 12 +++++++++++-
 2 files changed, 32 insertions(+), 2 deletions(-)

diff --git a/crates/uv-static/src/env_vars.rs b/crates/uv-static/src/env_vars.rs
index de21b1aa4..4ba81b876 100644
--- a/crates/uv-static/src/env_vars.rs
+++ b/crates/uv-static/src/env_vars.rs
@@ -448,7 +448,7 @@ impl EnvVars {
     #[attr_hidden]
     pub const PYTHONUTF8: &'static str = "PYTHONUTF8";
 
-    /// Adds directories to Python module search path (e.g., PYTHONPATH=/path/to/modules).
+    /// Adds directories to Python module search path (e.g., `PYTHONPATH=/path/to/modules`).
     pub const PYTHONPATH: &'static str = "PYTHONPATH";
 
     /// Used in tests to enforce a consistent locale setting.
@@ -528,4 +528,24 @@ impl EnvVars {
 
     /// Ignore `.env` files when executing `uv run` commands.
     pub const UV_NO_ENV_FILE: &'static str = "UV_NO_ENV_FILE";
+
+    /// The URL from which to download uv using the standalone installer and `self update` feature,
+    /// in lieu of the default GitHub URL.
+    pub const UV_INSTALLER_GITHUB_BASE_URL: &'static str = "UV_INSTALLER_GITHUB_BASE_URL";
+
+    /// The URL from which to download uv using the standalone installer and `self update` feature,
+    /// in lieu of the default GitHub Enterprise URL.
+    pub const UV_INSTALLER_GHE_BASE_URL: &'static str = "UV_INSTALLER_GHE_BASE_URL";
+
+    /// The directory in which to install uv using the standalone installer and `self update` feature.
+    /// Defaults to `~/.cargo/bin`.
+    pub const UV_INSTALL_DIR: &'static str = "UV_INSTALL_DIR";
+
+    /// Used ephemeral environments like CI to install uv to a specific path while preventing
+    /// the installer from modifying shell profiles or environment variables.
+    pub const UV_UNMANAGED_INSTALL: &'static str = "UV_UNMANAGED_INSTALL";
+
+    /// Avoid modifying the `PATH` environment variable when installing uv using the standalone
+    /// installer and `self update` feature.
+    pub const INSTALLER_NO_MODIFY_PATH: &'static str = "INSTALLER_NO_MODIFY_PATH";
 }
diff --git a/docs/configuration/environment.md b/docs/configuration/environment.md
index 3eb1e07fe..1f6d61c71 100644
--- a/docs/configuration/environment.md
+++ b/docs/configuration/environment.md
@@ -164,7 +164,7 @@ uv respects the following environment variables:
 - <a id="GITHUB_ACTIONS"></a> [`GITHUB_ACTIONS`](#GITHUB_ACTIONS): Used for trusted publishing via `uv publish`.
 - <a id="ACTIONS_ID_TOKEN_REQUEST_URL"></a> [`ACTIONS_ID_TOKEN_REQUEST_URL`](#ACTIONS_ID_TOKEN_REQUEST_URL): Used for trusted publishing via `uv publish`. Contains the oidc token url.
 - <a id="ACTIONS_ID_TOKEN_REQUEST_TOKEN"></a> [`ACTIONS_ID_TOKEN_REQUEST_TOKEN`](#ACTIONS_ID_TOKEN_REQUEST_TOKEN): Used for trusted publishing via `uv publish`. Contains the oidc request token.
-- <a id="PYTHONPATH"></a> [`PYTHONPATH`](#PYTHONPATH): Adds directories to Python module search path (e.g., PYTHONPATH=/path/to/modules).
+- <a id="PYTHONPATH"></a> [`PYTHONPATH`](#PYTHONPATH): Adds directories to Python module search path (e.g., `PYTHONPATH=/path/to/modules`).
 - <a id="NETRC"></a> [`NETRC`](#NETRC): Use to set the .netrc file location.
 - <a id="PAGER"></a> [`PAGER`](#PAGER): The standard `PAGER` posix env var. Used by `uv` to configure the appropriate pager.
 - <a id="JPY_SESSION_NAME"></a> [`JPY_SESSION_NAME`](#JPY_SESSION_NAME): Used to detect when running inside a Jupyter notebook.
@@ -178,3 +178,13 @@ uv respects the following environment variables:
   for more.
 - <a id="UV_ENV_FILE"></a> [`UV_ENV_FILE`](#UV_ENV_FILE): `.env` files from which to load environment variables when executing `uv run` commands.
 - <a id="UV_NO_ENV_FILE"></a> [`UV_NO_ENV_FILE`](#UV_NO_ENV_FILE): Ignore `.env` files when executing `uv run` commands.
+- <a id="UV_INSTALLER_GITHUB_BASE_URL"></a> [`UV_INSTALLER_GITHUB_BASE_URL`](#UV_INSTALLER_GITHUB_BASE_URL): The URL from which to download uv using the standalone installer and `self update` feature,
+  in lieu of the default GitHub URL.
+- <a id="UV_INSTALLER_GHE_BASE_URL"></a> [`UV_INSTALLER_GHE_BASE_URL`](#UV_INSTALLER_GHE_BASE_URL): The URL from which to download uv using the standalone installer and `self update` feature,
+  in lieu of the default GitHub Enterprise URL.
+- <a id="UV_INSTALL_DIR"></a> [`UV_INSTALL_DIR`](#UV_INSTALL_DIR): The directory in which to install uv using the standalone installer and `self update` feature.
+  Defaults to `~/.cargo/bin`.
+- <a id="UV_UNMANAGED_INSTALL"></a> [`UV_UNMANAGED_INSTALL`](#UV_UNMANAGED_INSTALL): Used ephemeral environments like CI to install uv to a specific path while preventing
+  the installer from modifying shell profiles or environment variables.
+- <a id="INSTALLER_NO_MODIFY_PATH"></a> [`INSTALLER_NO_MODIFY_PATH`](#INSTALLER_NO_MODIFY_PATH): Avoid modifying the `PATH` environment variable when installing uv using the standalone
+  installer and `self update` feature.