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 /// load TLS certificates from the platform's native certificate store instead of the
112 /// bundled Mozilla root certificates.
113 /// (Deprecated: use `UV_SYSTEM_CERTS` instead.)
114 #[attr_added_in("0.1.19")]
115 pub const UV_NATIVE_TLS: &'static str = "UV_NATIVE_TLS";
116
117 /// Equivalent to the `--system-certs` command-line argument. If set to `true`, uv will
118 /// load TLS certificates from the platform's native certificate store instead of the
119 /// bundled Mozilla root certificates.
120 #[attr_added_in("0.11.0")]
121 pub const UV_SYSTEM_CERTS: &'static str = "UV_SYSTEM_CERTS";
122
123 /// Equivalent to the `--index-strategy` command-line argument.
124 ///
125 /// For example, if set to `unsafe-best-match`, uv will consider versions of a given package
126 /// available across all index URLs, rather than limiting its search to the first index URL
127 /// that contains the package.
128 #[attr_added_in("0.1.29")]
129 pub const UV_INDEX_STRATEGY: &'static str = "UV_INDEX_STRATEGY";
130
131 /// Equivalent to the `--require-hashes` command-line argument. If set to `true`,
132 /// uv will require that all dependencies have a hash specified in the requirements file.
133 #[attr_added_in("0.1.34")]
134 pub const UV_REQUIRE_HASHES: &'static str = "UV_REQUIRE_HASHES";
135
136 /// Equivalent to the `--constraints` command-line argument. If set, uv will use this
137 /// file as the constraints file. Uses space-separated list of files.
138 #[attr_added_in("0.1.36")]
139 pub const UV_CONSTRAINT: &'static str = "UV_CONSTRAINT";
140
141 /// Equivalent to the `--build-constraints` command-line argument. If set, uv will use this file
142 /// as constraints for any source distribution builds. Uses space-separated list of files.
143 #[attr_added_in("0.2.34")]
144 pub const UV_BUILD_CONSTRAINT: &'static str = "UV_BUILD_CONSTRAINT";
145
146 /// Equivalent to the `--overrides` command-line argument. If set, uv will use this file
147 /// as the overrides file. Uses space-separated list of files.
148 #[attr_added_in("0.2.22")]
149 pub const UV_OVERRIDE: &'static str = "UV_OVERRIDE";
150
151 /// Equivalent to the `--excludes` command-line argument. If set, uv will use this
152 /// as the excludes file. Uses space-separated list of files.
153 #[attr_added_in("0.9.8")]
154 pub const UV_EXCLUDE: &'static str = "UV_EXCLUDE";
155
156 /// Equivalent to the `--link-mode` command-line argument. If set, uv will use this as
157 /// a link mode.
158 #[attr_added_in("0.1.40")]
159 pub const UV_LINK_MODE: &'static str = "UV_LINK_MODE";
160
161 /// Equivalent to the `--no-build-isolation` command-line argument. If set, uv will
162 /// skip isolation when building source distributions.
163 #[attr_added_in("0.1.40")]
164 pub const UV_NO_BUILD_ISOLATION: &'static str = "UV_NO_BUILD_ISOLATION";
165
166 /// Equivalent to the `--custom-compile-command` command-line argument.
167 ///
168 /// Used to override uv in the output header of the `requirements.txt` files generated by
169 /// `uv pip compile`. Intended for use-cases in which `uv pip compile` is called from within a wrapper
170 /// script, to include the name of the wrapper script in the output file.
171 #[attr_added_in("0.1.23")]
172 pub const UV_CUSTOM_COMPILE_COMMAND: &'static str = "UV_CUSTOM_COMPILE_COMMAND";
173
174 /// Equivalent to the `--keyring-provider` command-line argument. If set, uv
175 /// will use this value as the keyring provider.
176 #[attr_added_in("0.1.19")]
177 pub const UV_KEYRING_PROVIDER: &'static str = "UV_KEYRING_PROVIDER";
178
179 /// Equivalent to the `--config-file` command-line argument. Expects a path to a
180 /// local `uv.toml` file to use as the configuration file.
181 #[attr_added_in("0.1.34")]
182 pub const UV_CONFIG_FILE: &'static str = "UV_CONFIG_FILE";
183
184 /// Equivalent to the `--no-config` command-line argument. If set, uv will not read
185 /// any configuration files from the current directory, parent directories, or user configuration
186 /// directories.
187 #[attr_added_in("0.2.30")]
188 pub const UV_NO_CONFIG: &'static str = "UV_NO_CONFIG";
189
190 /// If set, uv will not read system-level configuration files.
191 #[attr_added_in("0.11.16")]
192 pub const UV_NO_SYSTEM_CONFIG: &'static str = "UV_NO_SYSTEM_CONFIG";
193
194 /// Equivalent to the `--isolated` command-line argument. If set, uv will avoid discovering
195 /// a `pyproject.toml` or `uv.toml` file.
196 #[attr_added_in("0.8.14")]
197 pub const UV_ISOLATED: &'static str = "UV_ISOLATED";
198
199 /// Equivalent to the `--exclude-newer` command-line argument. If set, uv will
200 /// exclude distributions published after the specified date.
201 #[attr_added_in("0.2.12")]
202 pub const UV_EXCLUDE_NEWER: &'static str = "UV_EXCLUDE_NEWER";
203
204 /// Whether uv should prefer system or managed Python versions.
205 #[attr_added_in("0.3.2")]
206 pub const UV_PYTHON_PREFERENCE: &'static str = "UV_PYTHON_PREFERENCE";
207
208 /// Require use of uv-managed Python versions.
209 #[attr_added_in("0.6.8")]
210 pub const UV_MANAGED_PYTHON: &'static str = "UV_MANAGED_PYTHON";
211
212 /// Disable use of uv-managed Python versions.
213 #[attr_added_in("0.6.8")]
214 pub const UV_NO_MANAGED_PYTHON: &'static str = "UV_NO_MANAGED_PYTHON";
215
216 /// Equivalent to the
217 /// [`python-downloads`](../reference/settings.md#python-downloads) setting and, when disabled, the
218 /// `--no-python-downloads` option. Whether uv should allow Python downloads.
219 #[attr_added_in("0.3.2")]
220 pub const UV_PYTHON_DOWNLOADS: &'static str = "UV_PYTHON_DOWNLOADS";
221
222 /// Overrides the environment-determined libc on linux systems when filling in the current platform
223 /// within Python version requests. Options are: `gnu`, `gnueabi`, `gnueabihf`, `musl`,
224 /// `musleabi`, `musleabihf`, and `none`.
225 #[attr_added_in("0.7.22")]
226 pub const UV_LIBC: &'static str = "UV_LIBC";
227
228 /// Equivalent to the `--compile-bytecode` command-line argument. If set, uv
229 /// will compile Python source files to bytecode after installation.
230 #[attr_added_in("0.3.3")]
231 pub const UV_COMPILE_BYTECODE: &'static str = "UV_COMPILE_BYTECODE";
232
233 /// Timeout (in seconds) for bytecode compilation.
234 #[attr_added_in("0.7.22")]
235 pub const UV_COMPILE_BYTECODE_TIMEOUT: &'static str = "UV_COMPILE_BYTECODE_TIMEOUT";
236
237 /// Equivalent to the `--no-editable` command-line argument. If set, uv
238 /// installs or exports any editable dependencies, including the project and any workspace
239 /// members, as non-editable.
240 #[attr_added_in("0.6.15")]
241 pub const UV_NO_EDITABLE: &'static str = "UV_NO_EDITABLE";
242
243 /// Equivalent to the `--dev` command-line argument. If set, uv will include
244 /// development dependencies.
245 #[attr_added_in("0.8.7")]
246 pub const UV_DEV: &'static str = "UV_DEV";
247
248 /// Equivalent to the `--no-dev` command-line argument. If set, uv will exclude
249 /// development dependencies.
250 #[attr_added_in("0.8.7")]
251 pub const UV_NO_DEV: &'static str = "UV_NO_DEV";
252
253 /// Equivalent to the `--no-group` command-line argument. If set, uv will disable
254 /// the specified dependency groups for the given space-delimited list of packages.
255 #[attr_added_in("0.9.8")]
256 pub const UV_NO_GROUP: &'static str = "UV_NO_GROUP";
257
258 /// Equivalent to the `--no-default-groups` command-line argument. If set, uv will
259 /// not select the default dependency groups defined in `tool.uv.default-groups`.
260 #[attr_added_in("0.9.9")]
261 pub const UV_NO_DEFAULT_GROUPS: &'static str = "UV_NO_DEFAULT_GROUPS";
262
263 /// Equivalent to the `--no-binary` command-line argument. If set, uv will install
264 /// all packages from source. The resolver will still use pre-built wheels to
265 /// extract package metadata, if available.
266 #[attr_added_in("0.5.30")]
267 pub const UV_NO_BINARY: &'static str = "UV_NO_BINARY";
268
269 /// Equivalent to the `--no-binary-package` command line argument. If set, uv will
270 /// not use pre-built wheels for the given space-delimited list of packages.
271 #[attr_added_in("0.5.30")]
272 pub const UV_NO_BINARY_PACKAGE: &'static str = "UV_NO_BINARY_PACKAGE";
273
274 /// Equivalent to the `--no-build` command-line argument. If set, uv will not build
275 /// source distributions.
276 #[attr_added_in("0.1.40")]
277 pub const UV_NO_BUILD: &'static str = "UV_NO_BUILD";
278
279 /// Equivalent to the `--no-build-package` command line argument. If set, uv will
280 /// not build source distributions for the given space-delimited list of packages.
281 #[attr_added_in("0.6.5")]
282 pub const UV_NO_BUILD_PACKAGE: &'static str = "UV_NO_BUILD_PACKAGE";
283
284 /// Equivalent to the `--no-sources-package` command line argument. If set, uv will
285 /// ignore the `tool.uv.sources` table for the given space-delimited list of packages.
286 #[attr_added_in("0.9.26")]
287 pub const UV_NO_SOURCES_PACKAGE: &'static str = "UV_NO_SOURCES_PACKAGE";
288
289 /// Equivalent to the `--publish-url` command-line argument. The URL of the upload
290 /// endpoint of the index to use with `uv publish`.
291 #[attr_added_in("0.4.16")]
292 pub const UV_PUBLISH_URL: &'static str = "UV_PUBLISH_URL";
293
294 /// Equivalent to the `--token` command-line argument in `uv publish`. If set, uv
295 /// will use this token (with the username `__token__`) for publishing.
296 #[attr_added_in("0.4.16")]
297 pub const UV_PUBLISH_TOKEN: &'static str = "UV_PUBLISH_TOKEN";
298
299 /// Equivalent to the `--index` command-line argument in `uv publish`. If
300 /// set, uv will use the index with this name in the configuration for publishing.
301 #[attr_added_in("0.5.8")]
302 pub const UV_PUBLISH_INDEX: &'static str = "UV_PUBLISH_INDEX";
303
304 /// Equivalent to the `--username` command-line argument in `uv publish`. If
305 /// set, uv will use this username for publishing.
306 #[attr_added_in("0.4.16")]
307 pub const UV_PUBLISH_USERNAME: &'static str = "UV_PUBLISH_USERNAME";
308
309 /// Equivalent to the `--password` command-line argument in `uv publish`. If
310 /// set, uv will use this password for publishing.
311 #[attr_added_in("0.4.16")]
312 pub const UV_PUBLISH_PASSWORD: &'static str = "UV_PUBLISH_PASSWORD";
313
314 /// Don't upload a file if it already exists on the index. The value is the URL of the index.
315 #[attr_added_in("0.4.30")]
316 pub const UV_PUBLISH_CHECK_URL: &'static str = "UV_PUBLISH_CHECK_URL";
317
318 /// Equivalent to the `--no-attestations` command-line argument in `uv publish`. If set,
319 /// uv will skip uploading any collected attestations for the published distributions.
320 #[attr_added_in("0.9.12")]
321 pub const UV_PUBLISH_NO_ATTESTATIONS: &'static str = "UV_PUBLISH_NO_ATTESTATIONS";
322
323 /// Equivalent to the `--no-sync` command-line argument. If set, uv will skip updating
324 /// the environment.
325 #[attr_added_in("0.4.18")]
326 pub const UV_NO_SYNC: &'static str = "UV_NO_SYNC";
327
328 /// Equivalent to the `--locked` command-line argument. If set, uv will assert that the
329 /// `uv.lock` remains unchanged.
330 #[attr_added_in("0.4.25")]
331 pub const UV_LOCKED: &'static str = "UV_LOCKED";
332
333 /// Equivalent to the `--frozen` command-line argument. If set, uv will run without
334 /// updating the `uv.lock` file.
335 #[attr_added_in("0.4.25")]
336 pub const UV_FROZEN: &'static str = "UV_FROZEN";
337
338 /// Equivalent to the `--preview` argument. Enables preview mode.
339 #[attr_added_in("0.1.37")]
340 pub const UV_PREVIEW: &'static str = "UV_PREVIEW";
341
342 /// Equivalent to the `--preview-features` argument. Enables specific preview features.
343 #[attr_added_in("0.8.4")]
344 pub const UV_PREVIEW_FEATURES: &'static str = "UV_PREVIEW_FEATURES";
345
346 /// Equivalent to the `--token` argument for self update. A GitHub token for authentication.
347 #[attr_added_in("0.4.10")]
348 pub const UV_GITHUB_TOKEN: &'static str = "UV_GITHUB_TOKEN";
349
350 /// Equivalent to the `--no-verify-hashes` argument. Disables hash verification for
351 /// `requirements.txt` files.
352 #[attr_added_in("0.5.3")]
353 pub const UV_NO_VERIFY_HASHES: &'static str = "UV_NO_VERIFY_HASHES";
354
355 /// Equivalent to the `--allow-insecure-host` argument.
356 #[attr_added_in("0.3.5")]
357 pub const UV_INSECURE_HOST: &'static str = "UV_INSECURE_HOST";
358
359 /// Disable ZIP validation for streamed wheels and ZIP-based source distributions.
360 ///
361 /// WARNING: Disabling ZIP validation can expose your system to security risks by bypassing
362 /// integrity checks and allowing uv to install potentially malicious ZIP files. If uv rejects
363 /// a ZIP file due to failing validation, it is likely that the file is malformed; consider
364 /// filing an issue with the package maintainer.
365 #[attr_added_in("0.8.6")]
366 pub const UV_INSECURE_NO_ZIP_VALIDATION: &'static str = "UV_INSECURE_NO_ZIP_VALIDATION";
367
368 /// Sets the maximum number of in-flight concurrent downloads that uv will
369 /// perform at any given time.
370 #[attr_added_in("0.1.43")]
371 pub const UV_CONCURRENT_DOWNLOADS: &'static str = "UV_CONCURRENT_DOWNLOADS";
372
373 /// Sets the maximum number of source distributions that uv will build
374 /// concurrently at any given time.
375 #[attr_added_in("0.1.43")]
376 pub const UV_CONCURRENT_BUILDS: &'static str = "UV_CONCURRENT_BUILDS";
377
378 /// Controls the number of threads used when installing and unzipping
379 /// packages.
380 #[attr_added_in("0.1.45")]
381 pub const UV_CONCURRENT_INSTALLS: &'static str = "UV_CONCURRENT_INSTALLS";
382
383 /// Equivalent to the `--no-progress` command-line argument. Disables all progress output. For
384 /// example, spinners and progress bars.
385 #[attr_added_in("0.2.28")]
386 pub const UV_NO_PROGRESS: &'static str = "UV_NO_PROGRESS";
387
388 /// Specifies the directory where uv stores managed tools.
389 #[attr_added_in("0.2.16")]
390 pub const UV_TOOL_DIR: &'static str = "UV_TOOL_DIR";
391
392 /// Specifies the "bin" directory for installing tool executables.
393 #[attr_added_in("0.3.0")]
394 pub const UV_TOOL_BIN_DIR: &'static str = "UV_TOOL_BIN_DIR";
395
396 /// Equivalent to the `--bare` argument for `uv init`. If set, uv will only create a
397 /// `pyproject.toml`.
398 #[attr_added_in("0.10.7")]
399 pub const UV_INIT_BARE: &'static str = "UV_INIT_BARE";
400
401 /// Equivalent to the `--build-backend` argument for `uv init`. Determines the default backend
402 /// to use when creating a new project.
403 #[attr_added_in("0.8.2")]
404 pub const UV_INIT_BUILD_BACKEND: &'static str = "UV_INIT_BUILD_BACKEND";
405
406 /// Specifies the path to the directory to use for a project virtual environment.
407 ///
408 /// See the [project documentation](../concepts/projects/config.md#project-environment-path)
409 /// for more details.
410 #[attr_added_in("0.4.4")]
411 pub const UV_PROJECT_ENVIRONMENT: &'static str = "UV_PROJECT_ENVIRONMENT";
412
413 /// Specifies the directory to place links to installed, managed Python executables.
414 #[attr_added_in("0.4.29")]
415 pub const UV_PYTHON_BIN_DIR: &'static str = "UV_PYTHON_BIN_DIR";
416
417 /// Specifies the directory for storing managed Python installations.
418 #[attr_added_in("0.2.22")]
419 pub const UV_PYTHON_INSTALL_DIR: &'static str = "UV_PYTHON_INSTALL_DIR";
420
421 /// Whether to install the Python executable into the `UV_PYTHON_BIN_DIR` directory.
422 #[attr_added_in("0.8.0")]
423 pub const UV_PYTHON_INSTALL_BIN: &'static str = "UV_PYTHON_INSTALL_BIN";
424
425 /// Whether to install the Python executable into the Windows registry.
426 #[attr_added_in("0.8.0")]
427 pub const UV_PYTHON_INSTALL_REGISTRY: &'static str = "UV_PYTHON_INSTALL_REGISTRY";
428
429 /// Disable use of the Windows registry for Python discovery and registration.
430 ///
431 /// When set, uv will not discover Python interpreters from the Windows registry or Microsoft
432 /// Store locations, and managed Python installations will not be registered in the Windows
433 /// registry.
434 #[attr_added_in("0.11.8")]
435 pub const UV_PYTHON_NO_REGISTRY: &'static str = "UV_PYTHON_NO_REGISTRY";
436
437 /// Managed Python installations information is hardcoded in the `uv` binary.
438 ///
439 /// This variable can be set to a local path or URL pointing to
440 /// a JSON list of Python installations to override the hardcoded list.
441 ///
442 /// This allows customizing the URLs for downloads or using slightly older or newer versions
443 /// of Python than the ones hardcoded into this build of `uv`.
444 #[attr_added_in("0.6.13")]
445 pub const UV_PYTHON_DOWNLOADS_JSON_URL: &'static str = "UV_PYTHON_DOWNLOADS_JSON_URL";
446
447 /// Specifies the directory for caching the archives of managed Python installations before
448 /// installation.
449 #[attr_added_in("0.7.0")]
450 pub const UV_PYTHON_CACHE_DIR: &'static str = "UV_PYTHON_CACHE_DIR";
451
452 /// Managed Python installations are downloaded from the Astral
453 /// [`python-build-standalone`](https://github.com/astral-sh/python-build-standalone) project.
454 ///
455 /// This variable can be set to a mirror URL to use a different source for Python installations.
456 /// The provided URL will replace `https://github.com/astral-sh/python-build-standalone/releases/download` in, e.g.,
457 /// `https://github.com/astral-sh/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gz`.
458 /// Distributions can be read from a local directory by using the `file://` URL scheme.
459 ///
460 /// This more-specific mirror takes precedence over
461 /// [`UV_ASTRAL_MIRROR_URL`](Self::UV_ASTRAL_MIRROR_URL) for CPython downloads.
462 #[attr_added_in("0.2.35")]
463 pub const UV_PYTHON_INSTALL_MIRROR: &'static str = "UV_PYTHON_INSTALL_MIRROR";
464
465 /// Managed PyPy installations are downloaded from [python.org](https://downloads.python.org/).
466 ///
467 /// This variable can be set to a mirror URL to use a
468 /// different source for PyPy installations. The provided URL will replace
469 /// `https://downloads.python.org/pypy` in, e.g.,
470 /// `https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2`.
471 /// Distributions can be read from a local directory by using the `file://` URL scheme.
472 #[attr_added_in("0.2.35")]
473 pub const UV_PYPY_INSTALL_MIRROR: &'static str = "UV_PYPY_INSTALL_MIRROR";
474
475 /// Replaces the `https://releases.astral.sh` base URL for all Astral-mirrored
476 /// metadata and artifact downloads.
477 ///
478 /// When set, uv uses only the configured mirror URL and does not fall back to
479 /// GitHub or raw GitHub. Path components in the URL are preserved: only
480 /// trailing slashes are trimmed before appending the normal path suffix
481 /// (e.g., `/github/versions/main/v1/uv.ndjson`).
482 ///
483 /// This is useful for proxy repositories (e.g., Artifactory, Nexus) that
484 /// mirror `releases.astral.sh`.
485 ///
486 /// More-specific sources take precedence:
487 /// [`UV_PYTHON_INSTALL_MIRROR`](Self::UV_PYTHON_INSTALL_MIRROR) and
488 /// `python-install-mirror` override this variable for CPython downloads, while
489 /// [`UV_INSTALLER_GITHUB_BASE_URL`](Self::UV_INSTALLER_GITHUB_BASE_URL) and
490 /// [`UV_INSTALLER_GHE_BASE_URL`](Self::UV_INSTALLER_GHE_BASE_URL) override this
491 /// variable for `uv self update`.
492 #[attr_added_in("0.11.14")]
493 pub const UV_ASTRAL_MIRROR_URL: &'static str = "UV_ASTRAL_MIRROR_URL";
494
495 /// Pin managed CPython versions to a specific build version.
496 ///
497 /// For CPython, this should be the build date (e.g., "20250814").
498 #[attr_added_in("0.8.14")]
499 pub const UV_PYTHON_CPYTHON_BUILD: &'static str = "UV_PYTHON_CPYTHON_BUILD";
500
501 /// Pin managed PyPy versions to a specific build version.
502 ///
503 /// For PyPy, this should be the PyPy version (e.g., "7.3.20").
504 #[attr_added_in("0.8.14")]
505 pub const UV_PYTHON_PYPY_BUILD: &'static str = "UV_PYTHON_PYPY_BUILD";
506
507 /// Pin managed GraalPy versions to a specific build version.
508 ///
509 /// For GraalPy, this should be the GraalPy version (e.g., "24.2.2").
510 #[attr_added_in("0.8.14")]
511 pub const UV_PYTHON_GRAALPY_BUILD: &'static str = "UV_PYTHON_GRAALPY_BUILD";
512
513 /// Pin managed Pyodide versions to a specific build version.
514 ///
515 /// For Pyodide, this should be the Pyodide version (e.g., "0.28.1").
516 #[attr_added_in("0.8.14")]
517 pub const UV_PYTHON_PYODIDE_BUILD: &'static str = "UV_PYTHON_PYODIDE_BUILD";
518
519 /// Equivalent to the `--clear` command-line argument. If set, uv will remove any
520 /// existing files or directories at the target path.
521 #[attr_added_in("0.8.0")]
522 pub const UV_VENV_CLEAR: &'static str = "UV_VENV_CLEAR";
523
524 /// Equivalent to the `--relocatable` command-line argument. If set, the virtual
525 /// environment will be relocatable.
526 #[attr_added_in("0.10.8")]
527 pub const UV_VENV_RELOCATABLE: &'static str = "UV_VENV_RELOCATABLE";
528
529 /// Install seed packages (one or more of: `pip`, `setuptools`, and `wheel`) into the virtual environment
530 /// created by `uv venv`.
531 ///
532 /// Note that `setuptools` and `wheel` are not included in Python 3.12+ environments.
533 #[attr_added_in("0.5.21")]
534 pub const UV_VENV_SEED: &'static str = "UV_VENV_SEED";
535
536 /// Used to override `PATH` for Python executable discovery.
537 ///
538 /// When set, uv will search for Python interpreters in the directories specified by this
539 /// variable instead of `PATH`.
540 #[attr_added_in("0.11.8")]
541 pub const UV_PYTHON_SEARCH_PATH: &'static str = "UV_PYTHON_SEARCH_PATH";
542
543 /// Include resolver and installer output related to environment modifications.
544 #[attr_hidden]
545 #[attr_added_in("0.2.32")]
546 pub const UV_SHOW_RESOLUTION: &'static str = "UV_SHOW_RESOLUTION";
547
548 /// Use to update the json schema files.
549 #[attr_hidden]
550 #[attr_added_in("0.1.34")]
551 pub const UV_UPDATE_SCHEMA: &'static str = "UV_UPDATE_SCHEMA";
552
553 /// Use to disable line wrapping for diagnostics.
554 #[attr_added_in("0.0.5")]
555 pub const UV_NO_WRAP: &'static str = "UV_NO_WRAP";
556
557 /// Set to `1` to enable the automatic malware check that runs after `uv sync`.
558 ///
559 /// When enabled, uv performs a lightweight check against the OSV database for known
560 /// malware advisories after every lockfile sync. Set this variable to `0` to opt out.
561 #[attr_added_in("0.11.16")]
562 pub const UV_MALWARE_CHECK: &'static str = "UV_MALWARE_CHECK";
563
564 /// Override the vulnerability service URL for the automatic malware check.
565 ///
566 /// Defaults to the OSV API endpoint (`https://api.osv.dev/`).
567 #[attr_added_in("0.11.16")]
568 pub const UV_MALWARE_CHECK_URL: &'static str = "UV_MALWARE_CHECK_URL";
569
570 /// Provides the HTTP Basic authentication username for a named index.
571 ///
572 /// The `name` parameter is the name of the index. For example, given an index named `foo`,
573 /// the environment variable key would be `UV_INDEX_FOO_USERNAME`.
574 #[attr_added_in("0.4.23")]
575 #[attr_env_var_pattern("UV_INDEX_{name}_USERNAME")]
576 pub fn index_username(name: &str) -> String {
577 format!("UV_INDEX_{name}_USERNAME")
578 }
579
580 /// Provides the HTTP Basic authentication password for a named index.
581 ///
582 /// The `name` parameter is the name of the index. For example, given an index named `foo`,
583 /// the environment variable key would be `UV_INDEX_FOO_PASSWORD`.
584 #[attr_added_in("0.4.23")]
585 #[attr_env_var_pattern("UV_INDEX_{name}_PASSWORD")]
586 pub fn index_password(name: &str) -> String {
587 format!("UV_INDEX_{name}_PASSWORD")
588 }
589
590 /// Used to set the uv commit hash at build time via `build.rs`.
591 #[attr_hidden]
592 #[attr_added_in("0.1.11")]
593 pub const UV_COMMIT_HASH: &'static str = "UV_COMMIT_HASH";
594
595 /// Used to set the uv commit short hash at build time via `build.rs`.
596 #[attr_hidden]
597 #[attr_added_in("0.1.11")]
598 pub const UV_COMMIT_SHORT_HASH: &'static str = "UV_COMMIT_SHORT_HASH";
599
600 /// Used to set the uv commit date at build time via `build.rs`.
601 #[attr_hidden]
602 #[attr_added_in("0.1.11")]
603 pub const UV_COMMIT_DATE: &'static str = "UV_COMMIT_DATE";
604
605 /// Used to set the uv tag at build time via `build.rs`.
606 #[attr_hidden]
607 #[attr_added_in("0.1.11")]
608 pub const UV_LAST_TAG: &'static str = "UV_LAST_TAG";
609
610 /// Used to set the uv tag distance from head at build time via `build.rs`.
611 #[attr_hidden]
612 #[attr_added_in("0.1.11")]
613 pub const UV_LAST_TAG_DISTANCE: &'static str = "UV_LAST_TAG_DISTANCE";
614
615 /// Used to set the spawning/parent interpreter when using --system in the test suite.
616 #[attr_hidden]
617 #[attr_added_in("0.2.0")]
618 pub const UV_INTERNAL__PARENT_INTERPRETER: &'static str = "UV_INTERNAL__PARENT_INTERPRETER";
619
620 /// Used to force showing the derivation tree during resolver error reporting.
621 #[attr_hidden]
622 #[attr_added_in("0.3.0")]
623 pub const UV_INTERNAL__SHOW_DERIVATION_TREE: &'static str = "UV_INTERNAL__SHOW_DERIVATION_TREE";
624
625 /// Used to set a temporary directory for some tests.
626 #[attr_hidden]
627 #[attr_added_in("0.3.4")]
628 pub const UV_INTERNAL__TEST_DIR: &'static str = "UV_INTERNAL__TEST_DIR";
629
630 /// Path to a directory on a filesystem that supports copy-on-write, e.g., btrfs or APFS.
631 ///
632 /// When populated, uv will run additional tests that require this functionality.
633 #[attr_hidden]
634 #[attr_added_in("0.10.5")]
635 pub const UV_INTERNAL__TEST_COW_FS: &'static str = "UV_INTERNAL__TEST_COW_FS";
636
637 /// Path to a directory on a filesystem that does **not** support copy-on-write.
638 ///
639 /// When populated, uv will run additional tests that verify fallback behavior
640 /// when copy-on-write is unavailable.
641 #[attr_hidden]
642 #[attr_added_in("0.10.5")]
643 pub const UV_INTERNAL__TEST_NOCOW_FS: &'static str = "UV_INTERNAL__TEST_NOCOW_FS";
644
645 /// Path to a directory on an alternative filesystem for testing.
646 ///
647 /// This filesystem must be a different device than the default for the test suite.
648 ///
649 /// When populated, uv will run additional tests that cover cross-filesystem linking.
650 #[attr_hidden]
651 #[attr_added_in("0.10.5")]
652 pub const UV_INTERNAL__TEST_ALT_FS: &'static str = "UV_INTERNAL__TEST_ALT_FS";
653
654 /// Network path to a directory on an SMB filesystem for testing.
655 ///
656 /// When populated, uv will run additional tests that cover SMB-specific filesystem behavior.
657 #[attr_hidden]
658 #[attr_added_in("0.11.16")]
659 pub const UV_INTERNAL__TEST_SMB_FS: &'static str = "UV_INTERNAL__TEST_SMB_FS";
660
661 /// Path to a directory on a filesystem with a low hardlink limit (e.g., minix with ~250).
662 ///
663 /// When populated, uv will run additional tests that exercise EMLINK recovery.
664 #[attr_hidden]
665 #[attr_added_in("0.10.9")]
666 pub const UV_INTERNAL__TEST_LOWLINKS_FS: &'static str = "UV_INTERNAL__TEST_LOWLINKS_FS";
667
668 /// Used to force treating an interpreter as "managed" during tests.
669 #[attr_hidden]
670 #[attr_added_in("0.8.0")]
671 pub const UV_INTERNAL__TEST_PYTHON_MANAGED: &'static str = "UV_INTERNAL__TEST_PYTHON_MANAGED";
672
673 /// Used to force ignoring Git LFS commands as `git-lfs` detection cannot be overridden via PATH.
674 #[attr_hidden]
675 #[attr_added_in("0.9.15")]
676 pub const UV_INTERNAL__TEST_LFS_DISABLED: &'static str = "UV_INTERNAL__TEST_LFS_DISABLED";
677
678 /// Path to system-level configuration directory on Unix systems.
679 #[attr_added_in("0.4.26")]
680 pub const XDG_CONFIG_DIRS: &'static str = "XDG_CONFIG_DIRS";
681
682 /// Path to system-level configuration directory on Windows systems.
683 #[attr_added_in("0.4.26")]
684 pub const SYSTEMDRIVE: &'static str = "SYSTEMDRIVE";
685
686 /// Path to user-level configuration directory on Windows systems.
687 #[attr_added_in("0.1.42")]
688 pub const APPDATA: &'static str = "APPDATA";
689
690 /// Path to root directory of user's profile on Windows systems.
691 #[attr_added_in("0.0.5")]
692 pub const USERPROFILE: &'static str = "USERPROFILE";
693
694 /// Path to user-level configuration directory on Unix systems.
695 #[attr_added_in("0.1.34")]
696 pub const XDG_CONFIG_HOME: &'static str = "XDG_CONFIG_HOME";
697
698 /// Path to cache directory on Unix systems.
699 #[attr_added_in("0.1.17")]
700 pub const XDG_CACHE_HOME: &'static str = "XDG_CACHE_HOME";
701
702 /// Path to directory for storing managed Python installations and tools.
703 #[attr_added_in("0.2.16")]
704 pub const XDG_DATA_HOME: &'static str = "XDG_DATA_HOME";
705
706 /// Path to directory where executables are installed.
707 #[attr_added_in("0.2.16")]
708 pub const XDG_BIN_HOME: &'static str = "XDG_BIN_HOME";
709
710 /// Path to a CA certificate bundle file for TLS connections.
711 ///
712 /// Requires a PEM-encoded certificate file (e.g., `certs.pem`, `ca-bundle.crt`). DER-encoded
713 /// files are not supported.
714 ///
715 /// When set, this overrides the default certificate source (bundled Mozilla roots or system
716 /// certificates). Only the certificates in this file will be trusted.
717 #[attr_added_in("0.1.14")]
718 pub const SSL_CERT_FILE: &'static str = "SSL_CERT_FILE";
719
720 /// Path to a directory containing PEM-encoded CA certificate files for TLS connections.
721 ///
722 /// Multiple entries are supported, separated using a platform-specific delimiter (`:` on Unix,
723 /// `;` on Windows).
724 ///
725 /// Certificates are usually stored with `.pem`, `.crt`, or `.cer` extensions, but uv will
726 /// attempt to read a certificate from any regular file in the provided `SSL_CERT_DIR`.
727 ///
728 /// Files that cannot be parsed as PEM certificates are ignored. uv resolves symlinks and
729 /// ignores dangling symlinks.
730 ///
731 /// Only PEM-encoded files are supported, i.e., DER-encoded files are not supported.
732 ///
733 /// When set, this overrides the default certificate source (bundled Mozilla roots or system
734 /// certificates). Only the certificates in this directory will be trusted.
735 #[attr_added_in("0.9.10")]
736 pub const SSL_CERT_DIR: &'static str = "SSL_CERT_DIR";
737
738 /// If set, uv will use this file for mTLS authentication.
739 /// This should be a single file containing both the certificate and the private key in PEM format.
740 #[attr_added_in("0.2.11")]
741 pub const SSL_CLIENT_CERT: &'static str = "SSL_CLIENT_CERT";
742
743 /// Proxy for HTTP requests.
744 #[attr_added_in("0.1.38")]
745 pub const HTTP_PROXY: &'static str = "HTTP_PROXY";
746
747 /// Proxy for HTTPS requests.
748 #[attr_added_in("0.1.38")]
749 pub const HTTPS_PROXY: &'static str = "HTTPS_PROXY";
750
751 /// General proxy for all network requests.
752 #[attr_added_in("0.1.38")]
753 pub const ALL_PROXY: &'static str = "ALL_PROXY";
754
755 /// Comma-separated list of hostnames (e.g., `example.com`) and/or patterns (e.g., `192.168.1.0/24`) that should bypass the proxy.
756 #[attr_added_in("0.1.38")]
757 pub const NO_PROXY: &'static str = "NO_PROXY";
758
759 /// Timeout (in seconds) for only upload HTTP requests. (default: 900 s)
760 #[attr_added_in("0.9.1")]
761 pub const UV_UPLOAD_HTTP_TIMEOUT: &'static str = "UV_UPLOAD_HTTP_TIMEOUT";
762
763 /// Timeout (in seconds) for HTTP reads. (default: 30 s)
764 #[attr_added_in("0.1.7")]
765 pub const UV_HTTP_TIMEOUT: &'static str = "UV_HTTP_TIMEOUT";
766
767 /// Timeout (in seconds) to connect to a server. (default: 10 s)
768 ///
769 /// If `UV_HTTP_TIMEOUT` is lower than this value, `UV_HTTP_TIMEOUT` will be used instead.
770 #[attr_added_in("0.10.0")]
771 pub const UV_HTTP_CONNECT_TIMEOUT: &'static str = "UV_HTTP_CONNECT_TIMEOUT";
772
773 /// The number of retries for HTTP requests. (default: 3)
774 #[attr_added_in("0.7.21")]
775 pub const UV_HTTP_RETRIES: &'static str = "UV_HTTP_RETRIES";
776
777 /// Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`.
778 #[attr_added_in("0.1.6")]
779 pub const UV_REQUEST_TIMEOUT: &'static str = "UV_REQUEST_TIMEOUT";
780
781 /// Timeout (in seconds) for HTTP requests. Equivalent to `UV_HTTP_TIMEOUT`.
782 #[attr_added_in("0.1.7")]
783 pub const HTTP_TIMEOUT: &'static str = "HTTP_TIMEOUT";
784
785 /// The validation modes to use when run with `--compile`.
786 ///
787 /// See [`PycInvalidationMode`](https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode).
788 #[attr_added_in("0.1.7")]
789 pub const PYC_INVALIDATION_MODE: &'static str = "PYC_INVALIDATION_MODE";
790
791 /// Used to detect an activated virtual environment.
792 #[attr_added_in("0.0.5")]
793 pub const VIRTUAL_ENV: &'static str = "VIRTUAL_ENV";
794
795 /// Used to detect the path of an active Conda environment.
796 #[attr_added_in("0.0.5")]
797 pub const CONDA_PREFIX: &'static str = "CONDA_PREFIX";
798
799 /// Used to determine the name of the active Conda environment.
800 #[attr_added_in("0.5.0")]
801 pub const CONDA_DEFAULT_ENV: &'static str = "CONDA_DEFAULT_ENV";
802
803 /// Used to determine the root install path of Conda.
804 #[attr_added_in("0.8.18")]
805 pub const CONDA_ROOT: &'static str = "_CONDA_ROOT";
806
807 /// Used to determine if we're running in Dependabot.
808 #[attr_added_in("0.9.11")]
809 pub const DEPENDABOT: &'static str = "DEPENDABOT";
810
811 /// If set to `1` before a virtual environment is activated, then the
812 /// virtual environment name will not be prepended to the terminal prompt.
813 #[attr_added_in("0.0.5")]
814 pub const VIRTUAL_ENV_DISABLE_PROMPT: &'static str = "VIRTUAL_ENV_DISABLE_PROMPT";
815
816 /// Used to detect the use of the Windows Command Prompt (as opposed to PowerShell).
817 #[attr_added_in("0.1.16")]
818 pub const PROMPT: &'static str = "PROMPT";
819
820 /// Used to detect `NuShell` usage.
821 #[attr_added_in("0.1.16")]
822 pub const NU_VERSION: &'static str = "NU_VERSION";
823
824 /// Used to detect Fish shell usage.
825 #[attr_added_in("0.1.28")]
826 pub const FISH_VERSION: &'static str = "FISH_VERSION";
827
828 /// Used to detect Bash shell usage.
829 #[attr_added_in("0.1.28")]
830 pub const BASH_VERSION: &'static str = "BASH_VERSION";
831
832 /// Used to detect Zsh shell usage.
833 #[attr_added_in("0.1.28")]
834 pub const ZSH_VERSION: &'static str = "ZSH_VERSION";
835
836 /// Used to determine which `.zshenv` to use when Zsh is being used.
837 #[attr_added_in("0.2.25")]
838 pub const ZDOTDIR: &'static str = "ZDOTDIR";
839
840 /// Used to detect Ksh shell usage.
841 #[attr_added_in("0.2.33")]
842 pub const KSH_VERSION: &'static str = "KSH_VERSION";
843
844 /// Used to detect PowerShell usage (set by PowerShell on all platforms).
845 #[attr_added_in("0.10.0")]
846 pub const PS_MODULE_PATH: &'static str = "PSModulePath";
847
848 /// Used with `--python-platform macos` and related variants to set the
849 /// deployment target (i.e., the minimum supported macOS version).
850 ///
851 /// Defaults to `13.0`, the least-recent non-EOL macOS version at time of writing.
852 #[attr_added_in("0.1.42")]
853 pub const MACOSX_DEPLOYMENT_TARGET: &'static str = "MACOSX_DEPLOYMENT_TARGET";
854
855 /// Used with `--python-platform arm64-apple-ios` and related variants to set the
856 /// deployment target (i.e., the minimum supported iOS version).
857 ///
858 /// Defaults to `13.0`.
859 #[attr_added_in("0.8.16")]
860 pub const IPHONEOS_DEPLOYMENT_TARGET: &'static str = "IPHONEOS_DEPLOYMENT_TARGET";
861
862 /// Used with `--python-platform aarch64-linux-android` and related variants to set the
863 /// Android API level. (i.e., the minimum supported Android API level).
864 ///
865 /// Defaults to `24`.
866 #[attr_added_in("0.8.16")]
867 pub const ANDROID_API_LEVEL: &'static str = "ANDROID_API_LEVEL";
868
869 /// Disables colored output (takes precedence over `FORCE_COLOR`).
870 ///
871 /// See [no-color.org](https://no-color.org).
872 #[attr_added_in("0.2.7")]
873 pub const NO_COLOR: &'static str = "NO_COLOR";
874
875 /// Forces colored output regardless of terminal support.
876 ///
877 /// See [force-color.org](https://force-color.org).
878 #[attr_added_in("0.2.7")]
879 pub const FORCE_COLOR: &'static str = "FORCE_COLOR";
880
881 /// Use to control color via `anstyle`.
882 #[attr_added_in("0.1.32")]
883 pub const CLICOLOR_FORCE: &'static str = "CLICOLOR_FORCE";
884
885 /// The standard `PATH` env var.
886 #[attr_added_in("0.0.5")]
887 pub const PATH: &'static str = "PATH";
888
889 /// The standard `HOME` env var.
890 #[attr_added_in("0.0.5")]
891 pub const HOME: &'static str = "HOME";
892
893 /// The standard `SHELL` posix env var.
894 #[attr_added_in("0.1.16")]
895 pub const SHELL: &'static str = "SHELL";
896
897 /// The standard `PWD` posix env var.
898 #[attr_added_in("0.0.5")]
899 pub const PWD: &'static str = "PWD";
900
901 /// Used to look for Microsoft Store Pythons installations.
902 #[attr_added_in("0.3.3")]
903 pub const LOCALAPPDATA: &'static str = "LOCALAPPDATA";
904
905 /// Path to the `.git` directory. Ignored by `uv` when performing fetch.
906 #[attr_hidden]
907 #[attr_added_in("0.0.5")]
908 pub const GIT_DIR: &'static str = "GIT_DIR";
909
910 /// Path to the git working tree. Ignored by `uv` when performing fetch.
911 #[attr_hidden]
912 #[attr_added_in("0.0.5")]
913 pub const GIT_WORK_TREE: &'static str = "GIT_WORK_TREE";
914
915 /// Path to the index file for staged changes. Ignored by `uv` when performing fetch.
916 #[attr_hidden]
917 #[attr_added_in("0.0.5")]
918 pub const GIT_INDEX_FILE: &'static str = "GIT_INDEX_FILE";
919
920 /// Path to where git object files are located. Ignored by `uv` when performing fetch.
921 #[attr_hidden]
922 #[attr_added_in("0.0.5")]
923 pub const GIT_OBJECT_DIRECTORY: &'static str = "GIT_OBJECT_DIRECTORY";
924
925 /// Alternate locations for git objects. Ignored by `uv` when performing fetch.
926 #[attr_hidden]
927 #[attr_added_in("0.0.5")]
928 pub const GIT_ALTERNATE_OBJECT_DIRECTORIES: &'static str = "GIT_ALTERNATE_OBJECT_DIRECTORIES";
929
930 /// Disables SSL verification for git operations.
931 #[attr_hidden]
932 #[attr_added_in("0.5.28")]
933 pub const GIT_SSL_NO_VERIFY: &'static str = "GIT_SSL_NO_VERIFY";
934
935 /// Sets allowed protocols for git operations.
936 ///
937 /// When uv is in "offline" mode, only the "file" protocol is allowed.
938 #[attr_hidden]
939 #[attr_added_in("0.6.13")]
940 pub const GIT_ALLOW_PROTOCOL: &'static str = "GIT_ALLOW_PROTOCOL";
941
942 /// Sets the SSH command used when Git tries to establish a connection using SSH.
943 #[attr_hidden]
944 #[attr_added_in("0.7.11")]
945 pub const GIT_SSH_COMMAND: &'static str = "GIT_SSH_COMMAND";
946
947 /// Disable interactive git prompts in terminals, e.g., for credentials. Does not disable
948 /// GUI prompts.
949 #[attr_hidden]
950 #[attr_added_in("0.6.4")]
951 pub const GIT_TERMINAL_PROMPT: &'static str = "GIT_TERMINAL_PROMPT";
952
953 /// Skip Smudge LFS Filter.
954 #[attr_hidden]
955 #[attr_added_in("0.9.15")]
956 pub const GIT_LFS_SKIP_SMUDGE: &'static str = "GIT_LFS_SKIP_SMUDGE";
957
958 /// Used in tests to set the user global git config location.
959 #[attr_hidden]
960 #[attr_added_in("0.9.15")]
961 pub const GIT_CONFIG_GLOBAL: &'static str = "GIT_CONFIG_GLOBAL";
962
963 /// Used in tests for better git isolation.
964 ///
965 /// For example, we run some tests in ~/.local/share/uv/tests.
966 /// And if the user's `$HOME` directory is a git repository,
967 /// this will change the behavior of some tests. Setting
968 /// `GIT_CEILING_DIRECTORIES=/home/andrew/.local/share/uv/tests` will
969 /// prevent git from crawling up the directory tree past that point to find
970 /// parent git repositories.
971 #[attr_hidden]
972 #[attr_added_in("0.4.29")]
973 pub const GIT_CEILING_DIRECTORIES: &'static str = "GIT_CEILING_DIRECTORIES";
974
975 /// Cleared for uv's git invocations to ensure git behaves correctly in
976 /// spite of an odd environment.
977 #[attr_hidden]
978 #[attr_added_in("0.11.8")]
979 pub const GIT_COMMON_DIR: &'static str = "GIT_COMMON_DIR";
980
981 /// Indicates that the current process is running in GitHub Actions.
982 ///
983 /// `uv publish` may attempt trusted publishing flows when set
984 /// to `true`.
985 #[attr_added_in("0.4.16")]
986 pub const GITHUB_ACTIONS: &'static str = "GITHUB_ACTIONS";
987
988 /// Indicates that the current process is running in GitLab CI.
989 ///
990 /// `uv publish` may attempt trusted publishing flows when set
991 /// to `true`.
992 #[attr_added_in("0.8.18")]
993 pub const GITLAB_CI: &'static str = "GITLAB_CI";
994
995 /// Used for testing GitLab CI trusted publishing.
996 #[attr_hidden]
997 #[attr_added_in("0.8.18")]
998 pub const PYPI_ID_TOKEN: &'static str = "PYPI_ID_TOKEN";
999
1000 /// Used for testing GitLab CI trusted publishing.
1001 #[attr_hidden]
1002 #[attr_added_in("0.8.18")]
1003 pub const TESTPYPI_ID_TOKEN: &'static str = "TESTPYPI_ID_TOKEN";
1004
1005 /// Sets the encoding for standard I/O streams (e.g., PYTHONIOENCODING=utf-8).
1006 #[attr_hidden]
1007 #[attr_added_in("0.4.18")]
1008 pub const PYTHONIOENCODING: &'static str = "PYTHONIOENCODING";
1009
1010 /// Forces unbuffered I/O streams, equivalent to `-u` in Python.
1011 #[attr_hidden]
1012 #[attr_added_in("0.1.15")]
1013 pub const PYTHONUNBUFFERED: &'static str = "PYTHONUNBUFFERED";
1014
1015 /// Enables UTF-8 mode for Python, equivalent to `-X utf8`.
1016 #[attr_hidden]
1017 #[attr_added_in("0.4.19")]
1018 pub const PYTHONUTF8: &'static str = "PYTHONUTF8";
1019
1020 /// Adds directories to Python module search path (e.g., `PYTHONPATH=/path/to/modules`).
1021 #[attr_added_in("0.1.22")]
1022 pub const PYTHONPATH: &'static str = "PYTHONPATH";
1023
1024 /// Used to set the location of Python stdlib when using trampolines.
1025 #[attr_hidden]
1026 #[attr_added_in("0.7.13")]
1027 pub const PYTHONHOME: &'static str = "PYTHONHOME";
1028
1029 /// Used to correctly detect virtual environments when using trampolines.
1030 #[attr_hidden]
1031 #[attr_added_in("0.7.13")]
1032 pub const PYVENV_LAUNCHER: &'static str = "__PYVENV_LAUNCHER__";
1033
1034 /// Used in tests to enforce a consistent locale setting.
1035 #[attr_hidden]
1036 #[attr_added_in("0.4.28")]
1037 pub const LC_ALL: &'static str = "LC_ALL";
1038
1039 /// Typically set by CI runners, used to detect a CI runner.
1040 #[attr_hidden]
1041 #[attr_added_in("0.0.5")]
1042 pub const CI: &'static str = "CI";
1043
1044 /// Azure DevOps build identifier, used to detect CI environments.
1045 #[attr_hidden]
1046 #[attr_added_in("0.1.22")]
1047 pub const BUILD_BUILDID: &'static str = "BUILD_BUILDID";
1048
1049 /// Generic build identifier, used to detect CI environments.
1050 #[attr_hidden]
1051 #[attr_added_in("0.1.22")]
1052 pub const BUILD_ID: &'static str = "BUILD_ID";
1053
1054 /// Pip environment variable to indicate CI environment.
1055 #[attr_hidden]
1056 #[attr_added_in("0.1.22")]
1057 pub const PIP_IS_CI: &'static str = "PIP_IS_CI";
1058
1059 /// Use to set the .netrc file location.
1060 #[attr_added_in("0.1.16")]
1061 pub const NETRC: &'static str = "NETRC";
1062
1063 /// The standard `PAGER` posix env var. Used by `uv` to configure the appropriate pager.
1064 #[attr_added_in("0.4.18")]
1065 pub const PAGER: &'static str = "PAGER";
1066
1067 /// Used to detect when running inside a Jupyter notebook.
1068 #[attr_added_in("0.2.6")]
1069 pub const JPY_SESSION_NAME: &'static str = "JPY_SESSION_NAME";
1070
1071 /// Use to create the tracing root directory via the `tracing-durations-export` feature.
1072 #[attr_hidden]
1073 #[attr_added_in("0.1.32")]
1074 pub const TRACING_DURATIONS_TEST_ROOT: &'static str = "TRACING_DURATIONS_TEST_ROOT";
1075
1076 /// Use to create the tracing durations file via the `tracing-durations-export` feature.
1077 #[attr_added_in("0.0.5")]
1078 pub const TRACING_DURATIONS_FILE: &'static str = "TRACING_DURATIONS_FILE";
1079
1080 /// Used to set `RUST_HOST_TARGET` at build time via `build.rs`.
1081 #[attr_hidden]
1082 #[attr_added_in("0.1.11")]
1083 pub const TARGET: &'static str = "TARGET";
1084
1085 /// If set, uv will use this value as the log level for its `--verbose` output. Accepts
1086 /// any filter compatible with the `tracing_subscriber` crate.
1087 ///
1088 /// For example:
1089 ///
1090 /// * `RUST_LOG=uv=debug` is the equivalent of adding `--verbose` to the command line
1091 /// * `RUST_LOG=trace` will enable trace-level logging.
1092 ///
1093 /// See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax)
1094 /// for more.
1095 #[attr_added_in("0.0.5")]
1096 pub const RUST_LOG: &'static str = "RUST_LOG";
1097
1098 /// If set, it can be used to display more stack trace details when a panic occurs.
1099 /// This is used by uv particularly on windows to show more details during a platform exception.
1100 ///
1101 /// For example:
1102 ///
1103 /// * `RUST_BACKTRACE=1` will print a short backtrace.
1104 /// * `RUST_BACKTRACE=full` will print a full backtrace.
1105 ///
1106 /// See the [Rust backtrace documentation](https://doc.rust-lang.org/std/backtrace/index.html)
1107 /// for more.
1108 #[attr_added_in("0.7.22")]
1109 pub const RUST_BACKTRACE: &'static str = "RUST_BACKTRACE";
1110
1111 /// Add additional context and structure to log messages.
1112 ///
1113 /// If logging is not enabled, e.g., with `RUST_LOG` or `-v`, this has no effect.
1114 #[attr_added_in("0.6.4")]
1115 pub const UV_LOG_CONTEXT: &'static str = "UV_LOG_CONTEXT";
1116
1117 /// Use to set the stack size used by uv.
1118 ///
1119 /// The value is in bytes, and if both `UV_STACK_SIZE` are `RUST_MIN_STACK` unset, uv uses a 4MB
1120 /// (4194304) stack. `UV_STACK_SIZE` takes precedence over `RUST_MIN_STACK`.
1121 ///
1122 /// Unlike the normal `RUST_MIN_STACK` semantics, this can affect main thread
1123 /// stack size, because we actually spawn our own main2 thread to work around
1124 /// the fact that Windows' real main thread is only 1MB. That thread has size
1125 /// `max(UV_STACK_SIZE, 1MB)`.
1126 #[attr_added_in("0.0.5")]
1127 pub const UV_STACK_SIZE: &'static str = "UV_STACK_SIZE";
1128
1129 /// Use to set the stack size used by uv.
1130 ///
1131 /// The value is in bytes, and if both `UV_STACK_SIZE` are `RUST_MIN_STACK` unset, uv uses a 4MB
1132 /// (4194304) stack. `UV_STACK_SIZE` takes precedence over `RUST_MIN_STACK`.
1133 ///
1134 /// Prefer setting `UV_STACK_SIZE`, since `RUST_MIN_STACK` also affects subprocesses, such as
1135 /// build backends that use Rust code.
1136 ///
1137 /// Unlike the normal `RUST_MIN_STACK` semantics, this can affect main thread
1138 /// stack size, because we actually spawn our own main2 thread to work around
1139 /// the fact that Windows' real main thread is only 1MB. That thread has size
1140 /// `max(RUST_MIN_STACK, 1MB)`.
1141 #[attr_added_in("0.5.19")]
1142 pub const RUST_MIN_STACK: &'static str = "RUST_MIN_STACK";
1143
1144 /// The directory containing the `Cargo.toml` manifest for a package.
1145 #[attr_hidden]
1146 #[attr_added_in("0.1.11")]
1147 pub const CARGO_MANIFEST_DIR: &'static str = "CARGO_MANIFEST_DIR";
1148
1149 /// Specifies the directory where Cargo stores build artifacts (target directory).
1150 #[attr_hidden]
1151 #[attr_added_in("0.0.5")]
1152 pub const CARGO_TARGET_DIR: &'static str = "CARGO_TARGET_DIR";
1153
1154 /// Set by cargo when compiling for Windows-like platforms.
1155 #[attr_hidden]
1156 #[attr_added_in("0.0.5")]
1157 pub const CARGO_CFG_WINDOWS: &'static str = "CARGO_CFG_WINDOWS";
1158
1159 /// Specifies the directory where Cargo stores intermediate build artifacts.
1160 #[attr_hidden]
1161 #[attr_added_in("0.8.25")]
1162 pub const OUT_DIR: &'static str = "OUT_DIR";
1163
1164 /// Used in tests for environment substitution testing in `requirements.in`.
1165 #[attr_hidden]
1166 #[attr_added_in("0.1.18")]
1167 pub const URL: &'static str = "URL";
1168
1169 /// Used in tests for environment substitution testing in `requirements.in`.
1170 #[attr_hidden]
1171 #[attr_added_in("0.1.18")]
1172 pub const FILE_PATH: &'static str = "FILE_PATH";
1173
1174 /// Used in tests for environment substitution testing in `requirements.in`.
1175 #[attr_hidden]
1176 #[attr_added_in("0.1.25")]
1177 pub const HATCH_PATH: &'static str = "HATCH_PATH";
1178
1179 /// Used in tests for environment substitution testing in `requirements.in`.
1180 #[attr_hidden]
1181 #[attr_added_in("0.1.25")]
1182 pub const BLACK_PATH: &'static str = "BLACK_PATH";
1183
1184 /// Used in testing Hatch's root.uri feature
1185 ///
1186 /// See: <https://hatch.pypa.io/dev/config/dependency/#local>.
1187 #[attr_hidden]
1188 #[attr_added_in("0.1.22")]
1189 pub const ROOT_PATH: &'static str = "ROOT_PATH";
1190
1191 /// Used in testing extra build dependencies.
1192 #[attr_hidden]
1193 #[attr_added_in("0.8.5")]
1194 pub const EXPECTED_ANYIO_VERSION: &'static str = "EXPECTED_ANYIO_VERSION";
1195
1196 /// Used to set test credentials for keyring tests.
1197 #[attr_hidden]
1198 #[attr_added_in("0.1.34")]
1199 pub const KEYRING_TEST_CREDENTIALS: &'static str = "KEYRING_TEST_CREDENTIALS";
1200
1201 /// Used to disable delay for HTTP retries in tests.
1202 #[attr_added_in("0.7.21")]
1203 pub const UV_TEST_NO_HTTP_RETRY_DELAY: &'static str = "UV_TEST_NO_HTTP_RETRY_DELAY";
1204
1205 /// Used to set a packse index url for tests.
1206 #[attr_hidden]
1207 #[attr_added_in("0.2.12")]
1208 pub const UV_TEST_PACKSE_INDEX: &'static str = "UV_TEST_PACKSE_INDEX";
1209
1210 /// Used for testing named indexes in tests.
1211 #[attr_hidden]
1212 #[attr_added_in("0.5.21")]
1213 pub const UV_INDEX_MY_INDEX_USERNAME: &'static str = "UV_INDEX_MY_INDEX_USERNAME";
1214
1215 /// Used for testing named indexes in tests.
1216 #[attr_hidden]
1217 #[attr_added_in("0.5.21")]
1218 pub const UV_INDEX_MY_INDEX_PASSWORD: &'static str = "UV_INDEX_MY_INDEX_PASSWORD";
1219
1220 /// Used to set the GitHub fast-path url for tests.
1221 #[attr_hidden]
1222 #[attr_added_in("0.7.15")]
1223 pub const UV_GITHUB_FAST_PATH_URL: &'static str = "UV_GITHUB_FAST_PATH_URL";
1224
1225 /// Hide progress messages with non-deterministic order in tests.
1226 #[attr_hidden]
1227 #[attr_added_in("0.5.29")]
1228 pub const UV_TEST_NO_CLI_PROGRESS: &'static str = "UV_TEST_NO_CLI_PROGRESS";
1229
1230 /// Used to mock the current timestamp for relative `--exclude-newer` times in tests.
1231 /// Should be set to an RFC 3339 timestamp (e.g., `2025-11-21T12:00:00Z`).
1232 #[attr_hidden]
1233 #[attr_added_in("0.9.8")]
1234 pub const UV_TEST_CURRENT_TIMESTAMP: &'static str = "UV_TEST_CURRENT_TIMESTAMP";
1235
1236 /// When set to a timestamp, applies an `exclude-newer` filter to the versions
1237 /// considered available from indexes.
1238 ///
1239 /// This is used for reproducible resolver error messages. When `exclude-newer`
1240 /// is used, we retain information about the available versions to improve error
1241 /// messages. In contrast, versions published after this cutoff are considered
1242 /// non-existent.
1243 ///
1244 /// Should be set to an RFC 3339 timestamp (e.g., `2024-03-25T00:00:00Z`).
1245 #[attr_hidden]
1246 #[attr_added_in("0.11.7")]
1247 pub const UV_TEST_AVAILABLE_VERSION_CUTOFF: &'static str = "UV_TEST_AVAILABLE_VERSION_CUTOFF";
1248
1249 /// `.env` files from which to load environment variables when executing `uv run` commands.
1250 #[attr_added_in("0.4.30")]
1251 pub const UV_ENV_FILE: &'static str = "UV_ENV_FILE";
1252
1253 /// Ignore `.env` files when executing `uv run` commands.
1254 #[attr_added_in("0.4.30")]
1255 pub const UV_NO_ENV_FILE: &'static str = "UV_NO_ENV_FILE";
1256
1257 /// The URL from which to download uv using the standalone installer and `self update` feature,
1258 /// in lieu of the default GitHub URL.
1259 ///
1260 /// This more-specific installer source takes precedence over
1261 /// [`UV_ASTRAL_MIRROR_URL`](Self::UV_ASTRAL_MIRROR_URL) for `uv self update`.
1262 #[attr_added_in("0.5.0")]
1263 pub const UV_INSTALLER_GITHUB_BASE_URL: &'static str = "UV_INSTALLER_GITHUB_BASE_URL";
1264
1265 /// The URL from which to download uv using the standalone installer and `self update` feature,
1266 /// in lieu of the default GitHub Enterprise URL.
1267 ///
1268 /// This more-specific installer source takes precedence over
1269 /// [`UV_ASTRAL_MIRROR_URL`](Self::UV_ASTRAL_MIRROR_URL) for `uv self update`.
1270 #[attr_added_in("0.5.0")]
1271 pub const UV_INSTALLER_GHE_BASE_URL: &'static str = "UV_INSTALLER_GHE_BASE_URL";
1272
1273 /// The directory in which to install uv using the standalone installer and `self update` feature.
1274 /// Defaults to `~/.local/bin`.
1275 #[attr_added_in("0.5.0")]
1276 pub const UV_INSTALL_DIR: &'static str = "UV_INSTALL_DIR";
1277
1278 /// Used ephemeral environments like CI to install uv to a specific path while preventing
1279 /// the installer from modifying shell profiles or environment variables.
1280 #[attr_added_in("0.5.0")]
1281 pub const UV_UNMANAGED_INSTALL: &'static str = "UV_UNMANAGED_INSTALL";
1282
1283 /// The URL from which to download uv using the standalone installer. By default, installs from
1284 /// uv's GitHub Releases. `INSTALLER_DOWNLOAD_URL` is also supported as an alias, for backwards
1285 /// compatibility.
1286 #[attr_added_in("0.8.4")]
1287 pub const UV_DOWNLOAD_URL: &'static str = "UV_DOWNLOAD_URL";
1288
1289 /// Avoid modifying the `PATH` environment variable when installing uv using the standalone
1290 /// installer and `self update` feature. `INSTALLER_NO_MODIFY_PATH` is also supported as an
1291 /// alias, for backwards compatibility.
1292 #[attr_added_in("0.8.4")]
1293 pub const UV_NO_MODIFY_PATH: &'static str = "UV_NO_MODIFY_PATH";
1294
1295 /// Skip writing `uv` installer metadata files (e.g., `INSTALLER`, `REQUESTED`, and `direct_url.json`) to site-packages `.dist-info` directories.
1296 #[attr_added_in("0.5.7")]
1297 pub const UV_NO_INSTALLER_METADATA: &'static str = "UV_NO_INSTALLER_METADATA";
1298
1299 /// Enables fetching files stored in Git LFS when installing a package from a Git repository.
1300 #[attr_added_in("0.5.19")]
1301 pub const UV_GIT_LFS: &'static str = "UV_GIT_LFS";
1302
1303 /// Number of times that `uv run` has been recursively invoked. Used to guard against infinite
1304 /// recursion, e.g., when `uv run`` is used in a script shebang.
1305 #[attr_hidden]
1306 #[attr_added_in("0.5.31")]
1307 pub const UV_RUN_RECURSION_DEPTH: &'static str = "UV_RUN_RECURSION_DEPTH";
1308
1309 /// Number of times that `uv run` will allow recursive invocations, before exiting with an
1310 /// error.
1311 #[attr_hidden]
1312 #[attr_added_in("0.5.31")]
1313 pub const UV_RUN_MAX_RECURSION_DEPTH: &'static str = "UV_RUN_MAX_RECURSION_DEPTH";
1314
1315 /// Overrides terminal width used for wrapping. This variable is not read by uv directly.
1316 ///
1317 /// This is a quasi-standard variable, described, e.g., in `ncurses(3x)`.
1318 #[attr_added_in("0.6.2")]
1319 pub const COLUMNS: &'static str = "COLUMNS";
1320
1321 /// The CUDA driver version to assume when inferring the PyTorch backend (e.g., `550.144.03`).
1322 #[attr_hidden]
1323 #[attr_added_in("0.6.9")]
1324 pub const UV_CUDA_DRIVER_VERSION: &'static str = "UV_CUDA_DRIVER_VERSION";
1325
1326 /// The AMD GPU architecture to assume when inferring the PyTorch backend (e.g., `gfx1100`).
1327 #[attr_hidden]
1328 #[attr_added_in("0.7.14")]
1329 pub const UV_AMD_GPU_ARCHITECTURE: &'static str = "UV_AMD_GPU_ARCHITECTURE";
1330
1331 /// Equivalent to the `--torch-backend` command-line argument (e.g., `cpu`, `cu126`, or `auto`).
1332 #[attr_added_in("0.6.9")]
1333 pub const UV_TORCH_BACKEND: &'static str = "UV_TORCH_BACKEND";
1334
1335 /// Equivalent to the `--project` command-line argument.
1336 #[attr_added_in("0.4.4")]
1337 pub const UV_PROJECT: &'static str = "UV_PROJECT";
1338
1339 /// Equivalent to the `--no-project` command-line argument.
1340 #[attr_added_in("0.11.8")]
1341 pub const UV_NO_PROJECT: &'static str = "UV_NO_PROJECT";
1342
1343 /// Equivalent to the `--directory` command-line argument. `UV_WORKING_DIRECTORY` (added in
1344 /// v0.9.1) is also supported for backwards compatibility.
1345 #[attr_added_in("0.9.14")]
1346 pub const UV_WORKING_DIR: &'static str = "UV_WORKING_DIR";
1347
1348 /// Equivalent to the `--directory` command-line argument.
1349 #[attr_hidden]
1350 #[attr_added_in("0.9.1")]
1351 pub const UV_WORKING_DIRECTORY: &'static str = "UV_WORKING_DIRECTORY";
1352
1353 /// Disable GitHub-specific requests that allow uv to skip `git fetch` in some circumstances.
1354 #[attr_added_in("0.7.13")]
1355 pub const UV_NO_GITHUB_FAST_PATH: &'static str = "UV_NO_GITHUB_FAST_PATH";
1356
1357 /// Authentication token for Hugging Face requests. When set, uv will use this token
1358 /// when making requests to `https://huggingface.co/` and any subdomains.
1359 #[attr_added_in("0.8.1")]
1360 pub const HF_TOKEN: &'static str = "HF_TOKEN";
1361
1362 /// Disable Hugging Face authentication, even if `HF_TOKEN` is set.
1363 #[attr_added_in("0.8.1")]
1364 pub const UV_NO_HF_TOKEN: &'static str = "UV_NO_HF_TOKEN";
1365
1366 /// The URL to treat as an S3-compatible storage endpoint. Requests to this endpoint
1367 /// will be signed using AWS Signature Version 4 based on the `AWS_ACCESS_KEY_ID`,
1368 /// `AWS_SECRET_ACCESS_KEY`, `AWS_PROFILE`, and `AWS_CONFIG_FILE` environment variables.
1369 #[attr_added_in("0.8.21")]
1370 pub const UV_S3_ENDPOINT_URL: &'static str = "UV_S3_ENDPOINT_URL";
1371
1372 /// The URL to treat as a GCS-compatible storage endpoint. Requests to this endpoint
1373 /// will be signed using Google Cloud authentication based on the `GOOGLE_APPLICATION_CREDENTIALS`
1374 /// environment variable or Application Default Credentials.
1375 #[attr_added_in("0.9.26")]
1376 pub const UV_GCS_ENDPOINT_URL: &'static str = "UV_GCS_ENDPOINT_URL";
1377
1378 /// The URL to treat as an Azure Blob Storage endpoint. Requests to this endpoint will be signed
1379 /// using Azure credentials from the default credential chain, including Azure CLI credentials
1380 /// and workload identity.
1381 #[attr_added_in("0.11.14")]
1382 pub const UV_AZURE_ENDPOINT_URL: &'static str = "UV_AZURE_ENDPOINT_URL";
1383
1384 /// The URL of the pyx Simple API server.
1385 #[attr_added_in("0.8.15")]
1386 pub const PYX_API_URL: &'static str = "PYX_API_URL";
1387
1388 /// The domain of the pyx CDN.
1389 #[attr_added_in("0.8.15")]
1390 pub const PYX_CDN_DOMAIN: &'static str = "PYX_CDN_DOMAIN";
1391
1392 /// The pyx API key (e.g., `sk-pyx-...`).
1393 #[attr_added_in("0.8.15")]
1394 pub const PYX_API_KEY: &'static str = "PYX_API_KEY";
1395
1396 /// The pyx API key, for backwards compatibility.
1397 #[attr_hidden]
1398 #[attr_added_in("0.8.15")]
1399 pub const UV_API_KEY: &'static str = "UV_API_KEY";
1400
1401 /// The pyx authentication token (e.g., `eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...`), as output by `uv auth token`.
1402 #[attr_added_in("0.8.15")]
1403 pub const PYX_AUTH_TOKEN: &'static str = "PYX_AUTH_TOKEN";
1404
1405 /// The pyx authentication token, for backwards compatibility.
1406 #[attr_hidden]
1407 #[attr_added_in("0.8.15")]
1408 pub const UV_AUTH_TOKEN: &'static str = "UV_AUTH_TOKEN";
1409
1410 /// Specifies the directory where uv stores pyx credentials.
1411 #[attr_added_in("0.8.15")]
1412 pub const PYX_CREDENTIALS_DIR: &'static str = "PYX_CREDENTIALS_DIR";
1413
1414 /// The AWS region to use when signing S3 requests.
1415 #[attr_added_in("0.8.21")]
1416 pub const AWS_REGION: &'static str = "AWS_REGION";
1417
1418 /// The default AWS region to use when signing S3 requests, if `AWS_REGION` is not set.
1419 #[attr_added_in("0.8.21")]
1420 pub const AWS_DEFAULT_REGION: &'static str = "AWS_DEFAULT_REGION";
1421
1422 /// The AWS access key ID to use when signing S3 requests.
1423 #[attr_added_in("0.8.21")]
1424 pub const AWS_ACCESS_KEY_ID: &'static str = "AWS_ACCESS_KEY_ID";
1425
1426 /// The AWS secret access key to use when signing S3 requests.
1427 #[attr_added_in("0.8.21")]
1428 pub const AWS_SECRET_ACCESS_KEY: &'static str = "AWS_SECRET_ACCESS_KEY";
1429
1430 /// The AWS session token to use when signing S3 requests.
1431 #[attr_added_in("0.8.21")]
1432 pub const AWS_SESSION_TOKEN: &'static str = "AWS_SESSION_TOKEN";
1433
1434 /// The AWS profile to use when signing S3 requests.
1435 #[attr_added_in("0.8.21")]
1436 pub const AWS_PROFILE: &'static str = "AWS_PROFILE";
1437
1438 /// The AWS config file to use when signing S3 requests.
1439 #[attr_added_in("0.8.21")]
1440 pub const AWS_CONFIG_FILE: &'static str = "AWS_CONFIG_FILE";
1441
1442 /// The AWS shared credentials file to use when signing S3 requests.
1443 #[attr_added_in("0.8.21")]
1444 pub const AWS_SHARED_CREDENTIALS_FILE: &'static str = "AWS_SHARED_CREDENTIALS_FILE";
1445
1446 /// Avoid verifying that wheel filenames match their contents when installing wheels. This
1447 /// is not recommended, as wheels with inconsistent filenames should be considered invalid and
1448 /// corrected by the relevant package maintainers; however, this option can be used to work
1449 /// around invalid artifacts in rare cases.
1450 #[attr_added_in("0.8.23")]
1451 pub const UV_SKIP_WHEEL_FILENAME_CHECK: &'static str = "UV_SKIP_WHEEL_FILENAME_CHECK";
1452
1453 /// Suppress output from the build backend when building source distributions, even in the event
1454 /// of build failures.
1455 #[attr_added_in("0.9.15")]
1456 pub const UV_HIDE_BUILD_OUTPUT: &'static str = "UV_HIDE_BUILD_OUTPUT";
1457
1458 /// The time in seconds uv waits for a file lock to become available.
1459 ///
1460 /// Defaults to 300s (5 min).
1461 #[attr_added_in("0.9.4")]
1462 pub const UV_LOCK_TIMEOUT: &'static str = "UV_LOCK_TIMEOUT";
1463}