mirror of https://github.com/astral-sh/uv
1167 lines
46 KiB
Markdown
1167 lines
46 KiB
Markdown
# Environment variables
|
||
|
||
uv defines and respects the following environment variables:
|
||
|
||
<h3 id="uv_break_system_packages">
|
||
<a class="toclink" href="#uv_break_system_packages"><code>UV_BREAK_SYSTEM_PACKAGES</code></a> <small class="env-reference">added in v0.1.32</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
WARNING: `UV_BREAK_SYSTEM_PACKAGES=true` is intended for use in continuous integration
|
||
(CI) or containerized environments and should be used with caution, as modifying the system
|
||
Python can lead to unexpected behavior.
|
||
|
||
<h3 id="uv_build_constraint">
|
||
<a class="toclink" href="#uv_build_constraint"><code>UV_BUILD_CONSTRAINT</code></a> <small class="env-reference">added in v0.2.34</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
<h3 id="uv_cache_dir">
|
||
<a class="toclink" href="#uv_cache_dir"><code>UV_CACHE_DIR</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
Equivalent to the `--cache-dir` command-line argument. If set, uv will use this
|
||
directory for caching instead of the default cache directory.
|
||
|
||
<h3 id="uv_compile_bytecode">
|
||
<a class="toclink" href="#uv_compile_bytecode"><code>UV_COMPILE_BYTECODE</code></a> <small class="env-reference">added in v0.3.3</small></h3>
|
||
|
||
|
||
Equivalent to the `--compile-bytecode` command-line argument. If set, uv
|
||
will compile Python source files to bytecode after installation.
|
||
|
||
<h3 id="uv_compile_bytecode_timeout">
|
||
<a class="toclink" href="#uv_compile_bytecode_timeout"><code>UV_COMPILE_BYTECODE_TIMEOUT</code></a> <small class="env-reference">added in v0.7.22</small></h3>
|
||
|
||
|
||
Timeout (in seconds) for bytecode compilation.
|
||
|
||
<h3 id="uv_concurrent_builds">
|
||
<a class="toclink" href="#uv_concurrent_builds"><code>UV_CONCURRENT_BUILDS</code></a> <small class="env-reference">added in v0.1.43</small></h3>
|
||
|
||
|
||
Sets the maximum number of source distributions that uv will build
|
||
concurrently at any given time.
|
||
|
||
<h3 id="uv_concurrent_downloads">
|
||
<a class="toclink" href="#uv_concurrent_downloads"><code>UV_CONCURRENT_DOWNLOADS</code></a> <small class="env-reference">added in v0.1.43</small></h3>
|
||
|
||
|
||
Sets the maximum number of in-flight concurrent downloads that uv will
|
||
perform at any given time.
|
||
|
||
<h3 id="uv_concurrent_installs">
|
||
<a class="toclink" href="#uv_concurrent_installs"><code>UV_CONCURRENT_INSTALLS</code></a> <small class="env-reference">added in v0.1.45</small></h3>
|
||
|
||
|
||
Controls the number of threads used when installing and unzipping
|
||
packages.
|
||
|
||
<h3 id="uv_config_file">
|
||
<a class="toclink" href="#uv_config_file"><code>UV_CONFIG_FILE</code></a> <small class="env-reference">added in v0.1.34</small></h3>
|
||
|
||
|
||
Equivalent to the `--config-file` command-line argument. Expects a path to a
|
||
local `uv.toml` file to use as the configuration file.
|
||
|
||
<h3 id="uv_constraint">
|
||
<a class="toclink" href="#uv_constraint"><code>UV_CONSTRAINT</code></a> <small class="env-reference">added in v0.1.36</small></h3>
|
||
|
||
|
||
Equivalent to the `--constraint` command-line argument. If set, uv will use this
|
||
file as the constraints file. Uses space-separated list of files.
|
||
|
||
<h3 id="uv_credentials_dir">
|
||
<a class="toclink" href="#uv_credentials_dir"><code>UV_CREDENTIALS_DIR</code></a> <small class="env-reference">added in v0.8.15</small></h3>
|
||
|
||
|
||
The directory for storage of credentials when using a plain text backend.
|
||
|
||
<h3 id="uv_custom_compile_command">
|
||
<a class="toclink" href="#uv_custom_compile_command"><code>UV_CUSTOM_COMPILE_COMMAND</code></a> <small class="env-reference">added in v0.1.23</small></h3>
|
||
|
||
|
||
Equivalent to the `--custom-compile-command` command-line argument.
|
||
|
||
Used to override uv in the output header of the `requirements.txt` files generated by
|
||
`uv pip compile`. Intended for use-cases in which `uv pip compile` is called from within a wrapper
|
||
script, to include the name of the wrapper script in the output file.
|
||
|
||
<h3 id="uv_default_index">
|
||
<a class="toclink" href="#uv_default_index"><code>UV_DEFAULT_INDEX</code></a> <small class="env-reference">added in v0.4.23</small></h3>
|
||
|
||
|
||
Equivalent to the `--default-index` command-line argument. If set, uv will use
|
||
this URL as the default index when searching for packages.
|
||
|
||
<h3 id="uv_dev">
|
||
<a class="toclink" href="#uv_dev"><code>UV_DEV</code></a> <small class="env-reference">added in v0.8.7</small></h3>
|
||
|
||
|
||
Equivalent to the `--dev` command-line argument. If set, uv will include
|
||
development dependencies.
|
||
|
||
<h3 id="uv_download_url">
|
||
<a class="toclink" href="#uv_download_url"><code>UV_DOWNLOAD_URL</code></a> <small class="env-reference">added in v0.8.4</small></h3>
|
||
|
||
|
||
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
|
||
compatibility.
|
||
|
||
<h3 id="uv_env_file">
|
||
<a class="toclink" href="#uv_env_file"><code>UV_ENV_FILE</code></a> <small class="env-reference">added in v0.4.30</small></h3>
|
||
|
||
|
||
`.env` files from which to load environment variables when executing `uv run` commands.
|
||
|
||
<h3 id="uv_exclude_newer">
|
||
<a class="toclink" href="#uv_exclude_newer"><code>UV_EXCLUDE_NEWER</code></a> <small class="env-reference">added in v0.2.12</small></h3>
|
||
|
||
|
||
Equivalent to the `--exclude-newer` command-line argument. If set, uv will
|
||
exclude distributions published after the specified date.
|
||
|
||
<h3 id="uv_extra_index_url">
|
||
<a class="toclink" href="#uv_extra_index_url"><code>UV_EXTRA_INDEX_URL</code></a> <small class="env-reference">added in v0.1.3</small></h3>
|
||
|
||
|
||
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.
|
||
(Deprecated: use `UV_INDEX` instead.)
|
||
|
||
<h3 id="uv_find_links">
|
||
<a class="toclink" href="#uv_find_links"><code>UV_FIND_LINKS</code></a> <small class="env-reference">added in v0.4.19</small></h3>
|
||
|
||
|
||
Equivalent to the `--find-links` command-line argument. If set, uv will use this
|
||
comma-separated list of additional locations to search for packages.
|
||
|
||
<h3 id="uv_fork_strategy">
|
||
<a class="toclink" href="#uv_fork_strategy"><code>UV_FORK_STRATEGY</code></a> <small class="env-reference">added in v0.5.9</small></h3>
|
||
|
||
|
||
Equivalent to the `--fork-strategy` argument. Controls version selection during universal
|
||
resolution.
|
||
|
||
<h3 id="uv_frozen">
|
||
<a class="toclink" href="#uv_frozen"><code>UV_FROZEN</code></a> <small class="env-reference">added in v0.4.25</small></h3>
|
||
|
||
|
||
Equivalent to the `--frozen` command-line argument. If set, uv will run without
|
||
updating the `uv.lock` file.
|
||
|
||
<h3 id="uv_github_token">
|
||
<a class="toclink" href="#uv_github_token"><code>UV_GITHUB_TOKEN</code></a> <small class="env-reference">added in v0.4.10</small></h3>
|
||
|
||
|
||
Equivalent to the `--token` argument for self update. A GitHub token for authentication.
|
||
|
||
<h3 id="uv_git_lfs">
|
||
<a class="toclink" href="#uv_git_lfs"><code>UV_GIT_LFS</code></a> <small class="env-reference">added in v0.5.19</small></h3>
|
||
|
||
|
||
Enables fetching files stored in Git LFS when installing a package from a Git repository.
|
||
|
||
<h3 id="uv_http_retries">
|
||
<a class="toclink" href="#uv_http_retries"><code>UV_HTTP_RETRIES</code></a> <small class="env-reference">added in v0.7.21</small></h3>
|
||
|
||
|
||
The number of retries for HTTP requests. (default: 3)
|
||
|
||
<h3 id="uv_http_timeout">
|
||
<a class="toclink" href="#uv_http_timeout"><code>UV_HTTP_TIMEOUT</code></a> <small class="env-reference">added in v0.1.7</small></h3>
|
||
|
||
|
||
Timeout (in seconds) for HTTP requests. (default: 30 s)
|
||
|
||
<h3 id="uv_index">
|
||
<a class="toclink" href="#uv_index"><code>UV_INDEX</code></a> <small class="env-reference">added in v0.4.23</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
<h3 id="uv_index_strategy">
|
||
<a class="toclink" href="#uv_index_strategy"><code>UV_INDEX_STRATEGY</code></a> <small class="env-reference">added in v0.1.29</small></h3>
|
||
|
||
|
||
Equivalent to the `--index-strategy` command-line argument.
|
||
|
||
For example, if set to `unsafe-best-match`, uv will consider versions of a given package
|
||
available across all index URLs, rather than limiting its search to the first index URL
|
||
that contains the package.
|
||
|
||
<h3 id="uv_index_url">
|
||
<a class="toclink" href="#uv_index_url"><code>UV_INDEX_URL</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
Equivalent to the `--index-url` command-line argument. If set, uv will use this
|
||
URL as the default index when searching for packages.
|
||
(Deprecated: use `UV_DEFAULT_INDEX` instead.)
|
||
|
||
<h3 id="uv_index_{name}_password">
|
||
<a class="toclink" href="#uv_index_{name}_password"><code>UV_INDEX_{name}_PASSWORD</code></a> <small class="env-reference">added in v0.4.23</small></h3>
|
||
|
||
|
||
Provides the HTTP Basic authentication password for a named index.
|
||
|
||
The `name` parameter is the name of the index. For example, given an index named `foo`,
|
||
the environment variable key would be `UV_INDEX_FOO_PASSWORD`.
|
||
|
||
<h3 id="uv_index_{name}_username">
|
||
<a class="toclink" href="#uv_index_{name}_username"><code>UV_INDEX_{name}_USERNAME</code></a> <small class="env-reference">added in v0.4.23</small></h3>
|
||
|
||
|
||
Provides the HTTP Basic authentication username for a named index.
|
||
|
||
The `name` parameter is the name of the index. For example, given an index named `foo`,
|
||
the environment variable key would be `UV_INDEX_FOO_USERNAME`.
|
||
|
||
<h3 id="uv_init_build_backend">
|
||
<a class="toclink" href="#uv_init_build_backend"><code>UV_INIT_BUILD_BACKEND</code></a> <small class="env-reference">added in v0.8.2</small></h3>
|
||
|
||
|
||
Equivalent to the `--build-backend` argument for `uv init`. Determines the default backend
|
||
to use when creating a new project.
|
||
|
||
<h3 id="uv_insecure_host">
|
||
<a class="toclink" href="#uv_insecure_host"><code>UV_INSECURE_HOST</code></a> <small class="env-reference">added in v0.3.5</small></h3>
|
||
|
||
|
||
Equivalent to the `--allow-insecure-host` argument.
|
||
|
||
<h3 id="uv_insecure_no_zip_validation">
|
||
<a class="toclink" href="#uv_insecure_no_zip_validation"><code>UV_INSECURE_NO_ZIP_VALIDATION</code></a> <small class="env-reference">added in v0.8.6</small></h3>
|
||
|
||
|
||
Disable ZIP validation for streamed wheels and ZIP-based source distributions.
|
||
|
||
WARNING: Disabling ZIP validation can expose your system to security risks by bypassing
|
||
integrity checks and allowing uv to install potentially malicious ZIP files. If uv rejects
|
||
a ZIP file due to failing validation, it is likely that the file is malformed; consider
|
||
filing an issue with the package maintainer.
|
||
|
||
<h3 id="uv_installer_ghe_base_url">
|
||
<a class="toclink" href="#uv_installer_ghe_base_url"><code>UV_INSTALLER_GHE_BASE_URL</code></a> <small class="env-reference">added in v0.5.0</small></h3>
|
||
|
||
|
||
The URL from which to download uv using the standalone installer and `self update` feature,
|
||
in lieu of the default GitHub Enterprise URL.
|
||
|
||
<h3 id="uv_installer_github_base_url">
|
||
<a class="toclink" href="#uv_installer_github_base_url"><code>UV_INSTALLER_GITHUB_BASE_URL</code></a> <small class="env-reference">added in v0.5.0</small></h3>
|
||
|
||
|
||
The URL from which to download uv using the standalone installer and `self update` feature,
|
||
in lieu of the default GitHub URL.
|
||
|
||
<h3 id="uv_install_dir">
|
||
<a class="toclink" href="#uv_install_dir"><code>UV_INSTALL_DIR</code></a> <small class="env-reference">added in v0.5.0</small></h3>
|
||
|
||
|
||
The directory in which to install uv using the standalone installer and `self update` feature.
|
||
Defaults to `~/.local/bin`.
|
||
|
||
<h3 id="uv_isolated">
|
||
<a class="toclink" href="#uv_isolated"><code>UV_ISOLATED</code></a> <small class="env-reference">added in v0.8.14</small></h3>
|
||
|
||
|
||
Equivalent to the `--isolated` command-line argument. If set, uv will avoid discovering
|
||
a `pyproject.toml` or `uv.toml` file.
|
||
|
||
<h3 id="uv_keyring_provider">
|
||
<a class="toclink" href="#uv_keyring_provider"><code>UV_KEYRING_PROVIDER</code></a> <small class="env-reference">added in v0.1.19</small></h3>
|
||
|
||
|
||
Equivalent to the `--keyring-provider` command-line argument. If set, uv
|
||
will use this value as the keyring provider.
|
||
|
||
<h3 id="uv_libc">
|
||
<a class="toclink" href="#uv_libc"><code>UV_LIBC</code></a> <small class="env-reference">added in v0.7.22</small></h3>
|
||
|
||
|
||
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`.
|
||
|
||
<h3 id="uv_link_mode">
|
||
<a class="toclink" href="#uv_link_mode"><code>UV_LINK_MODE</code></a> <small class="env-reference">added in v0.1.40</small></h3>
|
||
|
||
|
||
Equivalent to the `--link-mode` command-line argument. If set, uv will use this as
|
||
a link mode.
|
||
|
||
<h3 id="uv_locked">
|
||
<a class="toclink" href="#uv_locked"><code>UV_LOCKED</code></a> <small class="env-reference">added in v0.4.25</small></h3>
|
||
|
||
|
||
Equivalent to the `--locked` command-line argument. If set, uv will assert that the
|
||
`uv.lock` remains unchanged.
|
||
|
||
<h3 id="uv_log_context">
|
||
<a class="toclink" href="#uv_log_context"><code>UV_LOG_CONTEXT</code></a> <small class="env-reference">added in v0.6.4</small></h3>
|
||
|
||
|
||
Add additional context and structure to log messages.
|
||
|
||
If logging is not enabled, e.g., with `RUST_LOG` or `-v`, this has no effect.
|
||
|
||
<h3 id="uv_managed_python">
|
||
<a class="toclink" href="#uv_managed_python"><code>UV_MANAGED_PYTHON</code></a> <small class="env-reference">added in v0.6.8</small></h3>
|
||
|
||
|
||
Require use of uv-managed Python versions.
|
||
|
||
<h3 id="uv_native_tls">
|
||
<a class="toclink" href="#uv_native_tls"><code>UV_NATIVE_TLS</code></a> <small class="env-reference">added in v0.1.19</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
<h3 id="uv_no_binary">
|
||
<a class="toclink" href="#uv_no_binary"><code>UV_NO_BINARY</code></a> <small class="env-reference">added in v0.5.30</small></h3>
|
||
|
||
|
||
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
|
||
extract package metadata, if available.
|
||
|
||
<h3 id="uv_no_binary_package">
|
||
<a class="toclink" href="#uv_no_binary_package"><code>UV_NO_BINARY_PACKAGE</code></a> <small class="env-reference">added in v0.5.30</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
<h3 id="uv_no_build">
|
||
<a class="toclink" href="#uv_no_build"><code>UV_NO_BUILD</code></a> <small class="env-reference">added in v0.1.40</small></h3>
|
||
|
||
|
||
Equivalent to the `--no-build` command-line argument. If set, uv will not build
|
||
source distributions.
|
||
|
||
<h3 id="uv_no_build_isolation">
|
||
<a class="toclink" href="#uv_no_build_isolation"><code>UV_NO_BUILD_ISOLATION</code></a> <small class="env-reference">added in v0.1.40</small></h3>
|
||
|
||
|
||
Equivalent to the `--no-build-isolation` command-line argument. If set, uv will
|
||
skip isolation when building source distributions.
|
||
|
||
<h3 id="uv_no_build_package">
|
||
<a class="toclink" href="#uv_no_build_package"><code>UV_NO_BUILD_PACKAGE</code></a> <small class="env-reference">added in v0.6.5</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
<h3 id="uv_no_cache">
|
||
<a class="toclink" href="#uv_no_cache"><code>UV_NO_CACHE</code></a> <small class="env-reference">added in v0.1.2</small></h3>
|
||
|
||
|
||
Equivalent to the `--no-cache` command-line argument. If set, uv will not use the
|
||
cache for any operations.
|
||
|
||
<h3 id="uv_no_config">
|
||
<a class="toclink" href="#uv_no_config"><code>UV_NO_CONFIG</code></a> <small class="env-reference">added in v0.2.30</small></h3>
|
||
|
||
|
||
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
|
||
directories.
|
||
|
||
<h3 id="uv_no_dev">
|
||
<a class="toclink" href="#uv_no_dev"><code>UV_NO_DEV</code></a> <small class="env-reference">added in v0.8.7</small></h3>
|
||
|
||
|
||
Equivalent to the `--no-dev` command-line argument. If set, uv will exclude
|
||
development dependencies.
|
||
|
||
<h3 id="uv_no_editable">
|
||
<a class="toclink" href="#uv_no_editable"><code>UV_NO_EDITABLE</code></a> <small class="env-reference">added in v0.6.15</small></h3>
|
||
|
||
|
||
Equivalent to the `--no-editable` command-line argument. If set, uv
|
||
installs or exports any editable dependencies, including the project and any workspace
|
||
members, as non-editable.
|
||
|
||
<h3 id="uv_no_env_file">
|
||
<a class="toclink" href="#uv_no_env_file"><code>UV_NO_ENV_FILE</code></a> <small class="env-reference">added in v0.4.30</small></h3>
|
||
|
||
|
||
Ignore `.env` files when executing `uv run` commands.
|
||
|
||
<h3 id="uv_no_github_fast_path">
|
||
<a class="toclink" href="#uv_no_github_fast_path"><code>UV_NO_GITHUB_FAST_PATH</code></a> <small class="env-reference">added in v0.7.13</small></h3>
|
||
|
||
|
||
Disable GitHub-specific requests that allow uv to skip `git fetch` in some circumstances.
|
||
|
||
<h3 id="uv_no_hf_token">
|
||
<a class="toclink" href="#uv_no_hf_token"><code>UV_NO_HF_TOKEN</code></a> <small class="env-reference">added in v0.8.1</small></h3>
|
||
|
||
|
||
Disable Hugging Face authentication, even if `HF_TOKEN` is set.
|
||
|
||
<h3 id="uv_no_installer_metadata">
|
||
<a class="toclink" href="#uv_no_installer_metadata"><code>UV_NO_INSTALLER_METADATA</code></a> <small class="env-reference">added in v0.5.7</small></h3>
|
||
|
||
|
||
Skip writing `uv` installer metadata files (e.g., `INSTALLER`, `REQUESTED`, and `direct_url.json`) to site-packages `.dist-info` directories.
|
||
|
||
<h3 id="uv_no_managed_python">
|
||
<a class="toclink" href="#uv_no_managed_python"><code>UV_NO_MANAGED_PYTHON</code></a> <small class="env-reference">added in v0.6.8</small></h3>
|
||
|
||
|
||
Disable use of uv-managed Python versions.
|
||
|
||
<h3 id="uv_no_modify_path">
|
||
<a class="toclink" href="#uv_no_modify_path"><code>UV_NO_MODIFY_PATH</code></a> <small class="env-reference">added in v0.8.4</small></h3>
|
||
|
||
|
||
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
|
||
alias, for backwards compatibility.
|
||
|
||
<h3 id="uv_no_progress">
|
||
<a class="toclink" href="#uv_no_progress"><code>UV_NO_PROGRESS</code></a> <small class="env-reference">added in v0.2.28</small></h3>
|
||
|
||
|
||
Equivalent to the `--no-progress` command-line argument. Disables all progress output. For
|
||
example, spinners and progress bars.
|
||
|
||
<h3 id="uv_no_sync">
|
||
<a class="toclink" href="#uv_no_sync"><code>UV_NO_SYNC</code></a> <small class="env-reference">added in v0.4.18</small></h3>
|
||
|
||
|
||
Equivalent to the `--no-sync` command-line argument. If set, uv will skip updating
|
||
the environment.
|
||
|
||
<h3 id="uv_no_verify_hashes">
|
||
<a class="toclink" href="#uv_no_verify_hashes"><code>UV_NO_VERIFY_HASHES</code></a> <small class="env-reference">added in v0.5.3</small></h3>
|
||
|
||
|
||
Equivalent to the `--no-verify-hashes` argument. Disables hash verification for
|
||
`requirements.txt` files.
|
||
|
||
<h3 id="uv_no_wrap">
|
||
<a class="toclink" href="#uv_no_wrap"><code>UV_NO_WRAP</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
Use to disable line wrapping for diagnostics.
|
||
|
||
<h3 id="uv_offline">
|
||
<a class="toclink" href="#uv_offline"><code>UV_OFFLINE</code></a> <small class="env-reference">added in v0.5.9</small></h3>
|
||
|
||
|
||
Equivalent to the `--offline` command-line argument. If set, uv will disable network access.
|
||
|
||
<h3 id="uv_override">
|
||
<a class="toclink" href="#uv_override"><code>UV_OVERRIDE</code></a> <small class="env-reference">added in v0.2.22</small></h3>
|
||
|
||
|
||
Equivalent to the `--override` command-line argument. If set, uv will use this file
|
||
as the overrides file. Uses space-separated list of files.
|
||
|
||
<h3 id="uv_prerelease">
|
||
<a class="toclink" href="#uv_prerelease"><code>UV_PRERELEASE</code></a> <small class="env-reference">added in v0.1.16</small></h3>
|
||
|
||
|
||
Equivalent to the `--prerelease` command-line argument. For example, if set to
|
||
`allow`, uv will allow pre-release versions for all dependencies.
|
||
|
||
<h3 id="uv_preview">
|
||
<a class="toclink" href="#uv_preview"><code>UV_PREVIEW</code></a> <small class="env-reference">added in v0.1.37</small></h3>
|
||
|
||
|
||
Equivalent to the `--preview` argument. Enables preview mode.
|
||
|
||
<h3 id="uv_preview_features">
|
||
<a class="toclink" href="#uv_preview_features"><code>UV_PREVIEW_FEATURES</code></a> <small class="env-reference">added in v0.8.4</small></h3>
|
||
|
||
|
||
Equivalent to the `--preview-features` argument. Enables specific preview features.
|
||
|
||
<h3 id="uv_project">
|
||
<a class="toclink" href="#uv_project"><code>UV_PROJECT</code></a> <small class="env-reference">added in v0.4.4</small></h3>
|
||
|
||
|
||
Equivalent to the `--project` command-line argument.
|
||
|
||
<h3 id="uv_project_environment">
|
||
<a class="toclink" href="#uv_project_environment"><code>UV_PROJECT_ENVIRONMENT</code></a> <small class="env-reference">added in v0.4.4</small></h3>
|
||
|
||
|
||
Specifies the path to the directory to use for a project virtual environment.
|
||
|
||
See the [project documentation](../concepts/projects/config.md#project-environment-path)
|
||
for more details.
|
||
|
||
<h3 id="uv_publish_check_url">
|
||
<a class="toclink" href="#uv_publish_check_url"><code>UV_PUBLISH_CHECK_URL</code></a> <small class="env-reference">added in v0.4.30</small></h3>
|
||
|
||
|
||
Don't upload a file if it already exists on the index. The value is the URL of the index.
|
||
|
||
<h3 id="uv_publish_index">
|
||
<a class="toclink" href="#uv_publish_index"><code>UV_PUBLISH_INDEX</code></a> <small class="env-reference">added in v0.5.8</small></h3>
|
||
|
||
|
||
Equivalent to the `--index` command-line argument in `uv publish`. If
|
||
set, uv the index with this name in the configuration for publishing.
|
||
|
||
<h3 id="uv_publish_password">
|
||
<a class="toclink" href="#uv_publish_password"><code>UV_PUBLISH_PASSWORD</code></a> <small class="env-reference">added in v0.4.16</small></h3>
|
||
|
||
|
||
Equivalent to the `--password` command-line argument in `uv publish`. If
|
||
set, uv will use this password for publishing.
|
||
|
||
<h3 id="uv_publish_token">
|
||
<a class="toclink" href="#uv_publish_token"><code>UV_PUBLISH_TOKEN</code></a> <small class="env-reference">added in v0.4.16</small></h3>
|
||
|
||
|
||
Equivalent to the `--token` command-line argument in `uv publish`. If set, uv
|
||
will use this token (with the username `__token__`) for publishing.
|
||
|
||
<h3 id="uv_publish_url">
|
||
<a class="toclink" href="#uv_publish_url"><code>UV_PUBLISH_URL</code></a> <small class="env-reference">added in v0.4.16</small></h3>
|
||
|
||
|
||
Equivalent to the `--publish-url` command-line argument. The URL of the upload
|
||
endpoint of the index to use with `uv publish`.
|
||
|
||
<h3 id="uv_publish_username">
|
||
<a class="toclink" href="#uv_publish_username"><code>UV_PUBLISH_USERNAME</code></a> <small class="env-reference">added in v0.4.16</small></h3>
|
||
|
||
|
||
Equivalent to the `--username` command-line argument in `uv publish`. If
|
||
set, uv will use this username for publishing.
|
||
|
||
<h3 id="uv_pypy_install_mirror">
|
||
<a class="toclink" href="#uv_pypy_install_mirror"><code>UV_PYPY_INSTALL_MIRROR</code></a> <small class="env-reference">added in v0.2.35</small></h3>
|
||
|
||
|
||
Managed PyPy installations are downloaded from [python.org](https://downloads.python.org/).
|
||
|
||
This variable can be set to a mirror URL to use a
|
||
different source for PyPy installations. The provided URL will replace
|
||
`https://downloads.python.org/pypy` in, e.g.,
|
||
`https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2`.
|
||
Distributions can be read from a local directory by using the `file://` URL scheme.
|
||
|
||
<h3 id="uv_python">
|
||
<a class="toclink" href="#uv_python"><code>UV_PYTHON</code></a> <small class="env-reference">added in v0.1.40</small></h3>
|
||
|
||
|
||
Equivalent to the `--python` command-line argument. If set to a path, uv will use
|
||
this Python interpreter for all operations.
|
||
|
||
<h3 id="uv_python_bin_dir">
|
||
<a class="toclink" href="#uv_python_bin_dir"><code>UV_PYTHON_BIN_DIR</code></a> <small class="env-reference">added in v0.4.29</small></h3>
|
||
|
||
|
||
Specifies the directory to place links to installed, managed Python executables.
|
||
|
||
<h3 id="uv_python_cache_dir">
|
||
<a class="toclink" href="#uv_python_cache_dir"><code>UV_PYTHON_CACHE_DIR</code></a> <small class="env-reference">added in v0.7.0</small></h3>
|
||
|
||
|
||
Specifies the directory for caching the archives of managed Python installations before
|
||
installation.
|
||
|
||
<h3 id="uv_python_cpython_build">
|
||
<a class="toclink" href="#uv_python_cpython_build"><code>UV_PYTHON_CPYTHON_BUILD</code></a> <small class="env-reference">added in v0.8.14</small></h3>
|
||
|
||
|
||
Pin managed CPython versions to a specific build version.
|
||
|
||
For CPython, this should be the build date (e.g., "20250814").
|
||
|
||
<h3 id="uv_python_downloads">
|
||
<a class="toclink" href="#uv_python_downloads"><code>UV_PYTHON_DOWNLOADS</code></a> <small class="env-reference">added in v0.3.2</small></h3>
|
||
|
||
|
||
Equivalent to the
|
||
[`python-downloads`](../reference/settings.md#python-downloads) setting and, when disabled, the
|
||
`--no-python-downloads` option. Whether uv should allow Python downloads.
|
||
|
||
<h3 id="uv_python_downloads_json_url">
|
||
<a class="toclink" href="#uv_python_downloads_json_url"><code>UV_PYTHON_DOWNLOADS_JSON_URL</code></a> <small class="env-reference">added in v0.6.13</small></h3>
|
||
|
||
|
||
Managed Python installations information is hardcoded in the `uv` binary.
|
||
|
||
This variable can be set to a URL pointing to JSON to use as a list for Python installations.
|
||
This will allow for setting each property of the Python installation, mostly the url part for offline mirror.
|
||
|
||
Note that currently, only local paths are supported.
|
||
|
||
<h3 id="uv_python_graalpy_build">
|
||
<a class="toclink" href="#uv_python_graalpy_build"><code>UV_PYTHON_GRAALPY_BUILD</code></a> <small class="env-reference">added in v0.8.14</small></h3>
|
||
|
||
|
||
Pin managed GraalPy versions to a specific build version.
|
||
|
||
For GraalPy, this should be the GraalPy version (e.g., "24.2.2").
|
||
|
||
<h3 id="uv_python_install_bin">
|
||
<a class="toclink" href="#uv_python_install_bin"><code>UV_PYTHON_INSTALL_BIN</code></a> <small class="env-reference">added in v0.8.0</small></h3>
|
||
|
||
|
||
Whether to install the Python executable into the `UV_PYTHON_BIN_DIR` directory.
|
||
|
||
<h3 id="uv_python_install_dir">
|
||
<a class="toclink" href="#uv_python_install_dir"><code>UV_PYTHON_INSTALL_DIR</code></a> <small class="env-reference">added in v0.2.22</small></h3>
|
||
|
||
|
||
Specifies the directory for storing managed Python installations.
|
||
|
||
<h3 id="uv_python_install_mirror">
|
||
<a class="toclink" href="#uv_python_install_mirror"><code>UV_PYTHON_INSTALL_MIRROR</code></a> <small class="env-reference">added in v0.2.35</small></h3>
|
||
|
||
|
||
Managed Python installations are downloaded from the Astral
|
||
[`python-build-standalone`](https://github.com/astral-sh/python-build-standalone) project.
|
||
|
||
This variable can be set to a mirror URL to use a different source for Python installations.
|
||
The provided URL will replace `https://github.com/astral-sh/python-build-standalone/releases/download` in, e.g.,
|
||
`https://github.com/astral-sh/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gz`.
|
||
Distributions can be read from a local directory by using the `file://` URL scheme.
|
||
|
||
<h3 id="uv_python_install_registry">
|
||
<a class="toclink" href="#uv_python_install_registry"><code>UV_PYTHON_INSTALL_REGISTRY</code></a> <small class="env-reference">added in v0.8.0</small></h3>
|
||
|
||
|
||
Whether to install the Python executable into the Windows registry.
|
||
|
||
<h3 id="uv_python_preference">
|
||
<a class="toclink" href="#uv_python_preference"><code>UV_PYTHON_PREFERENCE</code></a> <small class="env-reference">added in v0.3.2</small></h3>
|
||
|
||
|
||
Whether uv should prefer system or managed Python versions.
|
||
|
||
<h3 id="uv_python_pyodide_build">
|
||
<a class="toclink" href="#uv_python_pyodide_build"><code>UV_PYTHON_PYODIDE_BUILD</code></a> <small class="env-reference">added in v0.8.14</small></h3>
|
||
|
||
|
||
Pin managed Pyodide versions to a specific build version.
|
||
|
||
For Pyodide, this should be the Pyodide version (e.g., "0.28.1").
|
||
|
||
<h3 id="uv_python_pypy_build">
|
||
<a class="toclink" href="#uv_python_pypy_build"><code>UV_PYTHON_PYPY_BUILD</code></a> <small class="env-reference">added in v0.8.14</small></h3>
|
||
|
||
|
||
Pin managed PyPy versions to a specific build version.
|
||
|
||
For PyPy, this should be the PyPy version (e.g., "7.3.20").
|
||
|
||
<h3 id="uv_request_timeout">
|
||
<a class="toclink" href="#uv_request_timeout"><code>UV_REQUEST_TIMEOUT</code></a> <small class="env-reference">added in v0.1.6</small></h3>
|
||
|
||
|
||
Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`.
|
||
|
||
<h3 id="uv_require_hashes">
|
||
<a class="toclink" href="#uv_require_hashes"><code>UV_REQUIRE_HASHES</code></a> <small class="env-reference">added in v0.1.34</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
<h3 id="uv_resolution">
|
||
<a class="toclink" href="#uv_resolution"><code>UV_RESOLUTION</code></a> <small class="env-reference">added in v0.1.27</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
<h3 id="uv_stack_size">
|
||
<a class="toclink" href="#uv_stack_size"><code>UV_STACK_SIZE</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
Use to set the stack size used by uv.
|
||
|
||
The value is in bytes, and if both `UV_STACK_SIZE` are `RUST_MIN_STACK` unset, uv uses a 4MB
|
||
(4194304) stack. `UV_STACK_SIZE` takes precedence over `RUST_MIN_STACK`.
|
||
|
||
Unlike the normal `RUST_MIN_STACK` semantics, this can affect main thread
|
||
stack size, because we actually spawn our own main2 thread to work around
|
||
the fact that Windows' real main thread is only 1MB. That thread has size
|
||
`max(UV_STACK_SIZE, 1MB)`.
|
||
|
||
<h3 id="uv_system_python">
|
||
<a class="toclink" href="#uv_system_python"><code>UV_SYSTEM_PYTHON</code></a> <small class="env-reference">added in v0.1.18</small></h3>
|
||
|
||
|
||
Equivalent to the `--system` command-line argument. If set to `true`, uv will
|
||
use the first Python interpreter found in the system `PATH`.
|
||
|
||
WARNING: `UV_SYSTEM_PYTHON=true` is intended for use in continuous integration (CI)
|
||
or containerized environments and should be used with caution, as modifying the system
|
||
Python can lead to unexpected behavior.
|
||
|
||
<h3 id="uv_test_no_http_retry_delay">
|
||
<a class="toclink" href="#uv_test_no_http_retry_delay"><code>UV_TEST_NO_HTTP_RETRY_DELAY</code></a> <small class="env-reference">added in v0.7.21</small></h3>
|
||
|
||
|
||
Used to disable delay for HTTP retries in tests.
|
||
|
||
<h3 id="uv_tool_bin_dir">
|
||
<a class="toclink" href="#uv_tool_bin_dir"><code>UV_TOOL_BIN_DIR</code></a> <small class="env-reference">added in v0.3.0</small></h3>
|
||
|
||
|
||
Specifies the "bin" directory for installing tool executables.
|
||
|
||
<h3 id="uv_tool_dir">
|
||
<a class="toclink" href="#uv_tool_dir"><code>UV_TOOL_DIR</code></a> <small class="env-reference">added in v0.2.16</small></h3>
|
||
|
||
|
||
Specifies the directory where uv stores managed tools.
|
||
|
||
<h3 id="uv_torch_backend">
|
||
<a class="toclink" href="#uv_torch_backend"><code>UV_TORCH_BACKEND</code></a> <small class="env-reference">added in v0.6.9</small></h3>
|
||
|
||
|
||
Equivalent to the `--torch-backend` command-line argument (e.g., `cpu`, `cu126`, or `auto`).
|
||
|
||
<h3 id="uv_unmanaged_install">
|
||
<a class="toclink" href="#uv_unmanaged_install"><code>UV_UNMANAGED_INSTALL</code></a> <small class="env-reference">added in v0.5.0</small></h3>
|
||
|
||
|
||
Used ephemeral environments like CI to install uv to a specific path while preventing
|
||
the installer from modifying shell profiles or environment variables.
|
||
|
||
<h3 id="uv_venv_clear">
|
||
<a class="toclink" href="#uv_venv_clear"><code>UV_VENV_CLEAR</code></a> <small class="env-reference">added in v0.8.0</small></h3>
|
||
|
||
|
||
Equivalent to the `--clear` command-line argument. If set, uv will remove any
|
||
existing files or directories at the target path.
|
||
|
||
<h3 id="uv_venv_seed">
|
||
<a class="toclink" href="#uv_venv_seed"><code>UV_VENV_SEED</code></a> <small class="env-reference">added in v0.5.21</small></h3>
|
||
|
||
|
||
Install seed packages (one or more of: `pip`, `setuptools`, and `wheel`) into the virtual environment
|
||
created by `uv venv`.
|
||
|
||
Note that `setuptools` and `wheel` are not included in Python 3.12+ environments.
|
||
|
||
|
||
|
||
## Externally defined variables
|
||
|
||
uv also reads the following externally defined environment variables:
|
||
|
||
<h3 id="all_proxy">
|
||
<a class="toclink" href="#all_proxy"><code>ALL_PROXY</code></a> <small class="env-reference">added in v0.1.38</small></h3>
|
||
|
||
|
||
General proxy for all network requests.
|
||
|
||
<h3 id="android_api_level">
|
||
<a class="toclink" href="#android_api_level"><code>ANDROID_API_LEVEL</code></a> <small class="env-reference">added in v0.8.16</small></h3>
|
||
|
||
|
||
Used with `--python-platform aarch64-linux-android` and related variants to set the
|
||
Android API level. (i.e., the minimum supported Android API level).
|
||
|
||
Defaults to `24`.
|
||
|
||
<h3 id="appdata">
|
||
<a class="toclink" href="#appdata"><code>APPDATA</code></a> <small class="env-reference">added in v0.1.42</small></h3>
|
||
|
||
|
||
Path to user-level configuration directory on Windows systems.
|
||
|
||
<h3 id="bash_version">
|
||
<a class="toclink" href="#bash_version"><code>BASH_VERSION</code></a> <small class="env-reference">added in v0.1.28</small></h3>
|
||
|
||
|
||
Used to detect Bash shell usage.
|
||
|
||
<h3 id="clicolor_force">
|
||
<a class="toclink" href="#clicolor_force"><code>CLICOLOR_FORCE</code></a> <small class="env-reference">added in v0.1.32</small></h3>
|
||
|
||
|
||
Use to control color via `anstyle`.
|
||
|
||
<h3 id="columns">
|
||
<a class="toclink" href="#columns"><code>COLUMNS</code></a> <small class="env-reference">added in v0.6.2</small></h3>
|
||
|
||
|
||
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)`.
|
||
|
||
<h3 id="conda_default_env">
|
||
<a class="toclink" href="#conda_default_env"><code>CONDA_DEFAULT_ENV</code></a> <small class="env-reference">added in v0.5.0</small></h3>
|
||
|
||
|
||
Used to determine the name of the active Conda environment.
|
||
|
||
<h3 id="conda_prefix">
|
||
<a class="toclink" href="#conda_prefix"><code>CONDA_PREFIX</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
Used to detect the path of an active Conda environment.
|
||
|
||
<h3 id="conda_root">
|
||
<a class="toclink" href="#conda_root"><code>CONDA_ROOT</code></a> <small class="env-reference">added in v0.8.18</small></h3>
|
||
|
||
|
||
Used to determine the root install path of Conda.
|
||
|
||
<h3 id="fish_version">
|
||
<a class="toclink" href="#fish_version"><code>FISH_VERSION</code></a> <small class="env-reference">added in v0.1.28</small></h3>
|
||
|
||
|
||
Used to detect Fish shell usage.
|
||
|
||
<h3 id="force_color">
|
||
<a class="toclink" href="#force_color"><code>FORCE_COLOR</code></a> <small class="env-reference">added in v0.2.7</small></h3>
|
||
|
||
|
||
Forces colored output regardless of terminal support.
|
||
|
||
See [force-color.org](https://force-color.org).
|
||
|
||
<h3 id="github_actions">
|
||
<a class="toclink" href="#github_actions"><code>GITHUB_ACTIONS</code></a> <small class="env-reference">added in v0.4.16</small></h3>
|
||
|
||
|
||
Indicates that the current process is running in GitHub Actions.
|
||
|
||
`uv publish` may attempt trusted publishing flows when set
|
||
to `true`.
|
||
|
||
<h3 id="gitlab_ci">
|
||
<a class="toclink" href="#gitlab_ci"><code>GITLAB_CI</code></a> <small class="env-reference">added in v0.8.18</small></h3>
|
||
|
||
|
||
Indicates that the current process is running in GitLab CI.
|
||
|
||
`uv publish` may attempt trusted publishing flows when set
|
||
to `true`.
|
||
|
||
<h3 id="hf_token">
|
||
<a class="toclink" href="#hf_token"><code>HF_TOKEN</code></a> <small class="env-reference">added in v0.8.1</small></h3>
|
||
|
||
|
||
Authentication token for Hugging Face requests. When set, uv will use this token
|
||
when making requests to `https://huggingface.co/` and any subdomains.
|
||
|
||
<h3 id="home">
|
||
<a class="toclink" href="#home"><code>HOME</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
The standard `HOME` env var.
|
||
|
||
<h3 id="https_proxy">
|
||
<a class="toclink" href="#https_proxy"><code>HTTPS_PROXY</code></a> <small class="env-reference">added in v0.1.38</small></h3>
|
||
|
||
|
||
Proxy for HTTPS requests.
|
||
|
||
<h3 id="http_proxy">
|
||
<a class="toclink" href="#http_proxy"><code>HTTP_PROXY</code></a> <small class="env-reference">added in v0.1.38</small></h3>
|
||
|
||
|
||
Proxy for HTTP requests.
|
||
|
||
<h3 id="http_timeout">
|
||
<a class="toclink" href="#http_timeout"><code>HTTP_TIMEOUT</code></a> <small class="env-reference">added in v0.1.7</small></h3>
|
||
|
||
|
||
Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`.
|
||
|
||
<h3 id="iphoneos_deployment_target">
|
||
<a class="toclink" href="#iphoneos_deployment_target"><code>IPHONEOS_DEPLOYMENT_TARGET</code></a> <small class="env-reference">added in v0.8.16</small></h3>
|
||
|
||
|
||
Used with `--python-platform arm64-apple-ios` and related variants to set the
|
||
deployment target (i.e., the minimum supported iOS version).
|
||
|
||
Defaults to `13.0`.
|
||
|
||
<h3 id="jpy_session_name">
|
||
<a class="toclink" href="#jpy_session_name"><code>JPY_SESSION_NAME</code></a> <small class="env-reference">added in v0.2.6</small></h3>
|
||
|
||
|
||
Used to detect when running inside a Jupyter notebook.
|
||
|
||
<h3 id="ksh_version">
|
||
<a class="toclink" href="#ksh_version"><code>KSH_VERSION</code></a> <small class="env-reference">added in v0.2.33</small></h3>
|
||
|
||
|
||
Used to detect Ksh shell usage.
|
||
|
||
<h3 id="localappdata">
|
||
<a class="toclink" href="#localappdata"><code>LOCALAPPDATA</code></a> <small class="env-reference">added in v0.3.3</small></h3>
|
||
|
||
|
||
Used to look for Microsoft Store Pythons installations.
|
||
|
||
<h3 id="macosx_deployment_target">
|
||
<a class="toclink" href="#macosx_deployment_target"><code>MACOSX_DEPLOYMENT_TARGET</code></a> <small class="env-reference">added in v0.1.42</small></h3>
|
||
|
||
|
||
Used with `--python-platform macos` and related variants to set the
|
||
deployment target (i.e., the minimum supported macOS version).
|
||
|
||
Defaults to `13.0`, the least-recent non-EOL macOS version at time of writing.
|
||
|
||
<h3 id="netrc">
|
||
<a class="toclink" href="#netrc"><code>NETRC</code></a> <small class="env-reference">added in v0.1.16</small></h3>
|
||
|
||
|
||
Use to set the .netrc file location.
|
||
|
||
<h3 id="no_color">
|
||
<a class="toclink" href="#no_color"><code>NO_COLOR</code></a> <small class="env-reference">added in v0.2.7</small></h3>
|
||
|
||
|
||
Disables colored output (takes precedence over `FORCE_COLOR`).
|
||
|
||
See [no-color.org](https://no-color.org).
|
||
|
||
<h3 id="no_proxy">
|
||
<a class="toclink" href="#no_proxy"><code>NO_PROXY</code></a> <small class="env-reference">added in v0.1.38</small></h3>
|
||
|
||
|
||
Comma-separated list of hostnames (e.g., `example.com`) and/or patterns (e.g., `192.168.1.0/24`) that should bypass the proxy.
|
||
|
||
<h3 id="nu_version">
|
||
<a class="toclink" href="#nu_version"><code>NU_VERSION</code></a> <small class="env-reference">added in v0.1.16</small></h3>
|
||
|
||
|
||
Used to detect `NuShell` usage.
|
||
|
||
<h3 id="pager">
|
||
<a class="toclink" href="#pager"><code>PAGER</code></a> <small class="env-reference">added in v0.4.18</small></h3>
|
||
|
||
|
||
The standard `PAGER` posix env var. Used by `uv` to configure the appropriate pager.
|
||
|
||
<h3 id="path">
|
||
<a class="toclink" href="#path"><code>PATH</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
The standard `PATH` env var.
|
||
|
||
<h3 id="prompt">
|
||
<a class="toclink" href="#prompt"><code>PROMPT</code></a> <small class="env-reference">added in v0.1.16</small></h3>
|
||
|
||
|
||
Used to detect the use of the Windows Command Prompt (as opposed to PowerShell).
|
||
|
||
<h3 id="pwd">
|
||
<a class="toclink" href="#pwd"><code>PWD</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
The standard `PWD` posix env var.
|
||
|
||
<h3 id="pyc_invalidation_mode">
|
||
<a class="toclink" href="#pyc_invalidation_mode"><code>PYC_INVALIDATION_MODE</code></a> <small class="env-reference">added in v0.1.7</small></h3>
|
||
|
||
|
||
The validation modes to use when run with `--compile`.
|
||
|
||
See [`PycInvalidationMode`](https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode).
|
||
|
||
<h3 id="pythonpath">
|
||
<a class="toclink" href="#pythonpath"><code>PYTHONPATH</code></a> <small class="env-reference">added in v0.1.22</small></h3>
|
||
|
||
|
||
Adds directories to Python module search path (e.g., `PYTHONPATH=/path/to/modules`).
|
||
|
||
<h3 id="pyx_api_key">
|
||
<a class="toclink" href="#pyx_api_key"><code>PYX_API_KEY</code></a> <small class="env-reference">added in v0.8.15</small></h3>
|
||
|
||
|
||
The pyx API key (e.g., `sk-pyx-...`).
|
||
|
||
<h3 id="pyx_api_url">
|
||
<a class="toclink" href="#pyx_api_url"><code>PYX_API_URL</code></a> <small class="env-reference">added in v0.8.15</small></h3>
|
||
|
||
|
||
The URL of the pyx Simple API server.
|
||
|
||
<h3 id="pyx_auth_token">
|
||
<a class="toclink" href="#pyx_auth_token"><code>PYX_AUTH_TOKEN</code></a> <small class="env-reference">added in v0.8.15</small></h3>
|
||
|
||
|
||
The pyx authentication token (e.g., `eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...`), as output by `uv auth token`.
|
||
|
||
<h3 id="pyx_cdn_domain">
|
||
<a class="toclink" href="#pyx_cdn_domain"><code>PYX_CDN_DOMAIN</code></a> <small class="env-reference">added in v0.8.15</small></h3>
|
||
|
||
|
||
The domain of the pyx CDN.
|
||
|
||
<h3 id="pyx_credentials_dir">
|
||
<a class="toclink" href="#pyx_credentials_dir"><code>PYX_CREDENTIALS_DIR</code></a> <small class="env-reference">added in v0.8.15</small></h3>
|
||
|
||
|
||
Specifies the directory where uv stores pyx credentials.
|
||
|
||
<h3 id="rust_backtrace">
|
||
<a class="toclink" href="#rust_backtrace"><code>RUST_BACKTRACE</code></a> <small class="env-reference">added in v0.7.22</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
For example:
|
||
|
||
* `RUST_BACKTRACE=1` will print a short backtrace.
|
||
* `RUST_BACKTRACE=full` will print a full backtrace.
|
||
|
||
See the [Rust backtrace documentation](https://doc.rust-lang.org/std/backtrace/index.html)
|
||
for more.
|
||
|
||
<h3 id="rust_log">
|
||
<a class="toclink" href="#rust_log"><code>RUST_LOG</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
If set, uv will use this value as the log level for its `--verbose` output. Accepts
|
||
any filter compatible with the `tracing_subscriber` crate.
|
||
|
||
For example:
|
||
|
||
* `RUST_LOG=uv=debug` is the equivalent of adding `--verbose` to the command line
|
||
* `RUST_LOG=trace` will enable trace-level logging.
|
||
|
||
See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax)
|
||
for more.
|
||
|
||
<h3 id="rust_min_stack">
|
||
<a class="toclink" href="#rust_min_stack"><code>RUST_MIN_STACK</code></a> <small class="env-reference">added in v0.5.19</small></h3>
|
||
|
||
|
||
Use to set the stack size used by uv.
|
||
|
||
The value is in bytes, and if both `UV_STACK_SIZE` are `RUST_MIN_STACK` unset, uv uses a 4MB
|
||
(4194304) stack. `UV_STACK_SIZE` takes precedence over `RUST_MIN_STACK`.
|
||
|
||
Prefer setting `UV_STACK_SIZE`, since `RUST_MIN_STACK` also affects subprocesses, such as
|
||
build backends that use Rust code.
|
||
|
||
Unlike the normal `RUST_MIN_STACK` semantics, this can affect main thread
|
||
stack size, because we actually spawn our own main2 thread to work around
|
||
the fact that Windows' real main thread is only 1MB. That thread has size
|
||
`max(RUST_MIN_STACK, 1MB)`.
|
||
|
||
<h3 id="shell">
|
||
<a class="toclink" href="#shell"><code>SHELL</code></a> <small class="env-reference">added in v0.1.16</small></h3>
|
||
|
||
|
||
The standard `SHELL` posix env var.
|
||
|
||
<h3 id="ssl_cert_file">
|
||
<a class="toclink" href="#ssl_cert_file"><code>SSL_CERT_FILE</code></a> <small class="env-reference">added in v0.1.14</small></h3>
|
||
|
||
|
||
Custom certificate bundle file path for SSL connections.
|
||
|
||
<h3 id="ssl_client_cert">
|
||
<a class="toclink" href="#ssl_client_cert"><code>SSL_CLIENT_CERT</code></a> <small class="env-reference">added in v0.2.11</small></h3>
|
||
|
||
|
||
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.
|
||
|
||
<h3 id="systemdrive">
|
||
<a class="toclink" href="#systemdrive"><code>SYSTEMDRIVE</code></a> <small class="env-reference">added in v0.4.26</small></h3>
|
||
|
||
|
||
Path to system-level configuration directory on Windows systems.
|
||
|
||
<h3 id="tracing_durations_file">
|
||
<a class="toclink" href="#tracing_durations_file"><code>TRACING_DURATIONS_FILE</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
Use to create the tracing durations file via the `tracing-durations-export` feature.
|
||
|
||
<h3 id="userprofile">
|
||
<a class="toclink" href="#userprofile"><code>USERPROFILE</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
Path to root directory of user's profile on Windows systems.
|
||
|
||
<h3 id="uv">
|
||
<a class="toclink" href="#uv"><code>UV</code></a> <small class="env-reference">added in v0.6.0</small></h3>
|
||
|
||
|
||
The path to the binary that was used to invoke uv.
|
||
|
||
This is propagated to all subprocesses spawned by uv.
|
||
|
||
If the executable was invoked through a symbolic link, some platforms will return the path
|
||
of the symbolic link and other platforms will return the path of the symbolic link’s target.
|
||
|
||
See <https://doc.rust-lang.org/std/env/fn.current_exe.html#security> for security
|
||
considerations.
|
||
|
||
<h3 id="virtual_env">
|
||
<a class="toclink" href="#virtual_env"><code>VIRTUAL_ENV</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
Used to detect an activated virtual environment.
|
||
|
||
<h3 id="virtual_env_disable_prompt">
|
||
<a class="toclink" href="#virtual_env_disable_prompt"><code>VIRTUAL_ENV_DISABLE_PROMPT</code></a> <small class="env-reference">added in v0.0.5</small></h3>
|
||
|
||
|
||
If set to `1` before a virtual environment is activated, then the
|
||
virtual environment name will not be prepended to the terminal prompt.
|
||
|
||
<h3 id="xdg_bin_home">
|
||
<a class="toclink" href="#xdg_bin_home"><code>XDG_BIN_HOME</code></a> <small class="env-reference">added in v0.2.16</small></h3>
|
||
|
||
|
||
Path to directory where executables are installed.
|
||
|
||
<h3 id="xdg_cache_home">
|
||
<a class="toclink" href="#xdg_cache_home"><code>XDG_CACHE_HOME</code></a> <small class="env-reference">added in v0.1.17</small></h3>
|
||
|
||
|
||
Path to cache directory on Unix systems.
|
||
|
||
<h3 id="xdg_config_dirs">
|
||
<a class="toclink" href="#xdg_config_dirs"><code>XDG_CONFIG_DIRS</code></a> <small class="env-reference">added in v0.4.26</small></h3>
|
||
|
||
|
||
Path to system-level configuration directory on Unix systems.
|
||
|
||
<h3 id="xdg_config_home">
|
||
<a class="toclink" href="#xdg_config_home"><code>XDG_CONFIG_HOME</code></a> <small class="env-reference">added in v0.1.34</small></h3>
|
||
|
||
|
||
Path to user-level configuration directory on Unix systems.
|
||
|
||
<h3 id="xdg_data_home">
|
||
<a class="toclink" href="#xdg_data_home"><code>XDG_DATA_HOME</code></a> <small class="env-reference">added in v0.2.16</small></h3>
|
||
|
||
|
||
Path to directory for storing managed Python installations and tools.
|
||
|
||
<h3 id="zdotdir">
|
||
<a class="toclink" href="#zdotdir"><code>ZDOTDIR</code></a> <small class="env-reference">added in v0.2.25</small></h3>
|
||
|
||
|
||
Used to determine which `.zshenv` to use when Zsh is being used.
|
||
|
||
<h3 id="zsh_version">
|
||
<a class="toclink" href="#zsh_version"><code>ZSH_VERSION</code></a> <small class="env-reference">added in v0.1.28</small></h3>
|
||
|
||
|
||
Used to detect Zsh shell usage.
|
||
|