uv_static/env_vars.rs
1//! Environment variables used or supported by uv.
2//! Used to generate `docs/reference/environment.md`.
3use uv_macros::{attr_added_in, attr_env_var_pattern, attr_hidden, attribute_env_vars_metadata};
4
5/// Declares all environment variable used throughout `uv` and its crates.
6pub struct EnvVars;
7
8#[attribute_env_vars_metadata]
9impl EnvVars {
10 /// The path to the binary that was used to invoke uv.
11 ///
12 /// This is propagated to all subprocesses spawned by uv.
13 ///
14 /// If the executable was invoked through a symbolic link, some platforms will return the path
15 /// of the symbolic link and other platforms will return the path of the symbolic link’s target.
16 ///
17 /// See <https://doc.rust-lang.org/std/env/fn.current_exe.html#security> for security
18 /// considerations.
19 #[attr_added_in("0.6.0")]
20 pub const UV: &'static str = "UV";
21
22 /// Equivalent to the `--offline` command-line argument. If set, uv will disable network access.
23 #[attr_added_in("0.5.9")]
24 pub const UV_OFFLINE: &'static str = "UV_OFFLINE";
25
26 /// Equivalent to the `--default-index` command-line argument. If set, uv will use
27 /// this URL as the default index when searching for packages.
28 #[attr_added_in("0.4.23")]
29 pub const UV_DEFAULT_INDEX: &'static str = "UV_DEFAULT_INDEX";
30
31 /// Equivalent to the `--index` command-line argument. If set, uv will use this
32 /// space-separated list of URLs as additional indexes when searching for packages.
33 #[attr_added_in("0.4.23")]
34 pub const UV_INDEX: &'static str = "UV_INDEX";
35
36 /// Equivalent to the `--index-url` command-line argument. If set, uv will use this
37 /// URL as the default index when searching for packages.
38 /// (Deprecated: use `UV_DEFAULT_INDEX` instead.)
39 #[attr_added_in("0.0.5")]
40 pub const UV_INDEX_URL: &'static str = "UV_INDEX_URL";
41
42 /// Equivalent to the `--extra-index-url` command-line argument. If set, uv will
43 /// use this space-separated list of URLs as additional indexes when searching for packages.
44 /// (Deprecated: use `UV_INDEX` instead.)
45 #[attr_added_in("0.1.3")]
46 pub const UV_EXTRA_INDEX_URL: &'static str = "UV_EXTRA_INDEX_URL";
47
48 /// Equivalent to the `--find-links` command-line argument. If set, uv will use this
49 /// comma-separated list of additional locations to search for packages.
50 #[attr_added_in("0.4.19")]
51 pub const UV_FIND_LINKS: &'static str = "UV_FIND_LINKS";
52
53 /// Equivalent to the `--no-sources` command-line argument. If set, uv will ignore
54 /// `[tool.uv.sources]` annotations when resolving dependencies.
55 #[attr_added_in("0.9.8")]
56 pub const UV_NO_SOURCES: &'static str = "UV_NO_SOURCES";
57
58 /// Equivalent to the `--cache-dir` command-line argument. If set, uv will use this
59 /// directory for caching instead of the default cache directory.
60 #[attr_added_in("0.0.5")]
61 pub const UV_CACHE_DIR: &'static str = "UV_CACHE_DIR";
62
63 /// The directory for storage of credentials when using a plain text backend.
64 #[attr_added_in("0.8.15")]
65 pub const UV_CREDENTIALS_DIR: &'static str = "UV_CREDENTIALS_DIR";
66
67 /// Equivalent to the `--no-cache` command-line argument. If set, uv will not use the
68 /// cache for any operations.
69 #[attr_added_in("0.1.2")]
70 pub const UV_NO_CACHE: &'static str = "UV_NO_CACHE";
71
72 /// Equivalent to the `--resolution` command-line argument. For example, if set to
73 /// `lowest-direct`, uv will install the lowest compatible versions of all direct dependencies.
74 #[attr_added_in("0.1.27")]
75 pub const UV_RESOLUTION: &'static str = "UV_RESOLUTION";
76
77 /// Equivalent to the `--prerelease` command-line argument. For example, if set to
78 /// `allow`, uv will allow pre-release versions for all dependencies.
79 #[attr_added_in("0.1.16")]
80 pub const UV_PRERELEASE: &'static str = "UV_PRERELEASE";
81
82 /// Equivalent to the `--fork-strategy` argument. Controls version selection during universal
83 /// resolution.
84 #[attr_added_in("0.5.9")]
85 pub const UV_FORK_STRATEGY: &'static str = "UV_FORK_STRATEGY";
86
87 /// Equivalent to the `--system` command-line argument. If set to `true`, uv will
88 /// use the first Python interpreter found in the system `PATH`.
89 ///
90 /// WARNING: `UV_SYSTEM_PYTHON=true` is intended for use in continuous integration (CI)
91 /// or containerized environments and should be used with caution, as modifying the system
92 /// Python can lead to unexpected behavior.
93 #[attr_added_in("0.1.18")]
94 pub const UV_SYSTEM_PYTHON: &'static str = "UV_SYSTEM_PYTHON";
95
96 /// Equivalent to the `--python` command-line argument. If set to a path, uv will use
97 /// this Python interpreter for all operations.
98 #[attr_added_in("0.1.40")]
99 pub const UV_PYTHON: &'static str = "UV_PYTHON";
100
101 /// Equivalent to the `--break-system-packages` command-line argument. If set to `true`,
102 /// uv will allow the installation of packages that conflict with system-installed packages.
103 ///
104 /// WARNING: `UV_BREAK_SYSTEM_PACKAGES=true` is intended for use in continuous integration
105 /// (CI) or containerized environments and should be used with caution, as modifying the system
106 /// Python can lead to unexpected behavior.
107 #[attr_added_in("0.1.32")]
108 pub const UV_BREAK_SYSTEM_PACKAGES: &'static str = "UV_BREAK_SYSTEM_PACKAGES";
109
110 /// Equivalent to the `--native-tls` command-line argument. If set to `true`, uv will
111 /// use the system's trust store instead of the bundled `webpki-roots` crate.
112 #[attr_added_in("0.1.19")]
113 pub const UV_NATIVE_TLS: &'static str = "UV_NATIVE_TLS";
114
115 /// Equivalent to the `--index-strategy` command-line argument.
116 ///
117 /// For example, if set to `unsafe-best-match`, uv will consider versions of a given package
118 /// available across all index URLs, rather than limiting its search to the first index URL
119 /// that contains the package.
120 #[attr_added_in("0.1.29")]
121 pub const UV_INDEX_STRATEGY: &'static str = "UV_INDEX_STRATEGY";
122
123 /// Equivalent to the `--require-hashes` command-line argument. If set to `true`,
124 /// uv will require that all dependencies have a hash specified in the requirements file.
125 #[attr_added_in("0.1.34")]
126 pub const UV_REQUIRE_HASHES: &'static str = "UV_REQUIRE_HASHES";
127
128 /// Equivalent to the `--constraints` command-line argument. If set, uv will use this
129 /// file as the constraints file. Uses space-separated list of files.
130 #[attr_added_in("0.1.36")]
131 pub const UV_CONSTRAINT: &'static str = "UV_CONSTRAINT";
132
133 /// Equivalent to the `--build-constraints` command-line argument. If set, uv will use this file
134 /// as constraints for any source distribution builds. Uses space-separated list of files.
135 #[attr_added_in("0.2.34")]
136 pub const UV_BUILD_CONSTRAINT: &'static str = "UV_BUILD_CONSTRAINT";
137
138 /// Equivalent to the `--overrides` command-line argument. If set, uv will use this file
139 /// as the overrides file. Uses space-separated list of files.
140 #[attr_added_in("0.2.22")]
141 pub const UV_OVERRIDE: &'static str = "UV_OVERRIDE";
142
143 /// Equivalent to the `--excludes` command-line argument. If set, uv will use this
144 /// as the excludes file. Uses space-separated list of files.
145 #[attr_added_in("0.9.8")]
146 pub const UV_EXCLUDE: &'static str = "UV_EXCLUDE";
147
148 /// Equivalent to the `--link-mode` command-line argument. If set, uv will use this as
149 /// a link mode.
150 #[attr_added_in("0.1.40")]
151 pub const UV_LINK_MODE: &'static str = "UV_LINK_MODE";
152
153 /// Equivalent to the `--no-build-isolation` command-line argument. If set, uv will
154 /// skip isolation when building source distributions.
155 #[attr_added_in("0.1.40")]
156 pub const UV_NO_BUILD_ISOLATION: &'static str = "UV_NO_BUILD_ISOLATION";
157
158 /// Equivalent to the `--custom-compile-command` command-line argument.
159 ///
160 /// Used to override uv in the output header of the `requirements.txt` files generated by
161 /// `uv pip compile`. Intended for use-cases in which `uv pip compile` is called from within a wrapper
162 /// script, to include the name of the wrapper script in the output file.
163 #[attr_added_in("0.1.23")]
164 pub const UV_CUSTOM_COMPILE_COMMAND: &'static str = "UV_CUSTOM_COMPILE_COMMAND";
165
166 /// Equivalent to the `--keyring-provider` command-line argument. If set, uv
167 /// will use this value as the keyring provider.
168 #[attr_added_in("0.1.19")]
169 pub const UV_KEYRING_PROVIDER: &'static str = "UV_KEYRING_PROVIDER";
170
171 /// Equivalent to the `--config-file` command-line argument. Expects a path to a
172 /// local `uv.toml` file to use as the configuration file.
173 #[attr_added_in("0.1.34")]
174 pub const UV_CONFIG_FILE: &'static str = "UV_CONFIG_FILE";
175
176 /// Equivalent to the `--no-config` command-line argument. If set, uv will not read
177 /// any configuration files from the current directory, parent directories, or user configuration
178 /// directories.
179 #[attr_added_in("0.2.30")]
180 pub const UV_NO_CONFIG: &'static str = "UV_NO_CONFIG";
181
182 /// Equivalent to the `--isolated` command-line argument. If set, uv will avoid discovering
183 /// a `pyproject.toml` or `uv.toml` file.
184 #[attr_added_in("0.8.14")]
185 pub const UV_ISOLATED: &'static str = "UV_ISOLATED";
186
187 /// Equivalent to the `--exclude-newer` command-line argument. If set, uv will
188 /// exclude distributions published after the specified date.
189 #[attr_added_in("0.2.12")]
190 pub const UV_EXCLUDE_NEWER: &'static str = "UV_EXCLUDE_NEWER";
191
192 /// Whether uv should prefer system or managed Python versions.
193 #[attr_added_in("0.3.2")]
194 pub const UV_PYTHON_PREFERENCE: &'static str = "UV_PYTHON_PREFERENCE";
195
196 /// Require use of uv-managed Python versions.
197 #[attr_added_in("0.6.8")]
198 pub const UV_MANAGED_PYTHON: &'static str = "UV_MANAGED_PYTHON";
199
200 /// Disable use of uv-managed Python versions.
201 #[attr_added_in("0.6.8")]
202 pub const UV_NO_MANAGED_PYTHON: &'static str = "UV_NO_MANAGED_PYTHON";
203
204 /// Equivalent to the
205 /// [`python-downloads`](../reference/settings.md#python-downloads) setting and, when disabled, the
206 /// `--no-python-downloads` option. Whether uv should allow Python downloads.
207 #[attr_added_in("0.3.2")]
208 pub const UV_PYTHON_DOWNLOADS: &'static str = "UV_PYTHON_DOWNLOADS";
209
210 /// Overrides the environment-determined libc on linux systems when filling in the current platform
211 /// within Python version requests. Options are: `gnu`, `gnueabi`, `gnueabihf`, `musl`, and `none`.
212 #[attr_added_in("0.7.22")]
213 pub const UV_LIBC: &'static str = "UV_LIBC";
214
215 /// Equivalent to the `--compile-bytecode` command-line argument. If set, uv
216 /// will compile Python source files to bytecode after installation.
217 #[attr_added_in("0.3.3")]
218 pub const UV_COMPILE_BYTECODE: &'static str = "UV_COMPILE_BYTECODE";
219
220 /// Timeout (in seconds) for bytecode compilation.
221 #[attr_added_in("0.7.22")]
222 pub const UV_COMPILE_BYTECODE_TIMEOUT: &'static str = "UV_COMPILE_BYTECODE_TIMEOUT";
223
224 /// Equivalent to the `--no-editable` command-line argument. If set, uv
225 /// installs or exports any editable dependencies, including the project and any workspace
226 /// members, as non-editable.
227 #[attr_added_in("0.6.15")]
228 pub const UV_NO_EDITABLE: &'static str = "UV_NO_EDITABLE";
229
230 /// Equivalent to the `--dev` command-line argument. If set, uv will include
231 /// development dependencies.
232 #[attr_added_in("0.8.7")]
233 pub const UV_DEV: &'static str = "UV_DEV";
234
235 /// Equivalent to the `--no-dev` command-line argument. If set, uv will exclude
236 /// development dependencies.
237 #[attr_added_in("0.8.7")]
238 pub const UV_NO_DEV: &'static str = "UV_NO_DEV";
239
240 /// Equivalent to the `--no-group` command-line argument. If set, uv will disable
241 /// the specified dependency groups for the given space-delimited list of packages.
242 #[attr_added_in("0.9.8")]
243 pub const UV_NO_GROUP: &'static str = "UV_NO_GROUP";
244
245 /// Equivalent to the `--no-default-groups` command-line argument. If set, uv will
246 /// not select the default dependency groups defined in `tool.uv.default-groups`.
247 #[attr_added_in("0.9.9")]
248 pub const UV_NO_DEFAULT_GROUPS: &'static str = "UV_NO_DEFAULT_GROUPS";
249
250 /// Equivalent to the `--no-binary` command-line argument. If set, uv will install
251 /// all packages from source. The resolver will still use pre-built wheels to
252 /// extract package metadata, if available.
253 #[attr_added_in("0.5.30")]
254 pub const UV_NO_BINARY: &'static str = "UV_NO_BINARY";
255
256 /// Equivalent to the `--no-binary-package` command line argument. If set, uv will
257 /// not use pre-built wheels for the given space-delimited list of packages.
258 #[attr_added_in("0.5.30")]
259 pub const UV_NO_BINARY_PACKAGE: &'static str = "UV_NO_BINARY_PACKAGE";
260
261 /// Equivalent to the `--no-build` command-line argument. If set, uv will not build
262 /// source distributions.
263 #[attr_added_in("0.1.40")]
264 pub const UV_NO_BUILD: &'static str = "UV_NO_BUILD";
265
266 /// Equivalent to the `--no-build-package` command line argument. If set, uv will
267 /// not build source distributions for the given space-delimited list of packages.
268 #[attr_added_in("0.6.5")]
269 pub const UV_NO_BUILD_PACKAGE: &'static str = "UV_NO_BUILD_PACKAGE";
270
271 /// Equivalent to the `--publish-url` command-line argument. The URL of the upload
272 /// endpoint of the index to use with `uv publish`.
273 #[attr_added_in("0.4.16")]
274 pub const UV_PUBLISH_URL: &'static str = "UV_PUBLISH_URL";
275
276 /// Equivalent to the `--token` command-line argument in `uv publish`. If set, uv
277 /// will use this token (with the username `__token__`) for publishing.
278 #[attr_added_in("0.4.16")]
279 pub const UV_PUBLISH_TOKEN: &'static str = "UV_PUBLISH_TOKEN";
280
281 /// Equivalent to the `--index` command-line argument in `uv publish`. If
282 /// set, uv the index with this name in the configuration for publishing.
283 #[attr_added_in("0.5.8")]
284 pub const UV_PUBLISH_INDEX: &'static str = "UV_PUBLISH_INDEX";
285
286 /// Equivalent to the `--username` command-line argument in `uv publish`. If
287 /// set, uv will use this username for publishing.
288 #[attr_added_in("0.4.16")]
289 pub const UV_PUBLISH_USERNAME: &'static str = "UV_PUBLISH_USERNAME";
290
291 /// Equivalent to the `--password` command-line argument in `uv publish`. If
292 /// set, uv will use this password for publishing.
293 #[attr_added_in("0.4.16")]
294 pub const UV_PUBLISH_PASSWORD: &'static str = "UV_PUBLISH_PASSWORD";
295
296 /// Don't upload a file if it already exists on the index. The value is the URL of the index.
297 #[attr_added_in("0.4.30")]
298 pub const UV_PUBLISH_CHECK_URL: &'static str = "UV_PUBLISH_CHECK_URL";
299
300 /// Equivalent to the `--no-attestations` command-line argument in `uv publish`. If set,
301 /// uv will skip uploading any collected attestations for the published distributions.
302 #[attr_added_in("0.9.12")]
303 pub const UV_PUBLISH_NO_ATTESTATIONS: &'static str = "UV_PUBLISH_NO_ATTESTATIONS";
304
305 /// Equivalent to the `--no-sync` command-line argument. If set, uv will skip updating
306 /// the environment.
307 #[attr_added_in("0.4.18")]
308 pub const UV_NO_SYNC: &'static str = "UV_NO_SYNC";
309
310 /// Equivalent to the `--locked` command-line argument. If set, uv will assert that the
311 /// `uv.lock` remains unchanged.
312 #[attr_added_in("0.4.25")]
313 pub const UV_LOCKED: &'static str = "UV_LOCKED";
314
315 /// Equivalent to the `--frozen` command-line argument. If set, uv will run without
316 /// updating the `uv.lock` file.
317 #[attr_added_in("0.4.25")]
318 pub const UV_FROZEN: &'static str = "UV_FROZEN";
319
320 /// Equivalent to the `--preview` argument. Enables preview mode.
321 #[attr_added_in("0.1.37")]
322 pub const UV_PREVIEW: &'static str = "UV_PREVIEW";
323
324 /// Equivalent to the `--preview-features` argument. Enables specific preview features.
325 #[attr_added_in("0.8.4")]
326 pub const UV_PREVIEW_FEATURES: &'static str = "UV_PREVIEW_FEATURES";
327
328 /// Equivalent to the `--token` argument for self update. A GitHub token for authentication.
329 #[attr_added_in("0.4.10")]
330 pub const UV_GITHUB_TOKEN: &'static str = "UV_GITHUB_TOKEN";
331
332 /// Equivalent to the `--no-verify-hashes` argument. Disables hash verification for
333 /// `requirements.txt` files.
334 #[attr_added_in("0.5.3")]
335 pub const UV_NO_VERIFY_HASHES: &'static str = "UV_NO_VERIFY_HASHES";
336
337 /// Equivalent to the `--allow-insecure-host` argument.
338 #[attr_added_in("0.3.5")]
339 pub const UV_INSECURE_HOST: &'static str = "UV_INSECURE_HOST";
340
341 /// Disable ZIP validation for streamed wheels and ZIP-based source distributions.
342 ///
343 /// WARNING: Disabling ZIP validation can expose your system to security risks by bypassing
344 /// integrity checks and allowing uv to install potentially malicious ZIP files. If uv rejects
345 /// a ZIP file due to failing validation, it is likely that the file is malformed; consider
346 /// filing an issue with the package maintainer.
347 #[attr_added_in("0.8.6")]
348 pub const UV_INSECURE_NO_ZIP_VALIDATION: &'static str = "UV_INSECURE_NO_ZIP_VALIDATION";
349
350 /// Sets the maximum number of in-flight concurrent downloads that uv will
351 /// perform at any given time.
352 #[attr_added_in("0.1.43")]
353 pub const UV_CONCURRENT_DOWNLOADS: &'static str = "UV_CONCURRENT_DOWNLOADS";
354
355 /// Sets the maximum number of source distributions that uv will build
356 /// concurrently at any given time.
357 #[attr_added_in("0.1.43")]
358 pub const UV_CONCURRENT_BUILDS: &'static str = "UV_CONCURRENT_BUILDS";
359
360 /// Controls the number of threads used when installing and unzipping
361 /// packages.
362 #[attr_added_in("0.1.45")]
363 pub const UV_CONCURRENT_INSTALLS: &'static str = "UV_CONCURRENT_INSTALLS";
364
365 /// Equivalent to the `--no-progress` command-line argument. Disables all progress output. For
366 /// example, spinners and progress bars.
367 #[attr_added_in("0.2.28")]
368 pub const UV_NO_PROGRESS: &'static str = "UV_NO_PROGRESS";
369
370 /// Specifies the directory where uv stores managed tools.
371 #[attr_added_in("0.2.16")]
372 pub const UV_TOOL_DIR: &'static str = "UV_TOOL_DIR";
373
374 /// Specifies the "bin" directory for installing tool executables.
375 #[attr_added_in("0.3.0")]
376 pub const UV_TOOL_BIN_DIR: &'static str = "UV_TOOL_BIN_DIR";
377
378 /// Equivalent to the `--build-backend` argument for `uv init`. Determines the default backend
379 /// to use when creating a new project.
380 #[attr_added_in("0.8.2")]
381 pub const UV_INIT_BUILD_BACKEND: &'static str = "UV_INIT_BUILD_BACKEND";
382
383 /// Specifies the path to the directory to use for a project virtual environment.
384 ///
385 /// See the [project documentation](../concepts/projects/config.md#project-environment-path)
386 /// for more details.
387 #[attr_added_in("0.4.4")]
388 pub const UV_PROJECT_ENVIRONMENT: &'static str = "UV_PROJECT_ENVIRONMENT";
389
390 /// Specifies the directory to place links to installed, managed Python executables.
391 #[attr_added_in("0.4.29")]
392 pub const UV_PYTHON_BIN_DIR: &'static str = "UV_PYTHON_BIN_DIR";
393
394 /// Specifies the directory for storing managed Python installations.
395 #[attr_added_in("0.2.22")]
396 pub const UV_PYTHON_INSTALL_DIR: &'static str = "UV_PYTHON_INSTALL_DIR";
397
398 /// Whether to install the Python executable into the `UV_PYTHON_BIN_DIR` directory.
399 #[attr_added_in("0.8.0")]
400 pub const UV_PYTHON_INSTALL_BIN: &'static str = "UV_PYTHON_INSTALL_BIN";
401
402 /// Whether to install the Python executable into the Windows registry.
403 #[attr_added_in("0.8.0")]
404 pub const UV_PYTHON_INSTALL_REGISTRY: &'static str = "UV_PYTHON_INSTALL_REGISTRY";
405
406 /// Managed Python installations information is hardcoded in the `uv` binary.
407 ///
408 /// This variable can be set to a local path or URL pointing to
409 /// a JSON list of Python installations to override the hardcoded list.
410 ///
411 /// This allows customizing the URLs for downloads or using slightly older or newer versions
412 /// of Python than the ones hardcoded into this build of `uv`.
413 #[attr_added_in("0.6.13")]
414 pub const UV_PYTHON_DOWNLOADS_JSON_URL: &'static str = "UV_PYTHON_DOWNLOADS_JSON_URL";
415
416 /// Specifies the directory for caching the archives of managed Python installations before
417 /// installation.
418 #[attr_added_in("0.7.0")]
419 pub const UV_PYTHON_CACHE_DIR: &'static str = "UV_PYTHON_CACHE_DIR";
420
421 /// Managed Python installations are downloaded from the Astral
422 /// [`python-build-standalone`](https://github.com/astral-sh/python-build-standalone) project.
423 ///
424 /// This variable can be set to a mirror URL to use a different source for Python installations.
425 /// The provided URL will replace `https://github.com/astral-sh/python-build-standalone/releases/download` in, e.g.,
426 /// `https://github.com/astral-sh/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gz`.
427 /// Distributions can be read from a local directory by using the `file://` URL scheme.
428 #[attr_added_in("0.2.35")]
429 pub const UV_PYTHON_INSTALL_MIRROR: &'static str = "UV_PYTHON_INSTALL_MIRROR";
430
431 /// Managed PyPy installations are downloaded from [python.org](https://downloads.python.org/).
432 ///
433 /// This variable can be set to a mirror URL to use a
434 /// different source for PyPy installations. The provided URL will replace
435 /// `https://downloads.python.org/pypy` in, e.g.,
436 /// `https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2`.
437 /// Distributions can be read from a local directory by using the `file://` URL scheme.
438 #[attr_added_in("0.2.35")]
439 pub const UV_PYPY_INSTALL_MIRROR: &'static str = "UV_PYPY_INSTALL_MIRROR";
440
441 /// Pin managed CPython versions to a specific build version.
442 ///
443 /// For CPython, this should be the build date (e.g., "20250814").
444 #[attr_added_in("0.8.14")]
445 pub const UV_PYTHON_CPYTHON_BUILD: &'static str = "UV_PYTHON_CPYTHON_BUILD";
446
447 /// Pin managed PyPy versions to a specific build version.
448 ///
449 /// For PyPy, this should be the PyPy version (e.g., "7.3.20").
450 #[attr_added_in("0.8.14")]
451 pub const UV_PYTHON_PYPY_BUILD: &'static str = "UV_PYTHON_PYPY_BUILD";
452
453 /// Pin managed GraalPy versions to a specific build version.
454 ///
455 /// For GraalPy, this should be the GraalPy version (e.g., "24.2.2").
456 #[attr_added_in("0.8.14")]
457 pub const UV_PYTHON_GRAALPY_BUILD: &'static str = "UV_PYTHON_GRAALPY_BUILD";
458
459 /// Pin managed Pyodide versions to a specific build version.
460 ///
461 /// For Pyodide, this should be the Pyodide version (e.g., "0.28.1").
462 #[attr_added_in("0.8.14")]
463 pub const UV_PYTHON_PYODIDE_BUILD: &'static str = "UV_PYTHON_PYODIDE_BUILD";
464
465 /// Equivalent to the `--clear` command-line argument. If set, uv will remove any
466 /// existing files or directories at the target path.
467 #[attr_added_in("0.8.0")]
468 pub const UV_VENV_CLEAR: &'static str = "UV_VENV_CLEAR";
469
470 /// Install seed packages (one or more of: `pip`, `setuptools`, and `wheel`) into the virtual environment
471 /// created by `uv venv`.
472 ///
473 /// Note that `setuptools` and `wheel` are not included in Python 3.12+ environments.
474 #[attr_added_in("0.5.21")]
475 pub const UV_VENV_SEED: &'static str = "UV_VENV_SEED";
476
477 /// Used to override `PATH` to limit Python executable availability in the test suite.
478 #[attr_hidden]
479 #[attr_added_in("0.0.5")]
480 pub const UV_TEST_PYTHON_PATH: &'static str = "UV_TEST_PYTHON_PATH";
481
482 /// Include resolver and installer output related to environment modifications.
483 #[attr_hidden]
484 #[attr_added_in("0.2.32")]
485 pub const UV_SHOW_RESOLUTION: &'static str = "UV_SHOW_RESOLUTION";
486
487 /// Use to update the json schema files.
488 #[attr_hidden]
489 #[attr_added_in("0.1.34")]
490 pub const UV_UPDATE_SCHEMA: &'static str = "UV_UPDATE_SCHEMA";
491
492 /// Use to disable line wrapping for diagnostics.
493 #[attr_added_in("0.0.5")]
494 pub const UV_NO_WRAP: &'static str = "UV_NO_WRAP";
495
496 /// Provides the HTTP Basic authentication username for a named index.
497 ///
498 /// The `name` parameter is the name of the index. For example, given an index named `foo`,
499 /// the environment variable key would be `UV_INDEX_FOO_USERNAME`.
500 #[attr_added_in("0.4.23")]
501 #[attr_env_var_pattern("UV_INDEX_{name}_USERNAME")]
502 pub fn index_username(name: &str) -> String {
503 format!("UV_INDEX_{name}_USERNAME")
504 }
505
506 /// Provides the HTTP Basic authentication password for a named index.
507 ///
508 /// The `name` parameter is the name of the index. For example, given an index named `foo`,
509 /// the environment variable key would be `UV_INDEX_FOO_PASSWORD`.
510 #[attr_added_in("0.4.23")]
511 #[attr_env_var_pattern("UV_INDEX_{name}_PASSWORD")]
512 pub fn index_password(name: &str) -> String {
513 format!("UV_INDEX_{name}_PASSWORD")
514 }
515
516 /// Used to set the uv commit hash at build time via `build.rs`.
517 #[attr_hidden]
518 #[attr_added_in("0.1.11")]
519 pub const UV_COMMIT_HASH: &'static str = "UV_COMMIT_HASH";
520
521 /// Used to set the uv commit short hash at build time via `build.rs`.
522 #[attr_hidden]
523 #[attr_added_in("0.1.11")]
524 pub const UV_COMMIT_SHORT_HASH: &'static str = "UV_COMMIT_SHORT_HASH";
525
526 /// Used to set the uv commit date at build time via `build.rs`.
527 #[attr_hidden]
528 #[attr_added_in("0.1.11")]
529 pub const UV_COMMIT_DATE: &'static str = "UV_COMMIT_DATE";
530
531 /// Used to set the uv tag at build time via `build.rs`.
532 #[attr_hidden]
533 #[attr_added_in("0.1.11")]
534 pub const UV_LAST_TAG: &'static str = "UV_LAST_TAG";
535
536 /// Used to set the uv tag distance from head at build time via `build.rs`.
537 #[attr_hidden]
538 #[attr_added_in("0.1.11")]
539 pub const UV_LAST_TAG_DISTANCE: &'static str = "UV_LAST_TAG_DISTANCE";
540
541 /// Used to set the spawning/parent interpreter when using --system in the test suite.
542 #[attr_hidden]
543 #[attr_added_in("0.2.0")]
544 pub const UV_INTERNAL__PARENT_INTERPRETER: &'static str = "UV_INTERNAL__PARENT_INTERPRETER";
545
546 /// Used to force showing the derivation tree during resolver error reporting.
547 #[attr_hidden]
548 #[attr_added_in("0.3.0")]
549 pub const UV_INTERNAL__SHOW_DERIVATION_TREE: &'static str = "UV_INTERNAL__SHOW_DERIVATION_TREE";
550
551 /// Used to set a temporary directory for some tests.
552 #[attr_hidden]
553 #[attr_added_in("0.3.4")]
554 pub const UV_INTERNAL__TEST_DIR: &'static str = "UV_INTERNAL__TEST_DIR";
555
556 /// Used to force treating an interpreter as "managed" during tests.
557 #[attr_hidden]
558 #[attr_added_in("0.8.0")]
559 pub const UV_INTERNAL__TEST_PYTHON_MANAGED: &'static str = "UV_INTERNAL__TEST_PYTHON_MANAGED";
560
561 /// Path to system-level configuration directory on Unix systems.
562 #[attr_added_in("0.4.26")]
563 pub const XDG_CONFIG_DIRS: &'static str = "XDG_CONFIG_DIRS";
564
565 /// Path to system-level configuration directory on Windows systems.
566 #[attr_added_in("0.4.26")]
567 pub const SYSTEMDRIVE: &'static str = "SYSTEMDRIVE";
568
569 /// Path to user-level configuration directory on Windows systems.
570 #[attr_added_in("0.1.42")]
571 pub const APPDATA: &'static str = "APPDATA";
572
573 /// Path to root directory of user's profile on Windows systems.
574 #[attr_added_in("0.0.5")]
575 pub const USERPROFILE: &'static str = "USERPROFILE";
576
577 /// Path to user-level configuration directory on Unix systems.
578 #[attr_added_in("0.1.34")]
579 pub const XDG_CONFIG_HOME: &'static str = "XDG_CONFIG_HOME";
580
581 /// Path to cache directory on Unix systems.
582 #[attr_added_in("0.1.17")]
583 pub const XDG_CACHE_HOME: &'static str = "XDG_CACHE_HOME";
584
585 /// Path to directory for storing managed Python installations and tools.
586 #[attr_added_in("0.2.16")]
587 pub const XDG_DATA_HOME: &'static str = "XDG_DATA_HOME";
588
589 /// Path to directory where executables are installed.
590 #[attr_added_in("0.2.16")]
591 pub const XDG_BIN_HOME: &'static str = "XDG_BIN_HOME";
592
593 /// Custom certificate bundle file path for SSL connections.
594 ///
595 /// Takes precedence over `UV_NATIVE_TLS` when set.
596 #[attr_added_in("0.1.14")]
597 pub const SSL_CERT_FILE: &'static str = "SSL_CERT_FILE";
598
599 /// Custom path for certificate bundles for SSL connections.
600 /// Multiple entries are supported separated using a platform-specific
601 /// delimiter (`:` on Unix, `;` on Windows).
602 ///
603 /// Takes precedence over `UV_NATIVE_TLS` when set.
604 #[attr_added_in("0.9.10")]
605 pub const SSL_CERT_DIR: &'static str = "SSL_CERT_DIR";
606
607 /// If set, uv will use this file for mTLS authentication.
608 /// This should be a single file containing both the certificate and the private key in PEM format.
609 #[attr_added_in("0.2.11")]
610 pub const SSL_CLIENT_CERT: &'static str = "SSL_CLIENT_CERT";
611
612 /// Proxy for HTTP requests.
613 #[attr_added_in("0.1.38")]
614 pub const HTTP_PROXY: &'static str = "HTTP_PROXY";
615
616 /// Proxy for HTTPS requests.
617 #[attr_added_in("0.1.38")]
618 pub const HTTPS_PROXY: &'static str = "HTTPS_PROXY";
619
620 /// General proxy for all network requests.
621 #[attr_added_in("0.1.38")]
622 pub const ALL_PROXY: &'static str = "ALL_PROXY";
623
624 /// Comma-separated list of hostnames (e.g., `example.com`) and/or patterns (e.g., `192.168.1.0/24`) that should bypass the proxy.
625 #[attr_added_in("0.1.38")]
626 pub const NO_PROXY: &'static str = "NO_PROXY";
627
628 /// Timeout (in seconds) for only upload HTTP requests. (default: 900 s)
629 #[attr_added_in("0.9.1")]
630 pub const UV_UPLOAD_HTTP_TIMEOUT: &'static str = "UV_UPLOAD_HTTP_TIMEOUT";
631
632 /// Timeout (in seconds) for HTTP requests. (default: 30 s)
633 #[attr_added_in("0.1.7")]
634 pub const UV_HTTP_TIMEOUT: &'static str = "UV_HTTP_TIMEOUT";
635
636 /// The number of retries for HTTP requests. (default: 3)
637 #[attr_added_in("0.7.21")]
638 pub const UV_HTTP_RETRIES: &'static str = "UV_HTTP_RETRIES";
639
640 /// Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`.
641 #[attr_added_in("0.1.6")]
642 pub const UV_REQUEST_TIMEOUT: &'static str = "UV_REQUEST_TIMEOUT";
643
644 /// Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`.
645 #[attr_added_in("0.1.7")]
646 pub const HTTP_TIMEOUT: &'static str = "HTTP_TIMEOUT";
647
648 /// The validation modes to use when run with `--compile`.
649 ///
650 /// See [`PycInvalidationMode`](https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode).
651 #[attr_added_in("0.1.7")]
652 pub const PYC_INVALIDATION_MODE: &'static str = "PYC_INVALIDATION_MODE";
653
654 /// Used to detect an activated virtual environment.
655 #[attr_added_in("0.0.5")]
656 pub const VIRTUAL_ENV: &'static str = "VIRTUAL_ENV";
657
658 /// Used to detect the path of an active Conda environment.
659 #[attr_added_in("0.0.5")]
660 pub const CONDA_PREFIX: &'static str = "CONDA_PREFIX";
661
662 /// Used to determine the name of the active Conda environment.
663 #[attr_added_in("0.5.0")]
664 pub const CONDA_DEFAULT_ENV: &'static str = "CONDA_DEFAULT_ENV";
665
666 /// Used to determine the root install path of Conda.
667 #[attr_added_in("0.8.18")]
668 pub const CONDA_ROOT: &'static str = "_CONDA_ROOT";
669
670 /// Used to determine if we're running in Dependabot.
671 #[attr_added_in("0.9.11")]
672 pub const DEPENDABOT: &'static str = "DEPENDABOT";
673
674 /// If set to `1` before a virtual environment is activated, then the
675 /// virtual environment name will not be prepended to the terminal prompt.
676 #[attr_added_in("0.0.5")]
677 pub const VIRTUAL_ENV_DISABLE_PROMPT: &'static str = "VIRTUAL_ENV_DISABLE_PROMPT";
678
679 /// Used to detect the use of the Windows Command Prompt (as opposed to PowerShell).
680 #[attr_added_in("0.1.16")]
681 pub const PROMPT: &'static str = "PROMPT";
682
683 /// Used to detect `NuShell` usage.
684 #[attr_added_in("0.1.16")]
685 pub const NU_VERSION: &'static str = "NU_VERSION";
686
687 /// Used to detect Fish shell usage.
688 #[attr_added_in("0.1.28")]
689 pub const FISH_VERSION: &'static str = "FISH_VERSION";
690
691 /// Used to detect Bash shell usage.
692 #[attr_added_in("0.1.28")]
693 pub const BASH_VERSION: &'static str = "BASH_VERSION";
694
695 /// Used to detect Zsh shell usage.
696 #[attr_added_in("0.1.28")]
697 pub const ZSH_VERSION: &'static str = "ZSH_VERSION";
698
699 /// Used to determine which `.zshenv` to use when Zsh is being used.
700 #[attr_added_in("0.2.25")]
701 pub const ZDOTDIR: &'static str = "ZDOTDIR";
702
703 /// Used to detect Ksh shell usage.
704 #[attr_added_in("0.2.33")]
705 pub const KSH_VERSION: &'static str = "KSH_VERSION";
706
707 /// Used with `--python-platform macos` and related variants to set the
708 /// deployment target (i.e., the minimum supported macOS version).
709 ///
710 /// Defaults to `13.0`, the least-recent non-EOL macOS version at time of writing.
711 #[attr_added_in("0.1.42")]
712 pub const MACOSX_DEPLOYMENT_TARGET: &'static str = "MACOSX_DEPLOYMENT_TARGET";
713
714 /// Used with `--python-platform arm64-apple-ios` and related variants to set the
715 /// deployment target (i.e., the minimum supported iOS version).
716 ///
717 /// Defaults to `13.0`.
718 #[attr_added_in("0.8.16")]
719 pub const IPHONEOS_DEPLOYMENT_TARGET: &'static str = "IPHONEOS_DEPLOYMENT_TARGET";
720
721 /// Used with `--python-platform aarch64-linux-android` and related variants to set the
722 /// Android API level. (i.e., the minimum supported Android API level).
723 ///
724 /// Defaults to `24`.
725 #[attr_added_in("0.8.16")]
726 pub const ANDROID_API_LEVEL: &'static str = "ANDROID_API_LEVEL";
727
728 /// Disables colored output (takes precedence over `FORCE_COLOR`).
729 ///
730 /// See [no-color.org](https://no-color.org).
731 #[attr_added_in("0.2.7")]
732 pub const NO_COLOR: &'static str = "NO_COLOR";
733
734 /// Forces colored output regardless of terminal support.
735 ///
736 /// See [force-color.org](https://force-color.org).
737 #[attr_added_in("0.2.7")]
738 pub const FORCE_COLOR: &'static str = "FORCE_COLOR";
739
740 /// Use to control color via `anstyle`.
741 #[attr_added_in("0.1.32")]
742 pub const CLICOLOR_FORCE: &'static str = "CLICOLOR_FORCE";
743
744 /// The standard `PATH` env var.
745 #[attr_added_in("0.0.5")]
746 pub const PATH: &'static str = "PATH";
747
748 /// The standard `HOME` env var.
749 #[attr_added_in("0.0.5")]
750 pub const HOME: &'static str = "HOME";
751
752 /// The standard `SHELL` posix env var.
753 #[attr_added_in("0.1.16")]
754 pub const SHELL: &'static str = "SHELL";
755
756 /// The standard `PWD` posix env var.
757 #[attr_added_in("0.0.5")]
758 pub const PWD: &'static str = "PWD";
759
760 /// Used to look for Microsoft Store Pythons installations.
761 #[attr_added_in("0.3.3")]
762 pub const LOCALAPPDATA: &'static str = "LOCALAPPDATA";
763
764 /// Path to the `.git` directory. Ignored by `uv` when performing fetch.
765 #[attr_hidden]
766 #[attr_added_in("0.0.5")]
767 pub const GIT_DIR: &'static str = "GIT_DIR";
768
769 /// Path to the git working tree. Ignored by `uv` when performing fetch.
770 #[attr_hidden]
771 #[attr_added_in("0.0.5")]
772 pub const GIT_WORK_TREE: &'static str = "GIT_WORK_TREE";
773
774 /// Path to the index file for staged changes. Ignored by `uv` when performing fetch.
775 #[attr_hidden]
776 #[attr_added_in("0.0.5")]
777 pub const GIT_INDEX_FILE: &'static str = "GIT_INDEX_FILE";
778
779 /// Path to where git object files are located. Ignored by `uv` when performing fetch.
780 #[attr_hidden]
781 #[attr_added_in("0.0.5")]
782 pub const GIT_OBJECT_DIRECTORY: &'static str = "GIT_OBJECT_DIRECTORY";
783
784 /// Alternate locations for git objects. Ignored by `uv` when performing fetch.
785 #[attr_hidden]
786 #[attr_added_in("0.0.5")]
787 pub const GIT_ALTERNATE_OBJECT_DIRECTORIES: &'static str = "GIT_ALTERNATE_OBJECT_DIRECTORIES";
788
789 /// Disables SSL verification for git operations.
790 #[attr_hidden]
791 #[attr_added_in("0.5.28")]
792 pub const GIT_SSL_NO_VERIFY: &'static str = "GIT_SSL_NO_VERIFY";
793
794 /// Sets allowed protocols for git operations.
795 ///
796 /// When uv is in "offline" mode, only the "file" protocol is allowed.
797 #[attr_hidden]
798 #[attr_added_in("0.6.13")]
799 pub const GIT_ALLOW_PROTOCOL: &'static str = "GIT_ALLOW_PROTOCOL";
800
801 /// Sets the SSH command used when Git tries to establish a connection using SSH.
802 #[attr_hidden]
803 #[attr_added_in("0.7.11")]
804 pub const GIT_SSH_COMMAND: &'static str = "GIT_SSH_COMMAND";
805
806 /// Disable interactive git prompts in terminals, e.g., for credentials. Does not disable
807 /// GUI prompts.
808 #[attr_hidden]
809 #[attr_added_in("0.6.4")]
810 pub const GIT_TERMINAL_PROMPT: &'static str = "GIT_TERMINAL_PROMPT";
811
812 /// Used in tests for better git isolation.
813 ///
814 /// For example, we run some tests in ~/.local/share/uv/tests.
815 /// And if the user's `$HOME` directory is a git repository,
816 /// this will change the behavior of some tests. Setting
817 /// `GIT_CEILING_DIRECTORIES=/home/andrew/.local/share/uv/tests` will
818 /// prevent git from crawling up the directory tree past that point to find
819 /// parent git repositories.
820 #[attr_hidden]
821 #[attr_added_in("0.4.29")]
822 pub const GIT_CEILING_DIRECTORIES: &'static str = "GIT_CEILING_DIRECTORIES";
823
824 /// Indicates that the current process is running in GitHub Actions.
825 ///
826 /// `uv publish` may attempt trusted publishing flows when set
827 /// to `true`.
828 #[attr_added_in("0.4.16")]
829 pub const GITHUB_ACTIONS: &'static str = "GITHUB_ACTIONS";
830
831 /// Indicates that the current process is running in GitLab CI.
832 ///
833 /// `uv publish` may attempt trusted publishing flows when set
834 /// to `true`.
835 #[attr_added_in("0.8.18")]
836 pub const GITLAB_CI: &'static str = "GITLAB_CI";
837
838 /// Sets the encoding for standard I/O streams (e.g., PYTHONIOENCODING=utf-8).
839 #[attr_hidden]
840 #[attr_added_in("0.4.18")]
841 pub const PYTHONIOENCODING: &'static str = "PYTHONIOENCODING";
842
843 /// Forces unbuffered I/O streams, equivalent to `-u` in Python.
844 #[attr_hidden]
845 #[attr_added_in("0.1.15")]
846 pub const PYTHONUNBUFFERED: &'static str = "PYTHONUNBUFFERED";
847
848 /// Enables UTF-8 mode for Python, equivalent to `-X utf8`.
849 #[attr_hidden]
850 #[attr_added_in("0.4.19")]
851 pub const PYTHONUTF8: &'static str = "PYTHONUTF8";
852
853 /// Adds directories to Python module search path (e.g., `PYTHONPATH=/path/to/modules`).
854 #[attr_added_in("0.1.22")]
855 pub const PYTHONPATH: &'static str = "PYTHONPATH";
856
857 /// Used in tests to enforce a consistent locale setting.
858 #[attr_hidden]
859 #[attr_added_in("0.4.28")]
860 pub const LC_ALL: &'static str = "LC_ALL";
861
862 /// Typically set by CI runners, used to detect a CI runner.
863 #[attr_hidden]
864 #[attr_added_in("0.0.5")]
865 pub const CI: &'static str = "CI";
866
867 /// Azure DevOps build identifier, used to detect CI environments.
868 #[attr_hidden]
869 #[attr_added_in("0.1.22")]
870 pub const BUILD_BUILDID: &'static str = "BUILD_BUILDID";
871
872 /// Generic build identifier, used to detect CI environments.
873 #[attr_hidden]
874 #[attr_added_in("0.1.22")]
875 pub const BUILD_ID: &'static str = "BUILD_ID";
876
877 /// Pip environment variable to indicate CI environment.
878 #[attr_hidden]
879 #[attr_added_in("0.1.22")]
880 pub const PIP_IS_CI: &'static str = "PIP_IS_CI";
881
882 /// Use to set the .netrc file location.
883 #[attr_added_in("0.1.16")]
884 pub const NETRC: &'static str = "NETRC";
885
886 /// The standard `PAGER` posix env var. Used by `uv` to configure the appropriate pager.
887 #[attr_added_in("0.4.18")]
888 pub const PAGER: &'static str = "PAGER";
889
890 /// Used to detect when running inside a Jupyter notebook.
891 #[attr_added_in("0.2.6")]
892 pub const JPY_SESSION_NAME: &'static str = "JPY_SESSION_NAME";
893
894 /// Use to create the tracing root directory via the `tracing-durations-export` feature.
895 #[attr_hidden]
896 #[attr_added_in("0.1.32")]
897 pub const TRACING_DURATIONS_TEST_ROOT: &'static str = "TRACING_DURATIONS_TEST_ROOT";
898
899 /// Use to create the tracing durations file via the `tracing-durations-export` feature.
900 #[attr_added_in("0.0.5")]
901 pub const TRACING_DURATIONS_FILE: &'static str = "TRACING_DURATIONS_FILE";
902
903 /// Used to set `RUST_HOST_TARGET` at build time via `build.rs`.
904 #[attr_hidden]
905 #[attr_added_in("0.1.11")]
906 pub const TARGET: &'static str = "TARGET";
907
908 /// If set, uv will use this value as the log level for its `--verbose` output. Accepts
909 /// any filter compatible with the `tracing_subscriber` crate.
910 ///
911 /// For example:
912 ///
913 /// * `RUST_LOG=uv=debug` is the equivalent of adding `--verbose` to the command line
914 /// * `RUST_LOG=trace` will enable trace-level logging.
915 ///
916 /// See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax)
917 /// for more.
918 #[attr_added_in("0.0.5")]
919 pub const RUST_LOG: &'static str = "RUST_LOG";
920
921 /// If set, it can be used to display more stack trace details when a panic occurs.
922 /// This is used by uv particularly on windows to show more details during a platform exception.
923 ///
924 /// For example:
925 ///
926 /// * `RUST_BACKTRACE=1` will print a short backtrace.
927 /// * `RUST_BACKTRACE=full` will print a full backtrace.
928 ///
929 /// See the [Rust backtrace documentation](https://doc.rust-lang.org/std/backtrace/index.html)
930 /// for more.
931 #[attr_added_in("0.7.22")]
932 pub const RUST_BACKTRACE: &'static str = "RUST_BACKTRACE";
933
934 /// Add additional context and structure to log messages.
935 ///
936 /// If logging is not enabled, e.g., with `RUST_LOG` or `-v`, this has no effect.
937 #[attr_added_in("0.6.4")]
938 pub const UV_LOG_CONTEXT: &'static str = "UV_LOG_CONTEXT";
939
940 /// Use to set the stack size used by uv.
941 ///
942 /// The value is in bytes, and if both `UV_STACK_SIZE` are `RUST_MIN_STACK` unset, uv uses a 4MB
943 /// (4194304) stack. `UV_STACK_SIZE` takes precedence over `RUST_MIN_STACK`.
944 ///
945 /// Unlike the normal `RUST_MIN_STACK` semantics, this can affect main thread
946 /// stack size, because we actually spawn our own main2 thread to work around
947 /// the fact that Windows' real main thread is only 1MB. That thread has size
948 /// `max(UV_STACK_SIZE, 1MB)`.
949 #[attr_added_in("0.0.5")]
950 pub const UV_STACK_SIZE: &'static str = "UV_STACK_SIZE";
951
952 /// Use to set the stack size used by uv.
953 ///
954 /// The value is in bytes, and if both `UV_STACK_SIZE` are `RUST_MIN_STACK` unset, uv uses a 4MB
955 /// (4194304) stack. `UV_STACK_SIZE` takes precedence over `RUST_MIN_STACK`.
956 ///
957 /// Prefer setting `UV_STACK_SIZE`, since `RUST_MIN_STACK` also affects subprocesses, such as
958 /// build backends that use Rust code.
959 ///
960 /// Unlike the normal `RUST_MIN_STACK` semantics, this can affect main thread
961 /// stack size, because we actually spawn our own main2 thread to work around
962 /// the fact that Windows' real main thread is only 1MB. That thread has size
963 /// `max(RUST_MIN_STACK, 1MB)`.
964 #[attr_added_in("0.5.19")]
965 pub const RUST_MIN_STACK: &'static str = "RUST_MIN_STACK";
966
967 /// The directory containing the `Cargo.toml` manifest for a package.
968 #[attr_hidden]
969 #[attr_added_in("0.1.11")]
970 pub const CARGO_MANIFEST_DIR: &'static str = "CARGO_MANIFEST_DIR";
971
972 /// Specifies the directory where Cargo stores build artifacts (target directory).
973 #[attr_hidden]
974 #[attr_added_in("0.0.5")]
975 pub const CARGO_TARGET_DIR: &'static str = "CARGO_TARGET_DIR";
976
977 /// Used in tests for environment substitution testing in `requirements.in`.
978 #[attr_hidden]
979 #[attr_added_in("0.1.18")]
980 pub const URL: &'static str = "URL";
981
982 /// Used in tests for environment substitution testing in `requirements.in`.
983 #[attr_hidden]
984 #[attr_added_in("0.1.18")]
985 pub const FILE_PATH: &'static str = "FILE_PATH";
986
987 /// Used in tests for environment substitution testing in `requirements.in`.
988 #[attr_hidden]
989 #[attr_added_in("0.1.25")]
990 pub const HATCH_PATH: &'static str = "HATCH_PATH";
991
992 /// Used in tests for environment substitution testing in `requirements.in`.
993 #[attr_hidden]
994 #[attr_added_in("0.1.25")]
995 pub const BLACK_PATH: &'static str = "BLACK_PATH";
996
997 /// Used in testing Hatch's root.uri feature
998 ///
999 /// See: <https://hatch.pypa.io/dev/config/dependency/#local>.
1000 #[attr_hidden]
1001 #[attr_added_in("0.1.22")]
1002 pub const ROOT_PATH: &'static str = "ROOT_PATH";
1003
1004 /// Used in testing extra build dependencies.
1005 #[attr_hidden]
1006 #[attr_added_in("0.8.5")]
1007 pub const EXPECTED_ANYIO_VERSION: &'static str = "EXPECTED_ANYIO_VERSION";
1008
1009 /// Used to set test credentials for keyring tests.
1010 #[attr_hidden]
1011 #[attr_added_in("0.1.34")]
1012 pub const KEYRING_TEST_CREDENTIALS: &'static str = "KEYRING_TEST_CREDENTIALS";
1013
1014 /// Used to disable delay for HTTP retries in tests.
1015 #[attr_added_in("0.7.21")]
1016 pub const UV_TEST_NO_HTTP_RETRY_DELAY: &'static str = "UV_TEST_NO_HTTP_RETRY_DELAY";
1017
1018 /// Used to set a packse index url for tests.
1019 #[attr_hidden]
1020 #[attr_added_in("0.2.12")]
1021 pub const UV_TEST_PACKSE_INDEX: &'static str = "UV_TEST_PACKSE_INDEX";
1022
1023 /// Used for testing named indexes in tests.
1024 #[attr_hidden]
1025 #[attr_added_in("0.5.21")]
1026 pub const UV_INDEX_MY_INDEX_USERNAME: &'static str = "UV_INDEX_MY_INDEX_USERNAME";
1027
1028 /// Used for testing named indexes in tests.
1029 #[attr_hidden]
1030 #[attr_added_in("0.5.21")]
1031 pub const UV_INDEX_MY_INDEX_PASSWORD: &'static str = "UV_INDEX_MY_INDEX_PASSWORD";
1032
1033 /// Used to set the GitHub fast-path url for tests.
1034 #[attr_hidden]
1035 #[attr_added_in("0.7.15")]
1036 pub const UV_GITHUB_FAST_PATH_URL: &'static str = "UV_GITHUB_FAST_PATH_URL";
1037
1038 /// Hide progress messages with non-deterministic order in tests.
1039 #[attr_hidden]
1040 #[attr_added_in("0.5.29")]
1041 pub const UV_TEST_NO_CLI_PROGRESS: &'static str = "UV_TEST_NO_CLI_PROGRESS";
1042
1043 /// `.env` files from which to load environment variables when executing `uv run` commands.
1044 #[attr_added_in("0.4.30")]
1045 pub const UV_ENV_FILE: &'static str = "UV_ENV_FILE";
1046
1047 /// Ignore `.env` files when executing `uv run` commands.
1048 #[attr_added_in("0.4.30")]
1049 pub const UV_NO_ENV_FILE: &'static str = "UV_NO_ENV_FILE";
1050
1051 /// The URL from which to download uv using the standalone installer and `self update` feature,
1052 /// in lieu of the default GitHub URL.
1053 #[attr_added_in("0.5.0")]
1054 pub const UV_INSTALLER_GITHUB_BASE_URL: &'static str = "UV_INSTALLER_GITHUB_BASE_URL";
1055
1056 /// The URL from which to download uv using the standalone installer and `self update` feature,
1057 /// in lieu of the default GitHub Enterprise URL.
1058 #[attr_added_in("0.5.0")]
1059 pub const UV_INSTALLER_GHE_BASE_URL: &'static str = "UV_INSTALLER_GHE_BASE_URL";
1060
1061 /// The directory in which to install uv using the standalone installer and `self update` feature.
1062 /// Defaults to `~/.local/bin`.
1063 #[attr_added_in("0.5.0")]
1064 pub const UV_INSTALL_DIR: &'static str = "UV_INSTALL_DIR";
1065
1066 /// Used ephemeral environments like CI to install uv to a specific path while preventing
1067 /// the installer from modifying shell profiles or environment variables.
1068 #[attr_added_in("0.5.0")]
1069 pub const UV_UNMANAGED_INSTALL: &'static str = "UV_UNMANAGED_INSTALL";
1070
1071 /// The URL from which to download uv using the standalone installer. By default, installs from
1072 /// uv's GitHub Releases. `INSTALLER_DOWNLOAD_URL` is also supported as an alias, for backwards
1073 /// compatibility.
1074 #[attr_added_in("0.8.4")]
1075 pub const UV_DOWNLOAD_URL: &'static str = "UV_DOWNLOAD_URL";
1076
1077 /// Avoid modifying the `PATH` environment variable when installing uv using the standalone
1078 /// installer and `self update` feature. `INSTALLER_NO_MODIFY_PATH` is also supported as an
1079 /// alias, for backwards compatibility.
1080 #[attr_added_in("0.8.4")]
1081 pub const UV_NO_MODIFY_PATH: &'static str = "UV_NO_MODIFY_PATH";
1082
1083 /// Skip writing `uv` installer metadata files (e.g., `INSTALLER`, `REQUESTED`, and `direct_url.json`) to site-packages `.dist-info` directories.
1084 #[attr_added_in("0.5.7")]
1085 pub const UV_NO_INSTALLER_METADATA: &'static str = "UV_NO_INSTALLER_METADATA";
1086
1087 /// Enables fetching files stored in Git LFS when installing a package from a Git repository.
1088 #[attr_added_in("0.5.19")]
1089 pub const UV_GIT_LFS: &'static str = "UV_GIT_LFS";
1090
1091 /// Number of times that `uv run` has been recursively invoked. Used to guard against infinite
1092 /// recursion, e.g., when `uv run`` is used in a script shebang.
1093 #[attr_hidden]
1094 #[attr_added_in("0.5.31")]
1095 pub const UV_RUN_RECURSION_DEPTH: &'static str = "UV_RUN_RECURSION_DEPTH";
1096
1097 /// Number of times that `uv run` will allow recursive invocations, before exiting with an
1098 /// error.
1099 #[attr_hidden]
1100 #[attr_added_in("0.5.31")]
1101 pub const UV_RUN_MAX_RECURSION_DEPTH: &'static str = "UV_RUN_MAX_RECURSION_DEPTH";
1102
1103 /// Overrides terminal width used for wrapping. This variable is not read by uv directly.
1104 ///
1105 /// This is a quasi-standard variable, described, e.g., in `ncurses(3x)`.
1106 #[attr_added_in("0.6.2")]
1107 pub const COLUMNS: &'static str = "COLUMNS";
1108
1109 /// The CUDA driver version to assume when inferring the PyTorch backend (e.g., `550.144.03`).
1110 #[attr_hidden]
1111 #[attr_added_in("0.6.9")]
1112 pub const UV_CUDA_DRIVER_VERSION: &'static str = "UV_CUDA_DRIVER_VERSION";
1113
1114 /// The AMD GPU architecture to assume when inferring the PyTorch backend (e.g., `gfx1100`).
1115 #[attr_hidden]
1116 #[attr_added_in("0.7.14")]
1117 pub const UV_AMD_GPU_ARCHITECTURE: &'static str = "UV_AMD_GPU_ARCHITECTURE";
1118
1119 /// Equivalent to the `--torch-backend` command-line argument (e.g., `cpu`, `cu126`, or `auto`).
1120 #[attr_added_in("0.6.9")]
1121 pub const UV_TORCH_BACKEND: &'static str = "UV_TORCH_BACKEND";
1122
1123 /// Equivalent to the `--project` command-line argument.
1124 #[attr_added_in("0.4.4")]
1125 pub const UV_PROJECT: &'static str = "UV_PROJECT";
1126
1127 /// Equivalent to the `--directory` command-line argument.
1128 #[attr_added_in("0.9.1")]
1129 pub const UV_WORKING_DIRECTORY: &'static str = "UV_WORKING_DIRECTORY";
1130
1131 /// Disable GitHub-specific requests that allow uv to skip `git fetch` in some circumstances.
1132 #[attr_added_in("0.7.13")]
1133 pub const UV_NO_GITHUB_FAST_PATH: &'static str = "UV_NO_GITHUB_FAST_PATH";
1134
1135 /// Authentication token for Hugging Face requests. When set, uv will use this token
1136 /// when making requests to `https://huggingface.co/` and any subdomains.
1137 #[attr_added_in("0.8.1")]
1138 pub const HF_TOKEN: &'static str = "HF_TOKEN";
1139
1140 /// Disable Hugging Face authentication, even if `HF_TOKEN` is set.
1141 #[attr_added_in("0.8.1")]
1142 pub const UV_NO_HF_TOKEN: &'static str = "UV_NO_HF_TOKEN";
1143
1144 /// The URL to treat as an S3-compatible storage endpoint. Requests to this endpoint
1145 /// will be signed using AWS Signature Version 4 based on the `AWS_ACCESS_KEY_ID`,
1146 /// `AWS_SECRET_ACCESS_KEY`, `AWS_PROFILE`, and `AWS_CONFIG_FILE` environment variables.
1147 #[attr_added_in("0.8.21")]
1148 pub const UV_S3_ENDPOINT_URL: &'static str = "UV_S3_ENDPOINT_URL";
1149
1150 /// The URL of the pyx Simple API server.
1151 #[attr_added_in("0.8.15")]
1152 pub const PYX_API_URL: &'static str = "PYX_API_URL";
1153
1154 /// The domain of the pyx CDN.
1155 #[attr_added_in("0.8.15")]
1156 pub const PYX_CDN_DOMAIN: &'static str = "PYX_CDN_DOMAIN";
1157
1158 /// The pyx API key (e.g., `sk-pyx-...`).
1159 #[attr_added_in("0.8.15")]
1160 pub const PYX_API_KEY: &'static str = "PYX_API_KEY";
1161
1162 /// The pyx API key, for backwards compatibility.
1163 #[attr_hidden]
1164 #[attr_added_in("0.8.15")]
1165 pub const UV_API_KEY: &'static str = "UV_API_KEY";
1166
1167 /// The pyx authentication token (e.g., `eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...`), as output by `uv auth token`.
1168 #[attr_added_in("0.8.15")]
1169 pub const PYX_AUTH_TOKEN: &'static str = "PYX_AUTH_TOKEN";
1170
1171 /// The pyx authentication token, for backwards compatibility.
1172 #[attr_hidden]
1173 #[attr_added_in("0.8.15")]
1174 pub const UV_AUTH_TOKEN: &'static str = "UV_AUTH_TOKEN";
1175
1176 /// Specifies the directory where uv stores pyx credentials.
1177 #[attr_added_in("0.8.15")]
1178 pub const PYX_CREDENTIALS_DIR: &'static str = "PYX_CREDENTIALS_DIR";
1179
1180 /// The AWS region to use when signing S3 requests.
1181 #[attr_added_in("0.8.21")]
1182 pub const AWS_REGION: &'static str = "AWS_REGION";
1183
1184 /// The default AWS region to use when signing S3 requests, if `AWS_REGION` is not set.
1185 #[attr_added_in("0.8.21")]
1186 pub const AWS_DEFAULT_REGION: &'static str = "AWS_DEFAULT_REGION";
1187
1188 /// The AWS access key ID to use when signing S3 requests.
1189 #[attr_added_in("0.8.21")]
1190 pub const AWS_ACCESS_KEY_ID: &'static str = "AWS_ACCESS_KEY_ID";
1191
1192 /// The AWS secret access key to use when signing S3 requests.
1193 #[attr_added_in("0.8.21")]
1194 pub const AWS_SECRET_ACCESS_KEY: &'static str = "AWS_SECRET_ACCESS_KEY";
1195
1196 /// The AWS session token to use when signing S3 requests.
1197 #[attr_added_in("0.8.21")]
1198 pub const AWS_SESSION_TOKEN: &'static str = "AWS_SESSION_TOKEN";
1199
1200 /// The AWS profile to use when signing S3 requests.
1201 #[attr_added_in("0.8.21")]
1202 pub const AWS_PROFILE: &'static str = "AWS_PROFILE";
1203
1204 /// The AWS config file to use when signing S3 requests.
1205 #[attr_added_in("0.8.21")]
1206 pub const AWS_CONFIG_FILE: &'static str = "AWS_CONFIG_FILE";
1207
1208 /// The AWS shared credentials file to use when signing S3 requests.
1209 #[attr_added_in("0.8.21")]
1210 pub const AWS_SHARED_CREDENTIALS_FILE: &'static str = "AWS_SHARED_CREDENTIALS_FILE";
1211
1212 /// Avoid verifying that wheel filenames match their contents when installing wheels. This
1213 /// is not recommended, as wheels with inconsistent filenames should be considered invalid and
1214 /// corrected by the relevant package maintainers; however, this option can be used to work
1215 /// around invalid artifacts in rare cases.
1216 #[attr_added_in("0.8.23")]
1217 pub const UV_SKIP_WHEEL_FILENAME_CHECK: &'static str = "UV_SKIP_WHEEL_FILENAME_CHECK";
1218}