Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

document uv version for environment variables (#15196) 

## Summary

As new environment variables get introduced (e.g. `UV_EDITABLE`) I
thought it would useful to start tracking which release they were
introduced. I think its a common workflow to navigate to the [env var
documentation](https://docs.astral.sh/uv/reference/environment) to know
what the env var for something is but then end up in a situation where
one is using an environment variable with the wrong version of uv and
not notice immediately that its not compatible and therefore ignored.

## Test Plan

Existing tests.

The versions in `since` have all been manually reviewed to the best of
my ability for correctness.
This commit is contained in:
samypr100 2025-10-08 13:31:12 -04:00 committed by GitHub
parent 1051709792
commit f81c6b9a62
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 443 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
crates/uv-dev/src/generate_env_vars_reference.rs
View File

@ -80,28 +80,32 @@ fn generate() -> String {
// Partition and sort environment variables into UV_ and external variables. // Partition and sort environment variables into UV_ and external variables.
let (uv_vars, external_vars): (BTreeSet<_>, BTreeSet<_>) = EnvVars::metadata() let (uv_vars, external_vars): (BTreeSet<_>, BTreeSet<_>) = EnvVars::metadata()
.iter() .iter()
.partition(|(var, _)| var.starts_with("UV_")); .partition(|(var, _, _)| var.starts_with("UV_"));
output.push_str("uv defines and respects the following environment variables:\n\n"); output.push_str("uv defines and respects the following environment variables:\n\n");
for (var, doc) in uv_vars { for (var, doc, added_in) in uv_vars {
output.push_str(&render(var, doc)); output.push_str(&render(var, doc, added_in));
} }
output.push_str("\n\n## Externally defined variables\n\n"); output.push_str("\n\n## Externally defined variables\n\n");
output.push_str("uv also reads the following externally defined environment variables:\n\n"); output.push_str("uv also reads the following externally defined environment variables:\n\n");
for (var, doc) in external_vars { for (var, doc, added_in) in external_vars {
output.push_str(&render(var, doc)); output.push_str(&render(var, doc, added_in));
} }
output output
} }
/// Render an environment variable and its documentation. /// Render an environment variable and its documentation.
fn render(var: &str, doc: &str) -> String { fn render(var: &str, doc: &str, added_in: Option<&str>) -> String {
if let Some(added_in) = added_in {
format!("### `{var}`\n<small class=\"added-in\">added in `{added_in}`</small>\n\n{doc}\n\n")
} else {
format!("### `{var}`\n\n{doc}\n\n") format!("### `{var}`\n\n{doc}\n\n")
} }
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {

29
crates/uv-macros/src/lib.rs
View File

@ -77,6 +77,14 @@ fn get_env_var_pattern_from_attr(attrs: &[Attribute]) -> Option<String> {
.map(|lit_str| lit_str.value()) .map(|lit_str| lit_str.value())
} }
fn get_added_in(attrs: &[Attribute]) -> Option<String> {
attrs
.iter()
.find(|a| a.path().is_ident("attr_added_in"))
.and_then(|attr| attr.parse_args::<LitStr>().ok())
.map(|lit_str| lit_str.value())
}
fn is_hidden(attrs: &[Attribute]) -> bool { fn is_hidden(attrs: &[Attribute]) -> bool {
attrs.iter().any(|attr| attr.path().is_ident("attr_hidden")) attrs.iter().any(|attr| attr.path().is_ident("attr_hidden"))
} }
@ -92,6 +100,7 @@ pub fn attribute_env_vars_metadata(_attr: TokenStream, input: TokenStream) -> To
.filter_map(|item| match item { .filter_map(|item| match item {
ImplItem::Const(item) if !is_hidden(&item.attrs) => { ImplItem::Const(item) if !is_hidden(&item.attrs) => {
let doc = get_doc_comment(&item.attrs); let doc = get_doc_comment(&item.attrs);
let added_in = get_added_in(&item.attrs);
let syn::Expr::Lit(syn::ExprLit { let syn::Expr::Lit(syn::ExprLit {
lit: syn::Lit::Str(lit), lit: syn::Lit::Str(lit),
.. ..
@ -100,13 +109,14 @@ pub fn attribute_env_vars_metadata(_attr: TokenStream, input: TokenStream) -> To
return None; return None;
}; };
let name = lit.value(); let name = lit.value();
Some((name, doc)) Some((name, doc, added_in))
} }
ImplItem::Fn(item) if !is_hidden(&item.attrs) => { ImplItem::Fn(item) if !is_hidden(&item.attrs) => {
// Extract the environment variable patterns. // Extract the environment variable patterns.
if let Some(pattern) = get_env_var_pattern_from_attr(&item.attrs) { if let Some(pattern) = get_env_var_pattern_from_attr(&item.attrs) {
let doc = get_doc_comment(&item.attrs); let doc = get_doc_comment(&item.attrs);
Some((pattern, doc)) let added_in = get_added_in(&item.attrs);
Some((pattern, doc, added_in))
} else { } else {
None // Skip if pattern extraction fails. None // Skip if pattern extraction fails.
} }
@ -116,9 +126,11 @@ pub fn attribute_env_vars_metadata(_attr: TokenStream, input: TokenStream) -> To
.collect(); .collect();
let struct_name = &ast.self_ty; let struct_name = &ast.self_ty;
let pairs = constants.iter().map(|(name, doc)| { let pairs = constants.iter().map(|(name, doc, added_in)| {
quote! { if let Some(added_in) = added_in {
(#name, #doc) quote! { (#name, #doc, Some(#added_in)) }
} else {
quote! { (#name, #doc, None) }
} }
}); });
@ -127,7 +139,7 @@ pub fn attribute_env_vars_metadata(_attr: TokenStream, input: TokenStream) -> To
impl #struct_name { impl #struct_name {
/// Returns a list of pairs of env var and their documentation defined in this impl block. /// Returns a list of pairs of env var and their documentation defined in this impl block.
pub fn metadata<'a>() -> &'a [(&'static str, &'static str)] { pub fn metadata<'a>() -> &'a [(&'static str, &'static str, Option<&'static str>)] {
&[#(#pairs),*] &[#(#pairs),*]
} }
} }
@ -145,3 +157,8 @@ pub fn attr_hidden(_attr: TokenStream, item: TokenStream) -> TokenStream {
pub fn attr_env_var_pattern(_attr: TokenStream, item: TokenStream) -> TokenStream { pub fn attr_env_var_pattern(_attr: TokenStream, item: TokenStream) -> TokenStream {
item item
} }
#[proc_macro_attribute]
pub fn attr_added_in(_attr: TokenStream, item: TokenStream) -> TokenStream {
item
}

227
crates/uv-static/src/env_vars.rs
View File

File diff suppressed because it is too large Load Diff

170
docs/reference/environment.md
View File

@ -3,6 +3,7 @@
uv defines and respects the following environment variables: uv defines and respects the following environment variables:
### `UV_BREAK_SYSTEM_PACKAGES` ### `UV_BREAK_SYSTEM_PACKAGES`
<small class="added-in">added in `0.1.32`</small>
Equivalent to the `--break-system-packages` command-line argument. If set to `true`, Equivalent to the `--break-system-packages` command-line argument. If set to `true`,
uv will allow the installation of packages that conflict with system-installed packages. uv will allow the installation of packages that conflict with system-installed packages.
@ -12,54 +13,65 @@ WARNING: `UV_BREAK_SYSTEM_PACKAGES=true` is intended for use in continuous integ
Python can lead to unexpected behavior. Python can lead to unexpected behavior.
### `UV_BUILD_CONSTRAINT` ### `UV_BUILD_CONSTRAINT`
<small class="added-in">added in `0.2.34`</small>
Equivalent to the `--build-constraint` command-line argument. If set, uv will use this file Equivalent to the `--build-constraint` command-line argument. If set, uv will use this file
as constraints for any source distribution builds. Uses space-separated list of files. as constraints for any source distribution builds. Uses space-separated list of files.
### `UV_CACHE_DIR` ### `UV_CACHE_DIR`
<small class="added-in">added in `0.0.5`</small>
Equivalent to the `--cache-dir` command-line argument. If set, uv will use this Equivalent to the `--cache-dir` command-line argument. If set, uv will use this
directory for caching instead of the default cache directory. directory for caching instead of the default cache directory.
### `UV_COMPILE_BYTECODE` ### `UV_COMPILE_BYTECODE`
<small class="added-in">added in `0.3.3`</small>
Equivalent to the `--compile-bytecode` command-line argument. If set, uv Equivalent to the `--compile-bytecode` command-line argument. If set, uv
will compile Python source files to bytecode after installation. will compile Python source files to bytecode after installation.
### `UV_COMPILE_BYTECODE_TIMEOUT` ### `UV_COMPILE_BYTECODE_TIMEOUT`
<small class="added-in">added in `0.7.22`</small>
Timeout (in seconds) for bytecode compilation. Timeout (in seconds) for bytecode compilation.
### `UV_CONCURRENT_BUILDS` ### `UV_CONCURRENT_BUILDS`
<small class="added-in">added in `0.1.43`</small>
Sets the maximum number of source distributions that uv will build Sets the maximum number of source distributions that uv will build
concurrently at any given time. concurrently at any given time.
### `UV_CONCURRENT_DOWNLOADS` ### `UV_CONCURRENT_DOWNLOADS`
<small class="added-in">added in `0.1.43`</small>
Sets the maximum number of in-flight concurrent downloads that uv will Sets the maximum number of in-flight concurrent downloads that uv will
perform at any given time. perform at any given time.
### `UV_CONCURRENT_INSTALLS` ### `UV_CONCURRENT_INSTALLS`
<small class="added-in">added in `0.1.45`</small>
Controls the number of threads used when installing and unzipping Controls the number of threads used when installing and unzipping
packages. packages.
### `UV_CONFIG_FILE` ### `UV_CONFIG_FILE`
<small class="added-in">added in `0.1.34`</small>
Equivalent to the `--config-file` command-line argument. Expects a path to a Equivalent to the `--config-file` command-line argument. Expects a path to a
local `uv.toml` file to use as the configuration file. local `uv.toml` file to use as the configuration file.
### `UV_CONSTRAINT` ### `UV_CONSTRAINT`
<small class="added-in">added in `0.1.36`</small>
Equivalent to the `--constraint` command-line argument. If set, uv will use this Equivalent to the `--constraint` command-line argument. If set, uv will use this
file as the constraints file. Uses space-separated list of files. file as the constraints file. Uses space-separated list of files.
### `UV_CREDENTIALS_DIR` ### `UV_CREDENTIALS_DIR`
<small class="added-in">added in `0.8.15`</small>
The directory for storage of credentials when using a plain text backend. The directory for storage of credentials when using a plain text backend.
### `UV_CUSTOM_COMPILE_COMMAND` ### `UV_CUSTOM_COMPILE_COMMAND`
<small class="added-in">added in `0.1.23`</small>
Equivalent to the `--custom-compile-command` command-line argument. Equivalent to the `--custom-compile-command` command-line argument.
@ -68,73 +80,88 @@ Used to override uv in the output header of the `requirements.txt` files generat
script, to include the name of the wrapper script in the output file. script, to include the name of the wrapper script in the output file.
### `UV_DEFAULT_INDEX` ### `UV_DEFAULT_INDEX`
<small class="added-in">added in `0.4.23`</small>
Equivalent to the `--default-index` command-line argument. If set, uv will use Equivalent to the `--default-index` command-line argument. If set, uv will use
this URL as the default index when searching for packages. this URL as the default index when searching for packages.
### `UV_DEV` ### `UV_DEV`
<small class="added-in">added in `0.8.7`</small>
Equivalent to the `--dev` command-line argument. If set, uv will include Equivalent to the `--dev` command-line argument. If set, uv will include
development dependencies. development dependencies.
### `UV_DOWNLOAD_URL` ### `UV_DOWNLOAD_URL`
<small class="added-in">added in `0.8.4`</small>
The URL from which to download uv using the standalone installer. By default, installs from The URL from which to download uv using the standalone installer. By default, installs from
uv's GitHub Releases. `INSTALLER_DOWNLOAD_URL` is also supported as an alias, for backwards uv's GitHub Releases. `INSTALLER_DOWNLOAD_URL` is also supported as an alias, for backwards
compatibility. compatibility.
### `UV_ENV_FILE` ### `UV_ENV_FILE`
<small class="added-in">added in `0.4.30`</small>
`.env` files from which to load environment variables when executing `uv run` commands. `.env` files from which to load environment variables when executing `uv run` commands.
### `UV_EXCLUDE_NEWER` ### `UV_EXCLUDE_NEWER`
<small class="added-in">added in `0.2.12`</small>
Equivalent to the `--exclude-newer` command-line argument. If set, uv will Equivalent to the `--exclude-newer` command-line argument. If set, uv will
exclude distributions published after the specified date. exclude distributions published after the specified date.
### `UV_EXTRA_INDEX_URL` ### `UV_EXTRA_INDEX_URL`
<small class="added-in">added in `0.1.3`</small>
Equivalent to the `--extra-index-url` command-line argument. If set, uv will Equivalent to the `--extra-index-url` command-line argument. If set, uv will
use this space-separated list of URLs as additional indexes when searching for packages. use this space-separated list of URLs as additional indexes when searching for packages.
(Deprecated: use `UV_INDEX` instead.) (Deprecated: use `UV_INDEX` instead.)
### `UV_FIND_LINKS` ### `UV_FIND_LINKS`
<small class="added-in">added in `0.4.19`</small>
Equivalent to the `--find-links` command-line argument. If set, uv will use this Equivalent to the `--find-links` command-line argument. If set, uv will use this
comma-separated list of additional locations to search for packages. comma-separated list of additional locations to search for packages.
### `UV_FORK_STRATEGY` ### `UV_FORK_STRATEGY`
<small class="added-in">added in `0.5.9`</small>
Equivalent to the `--fork-strategy` argument. Controls version selection during universal Equivalent to the `--fork-strategy` argument. Controls version selection during universal
resolution. resolution.
### `UV_FROZEN` ### `UV_FROZEN`
<small class="added-in">added in `0.4.25`</small>
Equivalent to the `--frozen` command-line argument. If set, uv will run without Equivalent to the `--frozen` command-line argument. If set, uv will run without
updating the `uv.lock` file. updating the `uv.lock` file.
### `UV_GITHUB_TOKEN` ### `UV_GITHUB_TOKEN`
<small class="added-in">added in `0.4.10`</small>
Equivalent to the `--token` argument for self update. A GitHub token for authentication. Equivalent to the `--token` argument for self update. A GitHub token for authentication.
### `UV_GIT_LFS` ### `UV_GIT_LFS`
<small class="added-in">added in `0.5.19`</small>
Enables fetching files stored in Git LFS when installing a package from a Git repository. Enables fetching files stored in Git LFS when installing a package from a Git repository.
### `UV_HTTP_RETRIES` ### `UV_HTTP_RETRIES`
<small class="added-in">added in `0.7.21`</small>
The number of retries for HTTP requests. (default: 3) The number of retries for HTTP requests. (default: 3)
### `UV_HTTP_TIMEOUT` ### `UV_HTTP_TIMEOUT`
<small class="added-in">added in `0.1.7`</small>
Timeout (in seconds) for HTTP requests. (default: 30 s) Timeout (in seconds) for HTTP requests. (default: 30 s)
### `UV_INDEX` ### `UV_INDEX`
<small class="added-in">added in `0.4.23`</small>
Equivalent to the `--index` command-line argument. If set, uv will use this Equivalent to the `--index` command-line argument. If set, uv will use this
space-separated list of URLs as additional indexes when searching for packages. space-separated list of URLs as additional indexes when searching for packages.
### `UV_INDEX_STRATEGY` ### `UV_INDEX_STRATEGY`
<small class="added-in">added in `0.1.29`</small>
Equivalent to the `--index-strategy` command-line argument. Equivalent to the `--index-strategy` command-line argument.
@ -143,12 +170,14 @@ available across all index URLs, rather than limiting its search to the first in
that contains the package. that contains the package.
### `UV_INDEX_URL` ### `UV_INDEX_URL`
<small class="added-in">added in `0.0.5`</small>
Equivalent to the `--index-url` command-line argument. If set, uv will use this Equivalent to the `--index-url` command-line argument. If set, uv will use this
URL as the default index when searching for packages. URL as the default index when searching for packages.
(Deprecated: use `UV_DEFAULT_INDEX` instead.) (Deprecated: use `UV_DEFAULT_INDEX` instead.)
### `UV_INDEX_{name}_PASSWORD` ### `UV_INDEX_{name}_PASSWORD`
<small class="added-in">added in `0.4.23`</small>
Provides the HTTP Basic authentication password for a named index. Provides the HTTP Basic authentication password for a named index.
@ -156,6 +185,7 @@ The `name` parameter is the name of the index. For example, given an index named
the environment variable key would be `UV_INDEX_FOO_PASSWORD`. the environment variable key would be `UV_INDEX_FOO_PASSWORD`.
### `UV_INDEX_{name}_USERNAME` ### `UV_INDEX_{name}_USERNAME`
<small class="added-in">added in `0.4.23`</small>
Provides the HTTP Basic authentication username for a named index. Provides the HTTP Basic authentication username for a named index.
@ -163,15 +193,18 @@ The `name` parameter is the name of the index. For example, given an index named
the environment variable key would be `UV_INDEX_FOO_USERNAME`. the environment variable key would be `UV_INDEX_FOO_USERNAME`.
### `UV_INIT_BUILD_BACKEND` ### `UV_INIT_BUILD_BACKEND`
<small class="added-in">added in `0.8.2`</small>
Equivalent to the `--build-backend` argument for `uv init`. Determines the default backend Equivalent to the `--build-backend` argument for `uv init`. Determines the default backend
to use when creating a new project. to use when creating a new project.
### `UV_INSECURE_HOST` ### `UV_INSECURE_HOST`
<small class="added-in">added in `0.3.5`</small>
Equivalent to the `--allow-insecure-host` argument. Equivalent to the `--allow-insecure-host` argument.
### `UV_INSECURE_NO_ZIP_VALIDATION` ### `UV_INSECURE_NO_ZIP_VALIDATION`
<small class="added-in">added in `0.8.6`</small>
Disable ZIP validation for streamed wheels and ZIP-based source distributions. Disable ZIP validation for streamed wheels and ZIP-based source distributions.
@ -181,180 +214,217 @@ a ZIP file due to failing validation, it is likely that the file is malformed; c
filing an issue with the package maintainer. filing an issue with the package maintainer.
### `UV_INSTALLER_GHE_BASE_URL` ### `UV_INSTALLER_GHE_BASE_URL`
<small class="added-in">added in `0.5.0`</small>
The URL from which to download uv using the standalone installer and `self update` feature, The URL from which to download uv using the standalone installer and `self update` feature,
in lieu of the default GitHub Enterprise URL. in lieu of the default GitHub Enterprise URL.
### `UV_INSTALLER_GITHUB_BASE_URL` ### `UV_INSTALLER_GITHUB_BASE_URL`
<small class="added-in">added in `0.5.0`</small>
The URL from which to download uv using the standalone installer and `self update` feature, The URL from which to download uv using the standalone installer and `self update` feature,
in lieu of the default GitHub URL. in lieu of the default GitHub URL.
### `UV_INSTALL_DIR` ### `UV_INSTALL_DIR`
<small class="added-in">added in `0.5.0`</small>
The directory in which to install uv using the standalone installer and `self update` feature. The directory in which to install uv using the standalone installer and `self update` feature.
Defaults to `~/.local/bin`. Defaults to `~/.local/bin`.
### `UV_ISOLATED` ### `UV_ISOLATED`
<small class="added-in">added in `0.8.14`</small>
Equivalent to the `--isolated` command-line argument. If set, uv will avoid discovering Equivalent to the `--isolated` command-line argument. If set, uv will avoid discovering
a `pyproject.toml` or `uv.toml` file. a `pyproject.toml` or `uv.toml` file.
### `UV_KEYRING_PROVIDER` ### `UV_KEYRING_PROVIDER`
<small class="added-in">added in `0.1.19`</small>
Equivalent to the `--keyring-provider` command-line argument. If set, uv Equivalent to the `--keyring-provider` command-line argument. If set, uv
will use this value as the keyring provider. will use this value as the keyring provider.
### `UV_LIBC` ### `UV_LIBC`
<small class="added-in">added in `0.7.22`</small>
Overrides the environment-determined libc on linux systems when filling in the current platform Overrides the environment-determined libc on linux systems when filling in the current platform
within Python version requests. Options are: `gnu`, `gnueabi`, `gnueabihf`, `musl`, and `none`. within Python version requests. Options are: `gnu`, `gnueabi`, `gnueabihf`, `musl`, and `none`.
### `UV_LINK_MODE` ### `UV_LINK_MODE`
<small class="added-in">added in `0.1.40`</small>
Equivalent to the `--link-mode` command-line argument. If set, uv will use this as Equivalent to the `--link-mode` command-line argument. If set, uv will use this as
a link mode. a link mode.
### `UV_LOCKED` ### `UV_LOCKED`
<small class="added-in">added in `0.4.25`</small>
Equivalent to the `--locked` command-line argument. If set, uv will assert that the Equivalent to the `--locked` command-line argument. If set, uv will assert that the
`uv.lock` remains unchanged. `uv.lock` remains unchanged.
### `UV_LOG_CONTEXT` ### `UV_LOG_CONTEXT`
<small class="added-in">added in `0.6.4`</small>
Add additional context and structure to log messages. Add additional context and structure to log messages.
If logging is not enabled, e.g., with `RUST_LOG` or `-v`, this has no effect. If logging is not enabled, e.g., with `RUST_LOG` or `-v`, this has no effect.
### `UV_MANAGED_PYTHON` ### `UV_MANAGED_PYTHON`
<small class="added-in">added in `0.6.8`</small>
Require use of uv-managed Python versions. Require use of uv-managed Python versions.
### `UV_NATIVE_TLS` ### `UV_NATIVE_TLS`
<small class="added-in">added in `0.1.19`</small>
Equivalent to the `--native-tls` command-line argument. If set to `true`, uv will Equivalent to the `--native-tls` command-line argument. If set to `true`, uv will
use the system's trust store instead of the bundled `webpki-roots` crate. use the system's trust store instead of the bundled `webpki-roots` crate.
### `UV_NO_BINARY` ### `UV_NO_BINARY`
<small class="added-in">added in `0.5.30`</small>
Equivalent to the `--no-binary` command-line argument. If set, uv will install Equivalent to the `--no-binary` command-line argument. If set, uv will install
all packages from source. The resolver will still use pre-built wheels to all packages from source. The resolver will still use pre-built wheels to
extract package metadata, if available. extract package metadata, if available.
### `UV_NO_BINARY_PACKAGE` ### `UV_NO_BINARY_PACKAGE`
<small class="added-in">added in `0.5.30`</small>
Equivalent to the `--no-binary-package` command line argument. If set, uv will Equivalent to the `--no-binary-package` command line argument. If set, uv will
not use pre-built wheels for the given space-delimited list of packages. not use pre-built wheels for the given space-delimited list of packages.
### `UV_NO_BUILD` ### `UV_NO_BUILD`
<small class="added-in">added in `0.1.40`</small>
Equivalent to the `--no-build` command-line argument. If set, uv will not build Equivalent to the `--no-build` command-line argument. If set, uv will not build
source distributions. source distributions.
### `UV_NO_BUILD_ISOLATION` ### `UV_NO_BUILD_ISOLATION`
<small class="added-in">added in `0.1.40`</small>
Equivalent to the `--no-build-isolation` command-line argument. If set, uv will Equivalent to the `--no-build-isolation` command-line argument. If set, uv will
skip isolation when building source distributions. skip isolation when building source distributions.
### `UV_NO_BUILD_PACKAGE` ### `UV_NO_BUILD_PACKAGE`
<small class="added-in">added in `0.6.5`</small>
Equivalent to the `--no-build-package` command line argument. If set, uv will Equivalent to the `--no-build-package` command line argument. If set, uv will
not build source distributions for the given space-delimited list of packages. not build source distributions for the given space-delimited list of packages.
### `UV_NO_CACHE` ### `UV_NO_CACHE`
<small class="added-in">added in `0.1.2`</small>
Equivalent to the `--no-cache` command-line argument. If set, uv will not use the Equivalent to the `--no-cache` command-line argument. If set, uv will not use the
cache for any operations. cache for any operations.
### `UV_NO_CONFIG` ### `UV_NO_CONFIG`
<small class="added-in">added in `0.2.30`</small>
Equivalent to the `--no-config` command-line argument. If set, uv will not read Equivalent to the `--no-config` command-line argument. If set, uv will not read
any configuration files from the current directory, parent directories, or user configuration any configuration files from the current directory, parent directories, or user configuration
directories. directories.
### `UV_NO_DEV` ### `UV_NO_DEV`
<small class="added-in">added in `0.8.7`</small>
Equivalent to the `--no-dev` command-line argument. If set, uv will exclude Equivalent to the `--no-dev` command-line argument. If set, uv will exclude
development dependencies. development dependencies.
### `UV_NO_EDITABLE` ### `UV_NO_EDITABLE`
<small class="added-in">added in `0.6.15`</small>
Equivalent to the `--no-editable` command-line argument. If set, uv Equivalent to the `--no-editable` command-line argument. If set, uv
installs or exports any editable dependencies, including the project and any workspace installs or exports any editable dependencies, including the project and any workspace
members, as non-editable. members, as non-editable.
### `UV_NO_ENV_FILE` ### `UV_NO_ENV_FILE`
<small class="added-in">added in `0.4.30`</small>
Ignore `.env` files when executing `uv run` commands. Ignore `.env` files when executing `uv run` commands.
### `UV_NO_GITHUB_FAST_PATH` ### `UV_NO_GITHUB_FAST_PATH`
<small class="added-in">added in `0.7.13`</small>
Disable GitHub-specific requests that allow uv to skip `git fetch` in some circumstances. Disable GitHub-specific requests that allow uv to skip `git fetch` in some circumstances.
### `UV_NO_HF_TOKEN` ### `UV_NO_HF_TOKEN`
<small class="added-in">added in `0.8.1`</small>
Disable Hugging Face authentication, even if `HF_TOKEN` is set. Disable Hugging Face authentication, even if `HF_TOKEN` is set.
### `UV_NO_INSTALLER_METADATA` ### `UV_NO_INSTALLER_METADATA`
<small class="added-in">added in `0.5.7`</small>
Skip writing `uv` installer metadata files (e.g., `INSTALLER`, `REQUESTED`, and `direct_url.json`) to site-packages `.dist-info` directories. Skip writing `uv` installer metadata files (e.g., `INSTALLER`, `REQUESTED`, and `direct_url.json`) to site-packages `.dist-info` directories.
### `UV_NO_MANAGED_PYTHON` ### `UV_NO_MANAGED_PYTHON`
<small class="added-in">added in `0.6.8`</small>
Disable use of uv-managed Python versions. Disable use of uv-managed Python versions.
### `UV_NO_MODIFY_PATH` ### `UV_NO_MODIFY_PATH`
<small class="added-in">added in `0.8.4`</small>
Avoid modifying the `PATH` environment variable when installing uv using the standalone Avoid modifying the `PATH` environment variable when installing uv using the standalone
installer and `self update` feature. `INSTALLER_NO_MODIFY_PATH` is also supported as an installer and `self update` feature. `INSTALLER_NO_MODIFY_PATH` is also supported as an
alias, for backwards compatibility. alias, for backwards compatibility.
### `UV_NO_PROGRESS` ### `UV_NO_PROGRESS`
<small class="added-in">added in `0.2.28`</small>
Equivalent to the `--no-progress` command-line argument. Disables all progress output. For Equivalent to the `--no-progress` command-line argument. Disables all progress output. For
example, spinners and progress bars. example, spinners and progress bars.
### `UV_NO_SYNC` ### `UV_NO_SYNC`
<small class="added-in">added in `0.4.18`</small>
Equivalent to the `--no-sync` command-line argument. If set, uv will skip updating Equivalent to the `--no-sync` command-line argument. If set, uv will skip updating
the environment. the environment.
### `UV_NO_VERIFY_HASHES` ### `UV_NO_VERIFY_HASHES`
<small class="added-in">added in `0.5.3`</small>
Equivalent to the `--no-verify-hashes` argument. Disables hash verification for Equivalent to the `--no-verify-hashes` argument. Disables hash verification for
`requirements.txt` files. `requirements.txt` files.
### `UV_NO_WRAP` ### `UV_NO_WRAP`
<small class="added-in">added in `0.0.5`</small>
Use to disable line wrapping for diagnostics. Use to disable line wrapping for diagnostics.
### `UV_OFFLINE` ### `UV_OFFLINE`
<small class="added-in">added in `0.5.9`</small>
Equivalent to the `--offline` command-line argument. If set, uv will disable network access. Equivalent to the `--offline` command-line argument. If set, uv will disable network access.
### `UV_OVERRIDE` ### `UV_OVERRIDE`
<small class="added-in">added in `0.2.22`</small>
Equivalent to the `--override` command-line argument. If set, uv will use this file Equivalent to the `--override` command-line argument. If set, uv will use this file
as the overrides file. Uses space-separated list of files. as the overrides file. Uses space-separated list of files.
### `UV_PRERELEASE` ### `UV_PRERELEASE`
<small class="added-in">added in `0.1.16`</small>
Equivalent to the `--prerelease` command-line argument. For example, if set to Equivalent to the `--prerelease` command-line argument. For example, if set to
`allow`, uv will allow pre-release versions for all dependencies. `allow`, uv will allow pre-release versions for all dependencies.
### `UV_PREVIEW` ### `UV_PREVIEW`
<small class="added-in">added in `0.1.37`</small>
Equivalent to the `--preview` argument. Enables preview mode. Equivalent to the `--preview` argument. Enables preview mode.
### `UV_PREVIEW_FEATURES` ### `UV_PREVIEW_FEATURES`
<small class="added-in">added in `0.8.4`</small>
Equivalent to the `--preview-features` argument. Enables specific preview features. Equivalent to the `--preview-features` argument. Enables specific preview features.
### `UV_PROJECT` ### `UV_PROJECT`
<small class="added-in">added in `0.4.4`</small>
Equivalent to the `--project` command-line argument. Equivalent to the `--project` command-line argument.
### `UV_PROJECT_ENVIRONMENT` ### `UV_PROJECT_ENVIRONMENT`
<small class="added-in">added in `0.4.4`</small>
Specifies the path to the directory to use for a project virtual environment. Specifies the path to the directory to use for a project virtual environment.
@ -362,35 +432,42 @@ See the [project documentation](../concepts/projects/config.md#project-environme
for more details. for more details.
### `UV_PUBLISH_CHECK_URL` ### `UV_PUBLISH_CHECK_URL`
<small class="added-in">added in `0.4.30`</small>
Don't upload a file if it already exists on the index. The value is the URL of the index. Don't upload a file if it already exists on the index. The value is the URL of the index.
### `UV_PUBLISH_INDEX` ### `UV_PUBLISH_INDEX`
<small class="added-in">added in `0.5.8`</small>
Equivalent to the `--index` command-line argument in `uv publish`. If Equivalent to the `--index` command-line argument in `uv publish`. If
set, uv the index with this name in the configuration for publishing. set, uv the index with this name in the configuration for publishing.
### `UV_PUBLISH_PASSWORD` ### `UV_PUBLISH_PASSWORD`
<small class="added-in">added in `0.4.16`</small>
Equivalent to the `--password` command-line argument in `uv publish`. If Equivalent to the `--password` command-line argument in `uv publish`. If
set, uv will use this password for publishing. set, uv will use this password for publishing.
### `UV_PUBLISH_TOKEN` ### `UV_PUBLISH_TOKEN`
<small class="added-in">added in `0.4.16`</small>
Equivalent to the `--token` command-line argument in `uv publish`. If set, uv Equivalent to the `--token` command-line argument in `uv publish`. If set, uv
will use this token (with the username `__token__`) for publishing. will use this token (with the username `__token__`) for publishing.
### `UV_PUBLISH_URL` ### `UV_PUBLISH_URL`
<small class="added-in">added in `0.4.16`</small>
Equivalent to the `--publish-url` command-line argument. The URL of the upload Equivalent to the `--publish-url` command-line argument. The URL of the upload
endpoint of the index to use with `uv publish`. endpoint of the index to use with `uv publish`.
### `UV_PUBLISH_USERNAME` ### `UV_PUBLISH_USERNAME`
<small class="added-in">added in `0.4.16`</small>
Equivalent to the `--username` command-line argument in `uv publish`. If Equivalent to the `--username` command-line argument in `uv publish`. If
set, uv will use this username for publishing. set, uv will use this username for publishing.
### `UV_PYPY_INSTALL_MIRROR` ### `UV_PYPY_INSTALL_MIRROR`
<small class="added-in">added in `0.2.35`</small>
Managed PyPy installations are downloaded from [python.org](https://downloads.python.org/). Managed PyPy installations are downloaded from [python.org](https://downloads.python.org/).
@ -401,32 +478,38 @@ different source for PyPy installations. The provided URL will replace
Distributions can be read from a local directory by using the `file://` URL scheme. Distributions can be read from a local directory by using the `file://` URL scheme.
### `UV_PYTHON` ### `UV_PYTHON`
<small class="added-in">added in `0.1.40`</small>
Equivalent to the `--python` command-line argument. If set to a path, uv will use Equivalent to the `--python` command-line argument. If set to a path, uv will use
this Python interpreter for all operations. this Python interpreter for all operations.
### `UV_PYTHON_BIN_DIR` ### `UV_PYTHON_BIN_DIR`
<small class="added-in">added in `0.4.29`</small>
Specifies the directory to place links to installed, managed Python executables. Specifies the directory to place links to installed, managed Python executables.
### `UV_PYTHON_CACHE_DIR` ### `UV_PYTHON_CACHE_DIR`
<small class="added-in">added in `0.7.0`</small>
Specifies the directory for caching the archives of managed Python installations before Specifies the directory for caching the archives of managed Python installations before
installation. installation.
### `UV_PYTHON_CPYTHON_BUILD` ### `UV_PYTHON_CPYTHON_BUILD`
<small class="added-in">added in `0.8.14`</small>
Pin managed CPython versions to a specific build version. Pin managed CPython versions to a specific build version.
For CPython, this should be the build date (e.g., "20250814"). For CPython, this should be the build date (e.g., "20250814").
### `UV_PYTHON_DOWNLOADS` ### `UV_PYTHON_DOWNLOADS`
<small class="added-in">added in `0.3.2`</small>
Equivalent to the Equivalent to the
[`python-downloads`](../reference/settings.md#python-downloads) setting and, when disabled, the [`python-downloads`](../reference/settings.md#python-downloads) setting and, when disabled, the
`--no-python-downloads` option. Whether uv should allow Python downloads. `--no-python-downloads` option. Whether uv should allow Python downloads.
### `UV_PYTHON_DOWNLOADS_JSON_URL` ### `UV_PYTHON_DOWNLOADS_JSON_URL`
<small class="added-in">added in `0.6.13`</small>
Managed Python installations information is hardcoded in the `uv` binary. Managed Python installations information is hardcoded in the `uv` binary.
@ -436,20 +519,24 @@ This will allow for setting each property of the Python installation, mostly the
Note that currently, only local paths are supported. Note that currently, only local paths are supported.
### `UV_PYTHON_GRAALPY_BUILD` ### `UV_PYTHON_GRAALPY_BUILD`
<small class="added-in">added in `0.8.14`</small>
Pin managed GraalPy versions to a specific build version. Pin managed GraalPy versions to a specific build version.
For GraalPy, this should be the GraalPy version (e.g., "24.2.2"). For GraalPy, this should be the GraalPy version (e.g., "24.2.2").
### `UV_PYTHON_INSTALL_BIN` ### `UV_PYTHON_INSTALL_BIN`
<small class="added-in">added in `0.8.0`</small>
Whether to install the Python executable into the `UV_PYTHON_BIN_DIR` directory. Whether to install the Python executable into the `UV_PYTHON_BIN_DIR` directory.
### `UV_PYTHON_INSTALL_DIR` ### `UV_PYTHON_INSTALL_DIR`
<small class="added-in">added in `0.2.22`</small>
Specifies the directory for storing managed Python installations. Specifies the directory for storing managed Python installations.
### `UV_PYTHON_INSTALL_MIRROR` ### `UV_PYTHON_INSTALL_MIRROR`
<small class="added-in">added in `0.2.35`</small>
Managed Python installations are downloaded from the Astral Managed Python installations are downloaded from the Astral
[`python-build-standalone`](https://github.com/astral-sh/python-build-standalone) project. [`python-build-standalone`](https://github.com/astral-sh/python-build-standalone) project.
@ -460,46 +547,55 @@ The provided URL will replace `https://github.com/astral-sh/python-build-standal
Distributions can be read from a local directory by using the `file://` URL scheme. Distributions can be read from a local directory by using the `file://` URL scheme.
### `UV_PYTHON_INSTALL_REGISTRY` ### `UV_PYTHON_INSTALL_REGISTRY`
<small class="added-in">added in `0.8.0`</small>
Whether to install the Python executable into the Windows registry. Whether to install the Python executable into the Windows registry.
### `UV_PYTHON_PREFERENCE` ### `UV_PYTHON_PREFERENCE`
<small class="added-in">added in `0.3.2`</small>
Whether uv should prefer system or managed Python versions. Whether uv should prefer system or managed Python versions.
### `UV_PYTHON_PYODIDE_BUILD` ### `UV_PYTHON_PYODIDE_BUILD`
<small class="added-in">added in `0.8.14`</small>
Pin managed Pyodide versions to a specific build version. Pin managed Pyodide versions to a specific build version.
For Pyodide, this should be the Pyodide version (e.g., "0.28.1"). For Pyodide, this should be the Pyodide version (e.g., "0.28.1").
### `UV_PYTHON_PYPY_BUILD` ### `UV_PYTHON_PYPY_BUILD`
<small class="added-in">added in `0.8.14`</small>
Pin managed PyPy versions to a specific build version. Pin managed PyPy versions to a specific build version.
For PyPy, this should be the PyPy version (e.g., "7.3.20"). For PyPy, this should be the PyPy version (e.g., "7.3.20").
### `UV_REQUEST_TIMEOUT` ### `UV_REQUEST_TIMEOUT`
<small class="added-in">added in `0.1.6`</small>
Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`. Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`.
### `UV_REQUIRE_HASHES` ### `UV_REQUIRE_HASHES`
<small class="added-in">added in `0.1.34`</small>
Equivalent to the `--require-hashes` command-line argument. If set to `true`, Equivalent to the `--require-hashes` command-line argument. If set to `true`,
uv will require that all dependencies have a hash specified in the requirements file. uv will require that all dependencies have a hash specified in the requirements file.
### `UV_RESOLUTION` ### `UV_RESOLUTION`
<small class="added-in">added in `0.1.27`</small>
Equivalent to the `--resolution` command-line argument. For example, if set to Equivalent to the `--resolution` command-line argument. For example, if set to
`lowest-direct`, uv will install the lowest compatible versions of all direct dependencies. `lowest-direct`, uv will install the lowest compatible versions of all direct dependencies.
### `UV_S3_ENDPOINT_URL` ### `UV_S3_ENDPOINT_URL`
<small class="added-in">added in `0.8.21`</small>
The URL to treat as an S3-compatible storage endpoint. Requests to this endpoint The URL to treat as an S3-compatible storage endpoint. Requests to this endpoint
will be signed using AWS Signature Version 4 based on the `AWS_ACCESS_KEY_ID`, will be signed using AWS Signature Version 4 based on the `AWS_ACCESS_KEY_ID`,
`AWS_SECRET_ACCESS_KEY`, `AWS_PROFILE`, and `AWS_CONFIG_FILE` environment variables. `AWS_SECRET_ACCESS_KEY`, `AWS_PROFILE`, and `AWS_CONFIG_FILE` environment variables.
### `UV_SKIP_WHEEL_FILENAME_CHECK` ### `UV_SKIP_WHEEL_FILENAME_CHECK`
<small class="added-in">added in `0.8.23`</small>
Avoid verifying that wheel filenames match their contents when installing wheels. This Avoid verifying that wheel filenames match their contents when installing wheels. This
is not recommended, as wheels with inconsistent filenames should be considered invalid and is not recommended, as wheels with inconsistent filenames should be considered invalid and
@ -507,6 +603,7 @@ corrected by the relevant package maintainers; however, this option can be used
around invalid artifacts in rare cases. around invalid artifacts in rare cases.
### `UV_STACK_SIZE` ### `UV_STACK_SIZE`
<small class="added-in">added in `0.0.5`</small>
Use to set the stack size used by uv. Use to set the stack size used by uv.
@ -519,6 +616,7 @@ the fact that Windows' real main thread is only 1MB. That thread has size
`max(UV_STACK_SIZE, 1MB)`. `max(UV_STACK_SIZE, 1MB)`.
### `UV_SYSTEM_PYTHON` ### `UV_SYSTEM_PYTHON`
<small class="added-in">added in `0.1.18`</small>
Equivalent to the `--system` command-line argument. If set to `true`, uv will Equivalent to the `--system` command-line argument. If set to `true`, uv will
use the first Python interpreter found in the system `PATH`. use the first Python interpreter found in the system `PATH`.
@ -528,32 +626,39 @@ or containerized environments and should be used with caution, as modifying the
Python can lead to unexpected behavior. Python can lead to unexpected behavior.
### `UV_TEST_NO_HTTP_RETRY_DELAY` ### `UV_TEST_NO_HTTP_RETRY_DELAY`
<small class="added-in">added in `0.7.21`</small>
Used to disable delay for HTTP retries in tests. Used to disable delay for HTTP retries in tests.
### `UV_TOOL_BIN_DIR` ### `UV_TOOL_BIN_DIR`
<small class="added-in">added in `0.3.0`</small>
Specifies the "bin" directory for installing tool executables. Specifies the "bin" directory for installing tool executables.
### `UV_TOOL_DIR` ### `UV_TOOL_DIR`
<small class="added-in">added in `0.2.16`</small>
Specifies the directory where uv stores managed tools. Specifies the directory where uv stores managed tools.
### `UV_TORCH_BACKEND` ### `UV_TORCH_BACKEND`
<small class="added-in">added in `0.6.9`</small>
Equivalent to the `--torch-backend` command-line argument (e.g., `cpu`, `cu126`, or `auto`). Equivalent to the `--torch-backend` command-line argument (e.g., `cpu`, `cu126`, or `auto`).
### `UV_UNMANAGED_INSTALL` ### `UV_UNMANAGED_INSTALL`
<small class="added-in">added in `0.5.0`</small>
Used ephemeral environments like CI to install uv to a specific path while preventing Used ephemeral environments like CI to install uv to a specific path while preventing
the installer from modifying shell profiles or environment variables. the installer from modifying shell profiles or environment variables.
### `UV_VENV_CLEAR` ### `UV_VENV_CLEAR`
<small class="added-in">added in `0.8.0`</small>
Equivalent to the `--clear` command-line argument. If set, uv will remove any Equivalent to the `--clear` command-line argument. If set, uv will remove any
existing files or directories at the target path. existing files or directories at the target path.
### `UV_VENV_SEED` ### `UV_VENV_SEED`
<small class="added-in">added in `0.5.21`</small>
Install seed packages (one or more of: `pip`, `setuptools`, and `wheel`) into the virtual environment Install seed packages (one or more of: `pip`, `setuptools`, and `wheel`) into the virtual environment
created by `uv venv`. created by `uv venv`.
@ -571,10 +676,12 @@ Equivalent to the `--directory` command-line argument.
uv also reads the following externally defined environment variables: uv also reads the following externally defined environment variables:
### `ALL_PROXY` ### `ALL_PROXY`
<small class="added-in">added in `0.1.38`</small>
General proxy for all network requests. General proxy for all network requests.
### `ANDROID_API_LEVEL` ### `ANDROID_API_LEVEL`
<small class="added-in">added in `0.8.16`</small>
Used with `--python-platform aarch64-linux-android` and related variants to set the Used with `--python-platform aarch64-linux-android` and related variants to set the
Android API level. (i.e., the minimum supported Android API level). Android API level. (i.e., the minimum supported Android API level).
@ -582,74 +689,91 @@ Android API level. (i.e., the minimum supported Android API level).
Defaults to `24`. Defaults to `24`.
### `APPDATA` ### `APPDATA`
<small class="added-in">added in `0.1.42`</small>
Path to user-level configuration directory on Windows systems. Path to user-level configuration directory on Windows systems.
### `AWS_ACCESS_KEY_ID` ### `AWS_ACCESS_KEY_ID`
<small class="added-in">added in `0.8.21`</small>
The AWS access key ID to use when signing S3 requests. The AWS access key ID to use when signing S3 requests.
### `AWS_CONFIG_FILE` ### `AWS_CONFIG_FILE`
<small class="added-in">added in `0.8.21`</small>
The AWS config file to use when signing S3 requests. The AWS config file to use when signing S3 requests.
### `AWS_DEFAULT_REGION` ### `AWS_DEFAULT_REGION`
<small class="added-in">added in `0.8.21`</small>
The default AWS region to use when signing S3 requests, if `AWS_REGION` is not set. The default AWS region to use when signing S3 requests, if `AWS_REGION` is not set.
### `AWS_PROFILE` ### `AWS_PROFILE`
<small class="added-in">added in `0.8.21`</small>
The AWS profile to use when signing S3 requests. The AWS profile to use when signing S3 requests.
### `AWS_REGION` ### `AWS_REGION`
<small class="added-in">added in `0.8.21`</small>
The AWS region to use when signing S3 requests. The AWS region to use when signing S3 requests.
### `AWS_SECRET_ACCESS_KEY` ### `AWS_SECRET_ACCESS_KEY`
<small class="added-in">added in `0.8.21`</small>
The AWS secret access key to use when signing S3 requests. The AWS secret access key to use when signing S3 requests.
### `AWS_SESSION_TOKEN` ### `AWS_SESSION_TOKEN`
<small class="added-in">added in `0.8.21`</small>
The AWS session token to use when signing S3 requests. The AWS session token to use when signing S3 requests.
### `AWS_SHARED_CREDENTIALS_FILE` ### `AWS_SHARED_CREDENTIALS_FILE`
<small class="added-in">added in `0.8.21`</small>
The AWS shared credentials file to use when signing S3 requests. The AWS shared credentials file to use when signing S3 requests.
### `BASH_VERSION` ### `BASH_VERSION`
<small class="added-in">added in `0.1.28`</small>
Used to detect Bash shell usage. Used to detect Bash shell usage.
### `CLICOLOR_FORCE` ### `CLICOLOR_FORCE`
<small class="added-in">added in `0.1.32`</small>
Use to control color via `anstyle`. Use to control color via `anstyle`.
### `COLUMNS` ### `COLUMNS`
<small class="added-in">added in `0.6.2`</small>
Overrides terminal width used for wrapping. This variable is not read by uv directly. Overrides terminal width used for wrapping. This variable is not read by uv directly.
This is a quasi-standard variable, described, e.g., in `ncurses(3x)`. This is a quasi-standard variable, described, e.g., in `ncurses(3x)`.
### `CONDA_DEFAULT_ENV` ### `CONDA_DEFAULT_ENV`
<small class="added-in">added in `0.5.0`</small>
Used to determine the name of the active Conda environment. Used to determine the name of the active Conda environment.
### `CONDA_PREFIX` ### `CONDA_PREFIX`
<small class="added-in">added in `0.0.5`</small>
Used to detect the path of an active Conda environment. Used to detect the path of an active Conda environment.
### `FISH_VERSION` ### `FISH_VERSION`
<small class="added-in">added in `0.1.28`</small>
Used to detect Fish shell usage. Used to detect Fish shell usage.
### `FORCE_COLOR` ### `FORCE_COLOR`
<small class="added-in">added in `0.2.7`</small>
Forces colored output regardless of terminal support. Forces colored output regardless of terminal support.
See [force-color.org](https://force-color.org). See [force-color.org](https://force-color.org).
### `GITHUB_ACTIONS` ### `GITHUB_ACTIONS`
<small class="added-in">added in `0.4.16`</small>
Indicates that the current process is running in GitHub Actions. Indicates that the current process is running in GitHub Actions.
@ -657,6 +781,7 @@ Indicates that the current process is running in GitHub Actions.
to `true`. to `true`.
### `GITLAB_CI` ### `GITLAB_CI`
<small class="added-in">added in `0.8.18`</small>
Indicates that the current process is running in GitLab CI. Indicates that the current process is running in GitLab CI.
@ -664,27 +789,33 @@ Indicates that the current process is running in GitLab CI.
to `true`. to `true`.
### `HF_TOKEN` ### `HF_TOKEN`
<small class="added-in">added in `0.8.1`</small>
Authentication token for Hugging Face requests. When set, uv will use this token Authentication token for Hugging Face requests. When set, uv will use this token
when making requests to `https://huggingface.co/` and any subdomains. when making requests to `https://huggingface.co/` and any subdomains.
### `HOME` ### `HOME`
<small class="added-in">added in `0.0.5`</small>
The standard `HOME` env var. The standard `HOME` env var.
### `HTTPS_PROXY` ### `HTTPS_PROXY`
<small class="added-in">added in `0.1.38`</small>
Proxy for HTTPS requests. Proxy for HTTPS requests.
### `HTTP_PROXY` ### `HTTP_PROXY`
<small class="added-in">added in `0.1.38`</small>
Proxy for HTTP requests. Proxy for HTTP requests.
### `HTTP_TIMEOUT` ### `HTTP_TIMEOUT`
<small class="added-in">added in `0.1.7`</small>
Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`. Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`.
### `IPHONEOS_DEPLOYMENT_TARGET` ### `IPHONEOS_DEPLOYMENT_TARGET`
<small class="added-in">added in `0.8.16`</small>
Used with `--python-platform arm64-apple-ios` and related variants to set the Used with `--python-platform arm64-apple-ios` and related variants to set the
deployment target (i.e., the minimum supported iOS version). deployment target (i.e., the minimum supported iOS version).
@ -692,18 +823,22 @@ deployment target (i.e., the minimum supported iOS version).
Defaults to `13.0`. Defaults to `13.0`.
### `JPY_SESSION_NAME` ### `JPY_SESSION_NAME`
<small class="added-in">added in `0.2.6`</small>
Used to detect when running inside a Jupyter notebook. Used to detect when running inside a Jupyter notebook.
### `KSH_VERSION` ### `KSH_VERSION`
<small class="added-in">added in `0.2.33`</small>
Used to detect Ksh shell usage. Used to detect Ksh shell usage.
### `LOCALAPPDATA` ### `LOCALAPPDATA`
<small class="added-in">added in `0.3.3`</small>
Used to look for Microsoft Store Pythons installations. Used to look for Microsoft Store Pythons installations.
### `MACOSX_DEPLOYMENT_TARGET` ### `MACOSX_DEPLOYMENT_TARGET`
<small class="added-in">added in `0.1.42`</small>
Used with `--python-platform macos` and related variants to set the Used with `--python-platform macos` and related variants to set the
deployment target (i.e., the minimum supported macOS version). deployment target (i.e., the minimum supported macOS version).
@ -711,70 +846,86 @@ deployment target (i.e., the minimum supported macOS version).
Defaults to `13.0`, the least-recent non-EOL macOS version at time of writing. Defaults to `13.0`, the least-recent non-EOL macOS version at time of writing.
### `NETRC` ### `NETRC`
<small class="added-in">added in `0.1.16`</small>
Use to set the .netrc file location. Use to set the .netrc file location.
### `NO_COLOR` ### `NO_COLOR`
<small class="added-in">added in `0.2.7`</small>
Disables colored output (takes precedence over `FORCE_COLOR`). Disables colored output (takes precedence over `FORCE_COLOR`).
See [no-color.org](https://no-color.org). See [no-color.org](https://no-color.org).
### `NO_PROXY` ### `NO_PROXY`
<small class="added-in">added in `0.1.38`</small>
Comma-separated list of hostnames (e.g., `example.com`) and/or patterns (e.g., `192.168.1.0/24`) that should bypass the proxy. Comma-separated list of hostnames (e.g., `example.com`) and/or patterns (e.g., `192.168.1.0/24`) that should bypass the proxy.
### `NU_VERSION` ### `NU_VERSION`
<small class="added-in">added in `0.1.16`</small>
Used to detect `NuShell` usage. Used to detect `NuShell` usage.
### `PAGER` ### `PAGER`
<small class="added-in">added in `0.4.18`</small>
The standard `PAGER` posix env var. Used by `uv` to configure the appropriate pager. The standard `PAGER` posix env var. Used by `uv` to configure the appropriate pager.
### `PATH` ### `PATH`
<small class="added-in">added in `0.0.5`</small>
The standard `PATH` env var. The standard `PATH` env var.
### `PROMPT` ### `PROMPT`
<small class="added-in">added in `0.1.16`</small>
Used to detect the use of the Windows Command Prompt (as opposed to PowerShell). Used to detect the use of the Windows Command Prompt (as opposed to PowerShell).
### `PWD` ### `PWD`
<small class="added-in">added in `0.0.5`</small>
The standard `PWD` posix env var. The standard `PWD` posix env var.
### `PYC_INVALIDATION_MODE` ### `PYC_INVALIDATION_MODE`
<small class="added-in">added in `0.1.7`</small>
The validation modes to use when run with `--compile`. The validation modes to use when run with `--compile`.
See [`PycInvalidationMode`](https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode). See [`PycInvalidationMode`](https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode).
### `PYTHONPATH` ### `PYTHONPATH`
<small class="added-in">added in `0.1.22`</small>
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`).
### `PYX_API_KEY` ### `PYX_API_KEY`
<small class="added-in">added in `0.8.15`</small>
The pyx API key (e.g., `sk-pyx-...`). The pyx API key (e.g., `sk-pyx-...`).
### `PYX_API_URL` ### `PYX_API_URL`
<small class="added-in">added in `0.8.15`</small>
The URL of the pyx Simple API server. The URL of the pyx Simple API server.
### `PYX_AUTH_TOKEN` ### `PYX_AUTH_TOKEN`
<small class="added-in">added in `0.8.15`</small>
The pyx authentication token (e.g., `eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...`), as output by `uv auth token`. The pyx authentication token (e.g., `eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...`), as output by `uv auth token`.
### `PYX_CDN_DOMAIN` ### `PYX_CDN_DOMAIN`
<small class="added-in">added in `0.8.15`</small>
The domain of the pyx CDN. The domain of the pyx CDN.
### `PYX_CREDENTIALS_DIR` ### `PYX_CREDENTIALS_DIR`
<small class="added-in">added in `0.8.15`</small>
Specifies the directory where uv stores pyx credentials. Specifies the directory where uv stores pyx credentials.
### `RUST_BACKTRACE` ### `RUST_BACKTRACE`
<small class="added-in">added in `0.7.22`</small>
If set, it can be used to display more stack trace details when a panic occurs. If set, it can be used to display more stack trace details when a panic occurs.
This is used by uv particularly on windows to show more details during a platform exception. This is used by uv particularly on windows to show more details during a platform exception.
@ -788,6 +939,7 @@ See the [Rust backtrace documentation](https://doc.rust-lang.org/std/backtrace/i
for more. for more.
### `RUST_LOG` ### `RUST_LOG`
<small class="added-in">added in `0.0.5`</small>
If set, uv will use this value as the log level for its `--verbose` output. Accepts If set, uv will use this value as the log level for its `--verbose` output. Accepts
any filter compatible with the `tracing_subscriber` crate. any filter compatible with the `tracing_subscriber` crate.
@ -801,6 +953,7 @@ See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracin
for more. for more.
### `RUST_MIN_STACK` ### `RUST_MIN_STACK`
<small class="added-in">added in `0.5.19`</small>
Use to set the stack size used by uv. Use to set the stack size used by uv.
@ -816,31 +969,38 @@ the fact that Windows' real main thread is only 1MB. That thread has size
`max(RUST_MIN_STACK, 1MB)`. `max(RUST_MIN_STACK, 1MB)`.
### `SHELL` ### `SHELL`
<small class="added-in">added in `0.1.16`</small>
The standard `SHELL` posix env var. The standard `SHELL` posix env var.
### `SSL_CERT_FILE` ### `SSL_CERT_FILE`
<small class="added-in">added in `0.1.14`</small>
Custom certificate bundle file path for SSL connections. Custom certificate bundle file path for SSL connections.
### `SSL_CLIENT_CERT` ### `SSL_CLIENT_CERT`
<small class="added-in">added in `0.2.11`</small>
If set, uv will use this file for mTLS authentication. If set, uv will use this file for mTLS authentication.
This should be a single file containing both the certificate and the private key in PEM format. This should be a single file containing both the certificate and the private key in PEM format.
### `SYSTEMDRIVE` ### `SYSTEMDRIVE`
<small class="added-in">added in `0.4.26`</small>
Path to system-level configuration directory on Windows systems. Path to system-level configuration directory on Windows systems.
### `TRACING_DURATIONS_FILE` ### `TRACING_DURATIONS_FILE`
<small class="added-in">added in `0.0.5`</small>
Use to create the tracing durations file via the `tracing-durations-export` feature. Use to create the tracing durations file via the `tracing-durations-export` feature.
### `USERPROFILE` ### `USERPROFILE`
<small class="added-in">added in `0.0.5`</small>
Path to root directory of user's profile on Windows systems. Path to root directory of user's profile on Windows systems.
### `UV` ### `UV`
<small class="added-in">added in `0.6.0`</small>
The path to the binary that was used to invoke uv. The path to the binary that was used to invoke uv.
@ -853,43 +1013,53 @@ See <https://doc.rust-lang.org/std/env/fn.current_exe.html#security> for securit
considerations. considerations.
### `VIRTUAL_ENV` ### `VIRTUAL_ENV`
<small class="added-in">added in `0.0.5`</small>
Used to detect an activated virtual environment. Used to detect an activated virtual environment.
### `VIRTUAL_ENV_DISABLE_PROMPT` ### `VIRTUAL_ENV_DISABLE_PROMPT`
<small class="added-in">added in `0.0.5`</small>
If set to `1` before a virtual environment is activated, then the If set to `1` before a virtual environment is activated, then the
virtual environment name will not be prepended to the terminal prompt. virtual environment name will not be prepended to the terminal prompt.
### `XDG_BIN_HOME` ### `XDG_BIN_HOME`
<small class="added-in">added in `0.2.16`</small>
Path to directory where executables are installed. Path to directory where executables are installed.
### `XDG_CACHE_HOME` ### `XDG_CACHE_HOME`
<small class="added-in">added in `0.1.17`</small>
Path to cache directory on Unix systems. Path to cache directory on Unix systems.
### `XDG_CONFIG_DIRS` ### `XDG_CONFIG_DIRS`
<small class="added-in">added in `0.4.26`</small>
Path to system-level configuration directory on Unix systems. Path to system-level configuration directory on Unix systems.
### `XDG_CONFIG_HOME` ### `XDG_CONFIG_HOME`
<small class="added-in">added in `0.1.34`</small>
Path to user-level configuration directory on Unix systems. Path to user-level configuration directory on Unix systems.
### `XDG_DATA_HOME` ### `XDG_DATA_HOME`
<small class="added-in">added in `0.2.16`</small>
Path to directory for storing managed Python installations and tools. Path to directory for storing managed Python installations and tools.
### `ZDOTDIR` ### `ZDOTDIR`
<small class="added-in">added in `0.2.25`</small>
Used to determine which `.zshenv` to use when Zsh is being used. Used to determine which `.zshenv` to use when Zsh is being used.
### `ZSH_VERSION` ### `ZSH_VERSION`
<small class="added-in">added in `0.1.28`</small>
Used to detect Zsh shell usage. Used to detect Zsh shell usage.
### `_CONDA_ROOT` ### `_CONDA_ROOT`
<small class="added-in">added in `0.8.18`</small>
Used to determine the root install path of Conda. Used to determine the root install path of Conda.

8
docs/stylesheets/extra.css
View File

@ -206,6 +206,14 @@ h3.cli-reference {
font-size: 1.1em; font-size: 1.1em;
margin: 0 0 0 0; margin: 0 0 0 0;
} }
h3:has(+ p > small.added-in) {
display: inline-block;
margin: 0;
}
h3 + p:has(> small.added-in) {
display: inline;
margin: 0;
}
/* Styling for anchor link headers */ /* Styling for anchor link headers */
.toclink { .toclink {

2
pyproject.toml
View File

@ -67,6 +67,7 @@ version_files = [
"crates/uv-version/Cargo.toml", "crates/uv-version/Cargo.toml",
"crates/uv-build/Cargo.toml", "crates/uv-build/Cargo.toml",
"crates/uv-build/pyproject.toml", "crates/uv-build/pyproject.toml",
{ target = "crates/uv-static/src/env_vars.rs", replace = "next release" },
"docs/getting-started/installation.md", "docs/getting-started/installation.md",
"docs/guides/integration/docker.md", "docs/guides/integration/docker.md",
"docs/guides/integration/pre-commit.md", "docs/guides/integration/pre-commit.md",
@ -75,6 +76,7 @@ version_files = [
"docs/concepts/build-backend.md", "docs/concepts/build-backend.md",
"docs/concepts/projects/init.md", "docs/concepts/projects/init.md",
"docs/concepts/projects/workspaces.md", "docs/concepts/projects/workspaces.md",
{ target = "docs/reference/environment.md", replace = "next release" },
] ]
[tool.rooster.section-labels] [tool.rooster.section-labels]