From 08140c7851a3a35ea2b3a8067a765dc90f6f65cd Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Mon, 24 Feb 2025 13:25:38 -0600 Subject: [PATCH] Add anchor links to arguments and options in the CLI reference --- crates/uv-dev/src/generate_cli_reference.rs | 14 +- docs/reference/cli.md | 2770 +++++++++---------- 2 files changed, 1394 insertions(+), 1390 deletions(-) diff --git a/crates/uv-dev/src/generate_cli_reference.rs b/crates/uv-dev/src/generate_cli_reference.rs index 1c621c320921..f57e4d665c83 100644 --- a/crates/uv-dev/src/generate_cli_reference.rs +++ b/crates/uv-dev/src/generate_cli_reference.rs @@ -185,6 +185,8 @@ fn generate_command<'a>(output: &mut String, command: &'a Command, parents: &mut // Do not display options for commands with children if !has_subcommands { + let name_key = name.replace(' ', "-"); + // Display positional arguments let mut arguments = command .get_positionals() @@ -196,10 +198,11 @@ fn generate_command<'a>(output: &mut String, command: &'a Command, parents: &mut output.push_str("
"); for arg in arguments { - output.push_str("
"); + let id = format!("{name_key}--{}", arg.get_id()); + output.push_str(&format!("
")); output.push_str(&format!( - "{}", - arg.get_id().to_string().to_uppercase() + "{}", + arg.get_id().to_string().to_uppercase(), )); output.push_str("
"); if let Some(help) = arg.get_long_help().or_else(|| arg.get_help()) { @@ -225,9 +228,10 @@ fn generate_command<'a>(output: &mut String, command: &'a Command, parents: &mut output.push_str("
"); for opt in options { let Some(long) = opt.get_long() else { continue }; + let id = format!("{name_key}--{long}"); - output.push_str("
"); - output.push_str(&format!("--{long}")); + output.push_str(&format!("
")); + output.push_str(&format!("--{long}",)); if let Some(short) = opt.get_short() { output.push_str(&format!(", -{short}")); } diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 7c20da7d92fb..4618716791be 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -72,27 +72,27 @@ uv run [OPTIONS] [COMMAND]

Options

-
--active

Prefer the active virtual environment over the project’s virtual environment.

+
--active

Prefer the active virtual environment over the project’s virtual environment.

If the project virtual environment is active or no virtual environment is active, this has no effect.

-
--all-extras

Include all optional dependencies.

+
--all-extras

Include all optional dependencies.

Optional dependencies are defined via project.optional-dependencies in a pyproject.toml.

This option is only available when running in a project.

-
--all-groups

Include dependencies from all dependency groups.

+
--all-groups

Include dependencies from all dependency groups.

--no-group can be used to exclude specific groups.

-
--all-packages

Run the command with all workspace members installed.

+
--all-packages

Run the command with all workspace members installed.

The workspace’s environment (.venv) is updated to include all workspace members.

Any extras or groups specified via --extra, --group, or related options will be applied to all workspace members.

-
--allow-insecure-host allow-insecure-host

Allow insecure connections to a host.

+
--allow-insecure-host allow-insecure-host

Allow insecure connections to a host.

Can be provided multiple times.

@@ -101,14 +101,14 @@ uv run [OPTIONS] [COMMAND]

WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

May also be set with the UV_INSECURE_HOST environment variable.

-
--cache-dir cache-dir

Path to the cache directory.

+
--cache-dir cache-dir

Path to the cache directory.

Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

To view the location of the cache directory, run uv cache dir.

May also be set with the UV_CACHE_DIR environment variable.

-
--color color-choice

Control the use of color in output.

+
--color color-choice

Control the use of color in output.

By default, uv will automatically detect support for colors when writing to a terminal.

@@ -121,48 +121,48 @@ uv run [OPTIONS] [COMMAND]
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode

    Compile Python files to bytecode after installation.

    By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

    When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

    May also be set with the UV_COMPILE_BYTECODE environment variable.

    -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --env-file env-file

    Load environment variables from a .env file.

    +
    --env-file env-file

    Load environment variables from a .env file.

    Can be provided multiple times, with subsequent files overriding values defined in previous files.

    May also be set with the UV_ENV_FILE environment variable.

    -
    --exact

    Perform an exact sync, removing extraneous packages.

    +
    --exact

    Perform an exact sync, removing extraneous packages.

    When enabled, uv will remove any extraneous packages from the environment. By default, uv run will make the minimum necessary changes to satisfy the requirements.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra extra

    Include optional dependencies from the specified extra name.

    +
    --extra extra

    Include optional dependencies from the specified extra name.

    May be provided more than once.

    @@ -170,21 +170,21 @@ uv run [OPTIONS] [COMMAND]

    This option is only available when running in a project.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -198,29 +198,29 @@ uv run [OPTIONS] [COMMAND]
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --frozen

    Run without updating the uv.lock file.

    +
    --frozen

    Run without updating the uv.lock file.

    Instead of checking if the lockfile is up-to-date, uses the versions in the lockfile as the source of truth. If the lockfile is missing, uv will exit with an error. If the pyproject.toml includes changes to dependencies that have not been included in the lockfile yet, they will not be present in the environment.

    May also be set with the UV_FROZEN environment variable.

    -
    --group group

    Include dependencies from the specified dependency group.

    +
    --group group

    Include dependencies from the specified dependency group.

    May be provided multiple times.

    -
    --gui-script

    Run the given path as a Python GUI script.

    +
    --gui-script

    Run the given path as a Python GUI script.

    Using --gui-script will attempt to parse the path as a PEP 723 script and run it with pythonw.exe, irrespective of its extension. Only available on Windows.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -234,14 +234,14 @@ uv run [OPTIONS] [COMMAND]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --isolated

    Run the command in an isolated virtual environment.

    +
    --isolated

    Run the command in an isolated virtual environment.

    Usually, the project environment is reused for performance. This option forces a fresh environment to be used for the project, enforcing strict isolation between dependencies and declaration of requirements.

    @@ -249,7 +249,7 @@ uv run [OPTIONS] [COMMAND]

    When used with --with or --with-requirements, the additional dependencies will still be layered in a second environment.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -263,7 +263,7 @@ uv run [OPTIONS] [COMMAND]
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

    @@ -279,122 +279,122 @@ uv run [OPTIONS] [COMMAND]
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --locked

    Assert that the uv.lock will remain unchanged.

    +
    --locked

    Assert that the uv.lock will remain unchanged.

    Requires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.

    May also be set with the UV_LOCKED environment variable.

    -
    --module, -m

    Run a Python module.

    +
    --module, -m

    Run a Python module.

    Equivalent to python -m <module>.

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-default-groups

    Ignore the the default dependency groups.

    +
    --no-default-groups

    Ignore the the default dependency groups.

    uv includes the groups defined in tool.uv.default-groups by default. This disables that option, however, specific groups can still be included with --group.

    -
    --no-dev

    Disable the development dependency group.

    +
    --no-dev

    Disable the development dependency group.

    This option is an alias of --no-group dev. See --no-default-groups to disable all default groups instead.

    This option is only available when running in a project.

    -
    --no-editable

    Install any editable dependencies, including the project and any workspace members, as non-editable

    +
    --no-editable

    Install any editable dependencies, including the project and any workspace members, as non-editable

    -
    --no-env-file

    Avoid reading environment variables from a .env file

    +
    --no-env-file

    Avoid reading environment variables from a .env file

    May also be set with the UV_NO_ENV_FILE environment variable.

    -
    --no-extra no-extra

    Exclude the specified optional dependencies, if --all-extras is supplied.

    +
    --no-extra no-extra

    Exclude the specified optional dependencies, if --all-extras is supplied.

    May be provided multiple times.

    -
    --no-group no-group

    Disable the specified dependency group.

    +
    --no-group no-group

    Disable the specified dependency group.

    This options always takes precedence over default groups, --all-groups, and --group.

    May be provided multiple times.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-project

    Avoid discovering the project or workspace.

    +
    --no-project

    Avoid discovering the project or workspace.

    Instead of searching for projects in the current directory and parent directories, run in an isolated, ephemeral environment populated by the --with requirements.

    If a virtual environment is active or found in a current or parent directory, it will be used as if there was no project or workspace.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --no-sync

    Avoid syncing the virtual environment.

    +
    --no-sync

    Avoid syncing the virtual environment.

    Implies --frozen, as the project dependencies will be ignored (i.e., the lockfile will not be updated, since the environment will not be synced regardless).

    May also be set with the UV_NO_SYNC environment variable.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --only-dev

    Only include the development dependency group.

    +
    --only-dev

    Only include the development dependency group.

    The project and its dependencies will be omitted.

    This option is an alias for --only-group dev. Implies --no-default-groups.

    -
    --only-group only-group

    Only include dependencies from the specified dependency group.

    +
    --only-group only-group

    Only include dependencies from the specified dependency group.

    The project and its dependencies will be omitted.

    May be provided multiple times. Implies --no-default-groups.

    -
    --package package

    Run the command in a specific package in the workspace.

    +
    --package package

    Run the command in a specific package in the workspace.

    If the workspace member does not exist, uv will exit with an error.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -412,7 +412,7 @@ uv run [OPTIONS] [COMMAND]
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -422,14 +422,14 @@ uv run [OPTIONS] [COMMAND]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use for the run environment.

    +
    --python, -p python

    The Python interpreter to use for the run environment.

    If the interpreter request is satisfied by a discovered environment, the environment will be used.

    See uv python to view supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -445,17 +445,17 @@ uv run [OPTIONS] [COMMAND]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    +
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    -
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    +
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -469,29 +469,29 @@ uv run [OPTIONS] [COMMAND]
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --script, -s

    Run the given path as a Python script.

    +
    --script, -s

    Run the given path as a Python script.

    Using --script will attempt to parse the path as a PEP 723 script, irrespective of its extension.

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    -
    --with with

    Run with the given packages installed.

    +
    --with with

    Run with the given packages installed.

    When used in a project, these dependencies will be layered on top of the project environment in a separate, ephemeral environment. These dependencies are allowed to conflict with those specified by the project.

    -
    --with-editable with-editable

    Run with the given packages installed in editable mode.

    +
    --with-editable with-editable

    Run with the given packages installed in editable mode.

    When used in a project, these dependencies will be layered on top of the project environment in a separate, ephemeral environment. These dependencies are allowed to conflict with those specified by the project.

    -
    --with-requirements with-requirements

    Run with all packages listed in the given requirements.txt files.

    +
    --with-requirements with-requirements

    Run with all packages listed in the given requirements.txt files.

    The same environment semantics as --with apply.

    @@ -519,7 +519,7 @@ uv init [OPTIONS] [PATH]

    Arguments

    -
    PATH

    The path to use for the project/script.

    +
    PATH

    The path to use for the project/script.

    Defaults to the current working directory when initializing an app or library; required when initializing a script. Accepts relative and absolute paths.

    @@ -529,7 +529,7 @@ uv init [OPTIONS] [PATH]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -538,7 +538,7 @@ uv init [OPTIONS] [PATH]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --app

    Create a project for an application.

    +
    --app

    Create a project for an application.

    This is the default behavior if --lib is not requested.

    @@ -546,7 +546,7 @@ uv init [OPTIONS] [PATH]

    By default, an application is not intended to be built and distributed as a Python package. The --package option can be used to create an application that is distributable, e.g., if you want to distribute a command-line interface via PyPI.

    -
    --author-from author-from

    Fill in the authors field in the pyproject.toml.

    +
    --author-from author-from

    Fill in the authors field in the pyproject.toml.

    By default, uv will attempt to infer the author information from some sources (e.g., Git) (auto). Use --author-from git to only infer from Git configuration. Use --author-from none to avoid inferring the author information.

    @@ -559,11 +559,11 @@ uv init [OPTIONS] [PATH]
  • none: Do not infer the author information
    • -
    --bare

    Only create a pyproject.toml.

    +
    --bare

    Only create a pyproject.toml.

    Disables creating extra files like README.md, the src/ tree, .python-version files, etc.

    -
    --build-backend build-backend

    Initialize a build-backend of choice for the project.

    +
    --build-backend build-backend

    Initialize a build-backend of choice for the project.

    Implicitly sets --package.

    @@ -582,14 +582,14 @@ uv init [OPTIONS] [PATH]
  • scikit: Use scikit-build-core as the project build backend
    • -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -602,75 +602,75 @@ uv init [OPTIONS] [PATH]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --description description

    Set the project description

    +
    --description description

    Set the project description

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --lib

    Create a project for a library.

    +
    --lib

    Create a project for a library.

    A library is a project that is intended to be built and distributed as a Python package.

    -
    --name name

    The name of the project.

    +
    --name name

    The name of the project.

    Defaults to the name of the directory.

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-description

    Disable the description for the project

    +
    --no-description

    Disable the description for the project

    -
    --no-package

    Do not set up the project to be built as a Python package.

    +
    --no-package

    Do not set up the project to be built as a Python package.

    Does not include a [build-system] for the project.

    This is the default behavior when using --app.

    -
    --no-pin-python

    Do not create a .python-version file for the project.

    +
    --no-pin-python

    Do not create a .python-version file for the project.

    By default, uv will create a .python-version file containing the minor version of the discovered Python interpreter, which will cause subsequent uv commands to use that version.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-readme

    Do not create a README.md file

    +
    --no-readme

    Do not create a README.md file

    -
    --no-workspace

    Avoid discovering a workspace and create a standalone project.

    +
    --no-workspace

    Avoid discovering a workspace and create a standalone project.

    By default, uv searches for workspaces in the current directory or any parent directory.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --package

    Set up the project to be built as a Python package.

    +
    --package

    Set up the project to be built as a Python package.

    Defines a [build-system] for the project.

    @@ -678,7 +678,7 @@ uv init [OPTIONS] [PATH]

    When using --app, this will include a [project.scripts] entrypoint and use a src/ project structure.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -688,12 +688,12 @@ uv init [OPTIONS] [PATH]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use to determine the minimum supported Python version.

    +
    --python, -p python

    The Python interpreter to use to determine the minimum supported Python version.

    See uv python to view supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -709,9 +709,9 @@ uv init [OPTIONS] [PATH]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --script

    Create a script.

    +
    --script

    Create a script.

    A script is a standalone file with embedded metadata enumerating its dependencies, along with any Python version requirements, as defined in the PEP 723 specification.

    @@ -719,7 +719,7 @@ uv init [OPTIONS] [PATH]

    By default, adds a requirement on the system Python version; use --python to specify an alternative Python version requirement.

    -
    --vcs vcs

    Initialize a version control system for the project.

    +
    --vcs vcs

    Initialize a version control system for the project.

    By default, uv will initialize a Git repository (git). Use --vcs none to explicitly avoid initializing a version control system.

    @@ -730,11 +730,11 @@ uv init [OPTIONS] [PATH]
  • none: Do not use any version control system
    • -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -762,17 +762,17 @@ uv add [OPTIONS] >

    Arguments

    -
    PACKAGES

    The packages to add, as PEP 508 requirements (e.g., ruff==0.5.0)

    +
    PACKAGES

    The packages to add, as PEP 508 requirements (e.g., ruff==0.5.0)

    Options

    -
    --active

    Prefer the active virtual environment over the project’s virtual environment.

    +
    --active

    Prefer the active virtual environment over the project’s virtual environment.

    If the project virtual environment is active or no virtual environment is active, this has no effect.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -781,16 +781,16 @@ uv add [OPTIONS] >

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --branch branch

    Branch to use when adding a dependency from Git

    +
    --branch branch

    Branch to use when adding a dependency from Git

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -803,65 +803,65 @@ uv add [OPTIONS] >
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode

    Compile Python files to bytecode after installation.

    By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

    When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

    May also be set with the UV_COMPILE_BYTECODE environment variable.

    -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --dev

    Add the requirements to the development dependency group.

    +
    --dev

    Add the requirements to the development dependency group.

    This option is an alias for --group dev.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --editable

    Add the requirements as editable

    +
    --editable

    Add the requirements as editable

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra extra

    Extras to enable for the dependency.

    +
    --extra extra

    Extras to enable for the dependency.

    May be provided more than once.

    To add this dependency to an optional extra instead, see --optional.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -875,25 +875,25 @@ uv add [OPTIONS] >
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --frozen

    Add dependencies without re-locking the project.

    +
    --frozen

    Add dependencies without re-locking the project.

    The project environment will not be synced.

    May also be set with the UV_FROZEN environment variable.

    -
    --group group

    Add the requirements to the specified dependency group.

    +
    --group group

    Add the requirements to the specified dependency group.

    These requirements will not be included in the published metadata for the project.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -907,14 +907,14 @@ uv add [OPTIONS] >
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -928,7 +928,7 @@ uv add [OPTIONS] >
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

    @@ -944,77 +944,77 @@ uv add [OPTIONS] >
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --locked

    Assert that the uv.lock will remain unchanged.

    +
    --locked

    Assert that the uv.lock will remain unchanged.

    Requires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.

    May also be set with the UV_LOCKED environment variable.

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --no-sync

    Avoid syncing the virtual environment

    +
    --no-sync

    Avoid syncing the virtual environment

    May also be set with the UV_NO_SYNC environment variable.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --optional optional

    Add the requirements to the package’s optional dependencies for the specified extra.

    +
    --optional optional

    Add the requirements to the package’s optional dependencies for the specified extra.

    The group may then be activated when installing the project with the --extra flag.

    To enable an optional extra for this requirement instead, see --extra.

    -
    --package package

    Add the dependency to a specific package in the workspace

    +
    --package package

    Add the dependency to a specific package in the workspace

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -1032,7 +1032,7 @@ uv add [OPTIONS] >
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -1042,12 +1042,12 @@ uv add [OPTIONS] >

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use for resolving and syncing.

    +
    --python, -p python

    The Python interpreter to use for resolving and syncing.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -1063,23 +1063,23 @@ uv add [OPTIONS] >
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --raw-sources

    Add source requirements to project.dependencies, rather than tool.uv.sources.

    +
    --raw-sources

    Add source requirements to project.dependencies, rather than tool.uv.sources.

    By default, uv will use the tool.uv.sources section to record source information for Git, local, editable, and direct URL requirements.

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    +
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    -
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    +
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    -
    --requirements, -r requirements

    Add all packages listed in the given requirements.txt files

    +
    --requirements, -r requirements

    Add all packages listed in the given requirements.txt files

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -1093,23 +1093,23 @@ uv add [OPTIONS] >
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --rev rev

    Commit to use when adding a dependency from Git

    +
    --rev rev

    Commit to use when adding a dependency from Git

    -
    --script script

    Add the dependency to the specified Python script, rather than to a project.

    +
    --script script

    Add the dependency to the specified Python script, rather than to a project.

    If provided, uv will add the dependency to the script’s inline metadata table, in adherence with PEP 723. If no such inline metadata table is present, a new one will be created and added to the script. When executed via uv run, uv will create a temporary environment for the script with all inline dependencies installed.

    -
    --tag tag

    Tag to use when adding a dependency from Git

    +
    --tag tag

    Tag to use when adding a dependency from Git

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -1137,17 +1137,17 @@ uv remove [OPTIONS] ...

    Arguments

    -
    PACKAGES

    The names of the dependencies to remove (e.g., ruff)

    +
    PACKAGES

    The names of the dependencies to remove (e.g., ruff)

    Options

    -
    --active

    Prefer the active virtual environment over the project’s virtual environment.

    +
    --active

    Prefer the active virtual environment over the project’s virtual environment.

    If the project virtual environment is active or no virtual environment is active, this has no effect.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -1156,14 +1156,14 @@ uv remove [OPTIONS] ...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -1176,57 +1176,57 @@ uv remove [OPTIONS] ...
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode

    Compile Python files to bytecode after installation.

    By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

    When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

    May also be set with the UV_COMPILE_BYTECODE environment variable.

    -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --dev

    Remove the packages from the development dependency group.

    +
    --dev

    Remove the packages from the development dependency group.

    This option is an alias for --group dev.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -1240,23 +1240,23 @@ uv remove [OPTIONS] ...
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --frozen

    Remove dependencies without re-locking the project.

    +
    --frozen

    Remove dependencies without re-locking the project.

    The project environment will not be synced.

    May also be set with the UV_FROZEN environment variable.

    -
    --group group

    Remove the packages from the specified dependency group

    +
    --group group

    Remove the packages from the specified dependency group

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -1270,14 +1270,14 @@ uv remove [OPTIONS] ...
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -1291,7 +1291,7 @@ uv remove [OPTIONS] ...
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

    @@ -1307,73 +1307,73 @@ uv remove [OPTIONS] ...
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --locked

    Assert that the uv.lock will remain unchanged.

    +
    --locked

    Assert that the uv.lock will remain unchanged.

    Requires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.

    May also be set with the UV_LOCKED environment variable.

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --no-sync

    Avoid syncing the virtual environment after re-locking the project

    +
    --no-sync

    Avoid syncing the virtual environment after re-locking the project

    May also be set with the UV_NO_SYNC environment variable.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --optional optional

    Remove the packages from the project’s optional dependencies for the specified extra

    +
    --optional optional

    Remove the packages from the project’s optional dependencies for the specified extra

    -
    --package package

    Remove the dependencies from a specific package in the workspace

    +
    --package package

    Remove the dependencies from a specific package in the workspace

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -1391,7 +1391,7 @@ uv remove [OPTIONS] ...
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -1401,12 +1401,12 @@ uv remove [OPTIONS] ...

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use for resolving and syncing.

    +
    --python, -p python

    The Python interpreter to use for resolving and syncing.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -1422,17 +1422,17 @@ uv remove [OPTIONS] ...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    +
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    -
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    +
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -1446,19 +1446,19 @@ uv remove [OPTIONS] ...
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --script script

    Remove the dependency from the specified Python script, rather than from a project.

    +
    --script script

    Remove the dependency from the specified Python script, rather than from a project.

    If provided, uv will remove the dependency from the script’s inline metadata table, in adherence with PEP 723.

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -1486,27 +1486,27 @@ uv sync [OPTIONS]

    Options

    -
    --active

    Sync dependencies to the active virtual environment.

    +
    --active

    Sync dependencies to the active virtual environment.

    Instead of creating or updating the virtual environment for the project or script, the active virtual environment will be preferred, if the VIRTUAL_ENV environment variable is set.

    -
    --all-extras

    Include all optional dependencies.

    +
    --all-extras

    Include all optional dependencies.

    When two or more extras are declared as conflicting in tool.uv.conflicts, using this flag will always result in an error.

    Note that all optional dependencies are always included in the resolution; this option only affects the selection of packages to install.

    -
    --all-groups

    Include dependencies from all dependency groups.

    +
    --all-groups

    Include dependencies from all dependency groups.

    --no-group can be used to exclude specific groups.

    -
    --all-packages

    Sync all packages in the workspace.

    +
    --all-packages

    Sync all packages in the workspace.

    The workspace’s environment (.venv) is updated to include all workspace members.

    Any extras or groups specified via --extra, --group, or related options will be applied to all workspace members.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -1515,14 +1515,14 @@ uv sync [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -1535,43 +1535,43 @@ uv sync [OPTIONS]
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode

    Compile Python files to bytecode after installation.

    By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

    When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

    May also be set with the UV_COMPILE_BYTECODE environment variable.

    -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --dry-run

    Perform a dry run, without writing the lockfile or modifying the project environment.

    +
    --dry-run

    Perform a dry run, without writing the lockfile or modifying the project environment.

    In dry-run mode, uv will resolve the project’s dependencies and report on the resulting changes to both the lockfile and the project environment, but will not modify either.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra extra

    Include optional dependencies from the specified extra name.

    +
    --extra extra

    Include optional dependencies from the specified extra name.

    May be provided more than once.

    @@ -1579,21 +1579,21 @@ uv sync [OPTIONS]

    Note that all optional dependencies are always included in the resolution; this option only affects the selection of packages to install.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -1607,27 +1607,27 @@ uv sync [OPTIONS]
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --frozen

    Sync without updating the uv.lock file.

    +
    --frozen

    Sync without updating the uv.lock file.

    Instead of checking if the lockfile is up-to-date, uses the versions in the lockfile as the source of truth. If the lockfile is missing, uv will exit with an error. If the pyproject.toml includes changes to dependencies that have not been included in the lockfile yet, they will not be present in the environment.

    May also be set with the UV_FROZEN environment variable.

    -
    --group group

    Include dependencies from the specified dependency group.

    +
    --group group

    Include dependencies from the specified dependency group.

    When multiple extras or groups are specified that appear in tool.uv.conflicts, uv will report an error.

    May be provided multiple times.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -1641,18 +1641,18 @@ uv sync [OPTIONS]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --inexact

    Do not remove extraneous packages present in the environment.

    +
    --inexact

    Do not remove extraneous packages present in the environment.

    When enabled, uv will make the minimum necessary changes to satisfy the requirements. By default, syncing will remove any extraneous packages from the environment

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -1666,7 +1666,7 @@ uv sync [OPTIONS]
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

    @@ -1682,116 +1682,116 @@ uv sync [OPTIONS]
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --locked

    Assert that the uv.lock will remain unchanged.

    +
    --locked

    Assert that the uv.lock will remain unchanged.

    Requires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.

    May also be set with the UV_LOCKED environment variable.

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-default-groups

    Ignore the the default dependency groups.

    +
    --no-default-groups

    Ignore the the default dependency groups.

    uv includes the groups defined in tool.uv.default-groups by default. This disables that option, however, specific groups can still be included with --group.

    -
    --no-dev

    Disable the development dependency group.

    +
    --no-dev

    Disable the development dependency group.

    This option is an alias of --no-group dev. See --no-default-groups to disable all default groups instead.

    -
    --no-editable

    Install any editable dependencies, including the project and any workspace members, as non-editable

    +
    --no-editable

    Install any editable dependencies, including the project and any workspace members, as non-editable

    -
    --no-extra no-extra

    Exclude the specified optional dependencies, if --all-extras is supplied.

    +
    --no-extra no-extra

    Exclude the specified optional dependencies, if --all-extras is supplied.

    May be provided multiple times.

    -
    --no-group no-group

    Disable the specified dependency group.

    +
    --no-group no-group

    Disable the specified dependency group.

    This options always takes precedence over default groups, --all-groups, and --group.

    May be provided multiple times.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-install-package no-install-package

    Do not install the given package(s).

    +
    --no-install-package no-install-package

    Do not install the given package(s).

    By default, all of the project’s dependencies are installed into the environment. The --no-install-package option allows exclusion of specific packages. Note this can result in a broken environment, and should be used with caution.

    -
    --no-install-project

    Do not install the current project.

    +
    --no-install-project

    Do not install the current project.

    By default, the current project is installed into the environment with all of its dependencies. The --no-install-project option allows the project to be excluded, but all of its dependencies are still installed. This is particularly useful in situations like building Docker images where installing the project separately from its dependencies allows optimal layer caching.

    -
    --no-install-workspace

    Do not install any workspace members, including the root project.

    +
    --no-install-workspace

    Do not install any workspace members, including the root project.

    By default, all of the workspace members and their dependencies are installed into the environment. The --no-install-workspace option allows exclusion of all the workspace members while retaining their dependencies. This is particularly useful in situations like building Docker images where installing the workspace separately from its dependencies allows optimal layer caching.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --only-dev

    Only include the development dependency group.

    +
    --only-dev

    Only include the development dependency group.

    The project and its dependencies will be omitted.

    This option is an alias for --only-group dev. Implies --no-default-groups.

    -
    --only-group only-group

    Only include dependencies from the specified dependency group.

    +
    --only-group only-group

    Only include dependencies from the specified dependency group.

    The project and its dependencies will be omitted.

    May be provided multiple times. Implies --no-default-groups.

    -
    --package package

    Sync for a specific package in the workspace.

    +
    --package package

    Sync for a specific package in the workspace.

    The workspace’s environment (.venv) is updated to reflect the subset of dependencies declared by the specified workspace member package.

    If the workspace member does not exist, uv will exit with an error.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -1809,7 +1809,7 @@ uv sync [OPTIONS]
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -1819,7 +1819,7 @@ uv sync [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use for the project environment.

    +
    --python, -p python

    The Python interpreter to use for the project environment.

    By default, the first interpreter that meets the project’s requires-python constraint is used.

    @@ -1828,7 +1828,7 @@ uv sync [OPTIONS]

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -1844,17 +1844,17 @@ uv sync [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    +
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    -
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    +
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -1868,19 +1868,19 @@ uv sync [OPTIONS]
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --script script

    Sync the environment for a Python script, rather than the current project.

    +
    --script script

    Sync the environment for a Python script, rather than the current project.

    If provided, uv will sync the dependencies based on the script’s inline metadata table, in adherence with PEP 723.

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -1900,7 +1900,7 @@ uv lock [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -1909,26 +1909,26 @@ uv lock [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --check

    Check if the lockfile is up-to-date.

    +
    --check

    Check if the lockfile is up-to-date.

    Asserts that the uv.lock would remain unchanged after a resolution. If the lockfile is missing or needs to be updated, uv will exit with an error.

    Equivalent to --locked.

    May also be set with the UV_LOCKED environment variable.

    -
    --check-exists

    Assert that a uv.lock exists without checking if it is up-to-date.

    +
    --check-exists

    Assert that a uv.lock exists without checking if it is up-to-date.

    Equivalent to --frozen.

    May also be set with the UV_FROZEN environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -1941,50 +1941,50 @@ uv lock [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --dry-run

    Perform a dry run, without writing the lockfile.

    +
    --dry-run

    Perform a dry run, without writing the lockfile.

    In dry-run mode, uv will resolve the project’s dependencies and report on the resulting changes, but will not write the lockfile to disk.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -1998,16 +1998,16 @@ uv lock [OPTIONS]
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -2021,14 +2021,14 @@ uv lock [OPTIONS]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -2042,7 +2042,7 @@ uv lock [OPTIONS]
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    This option is only used when building source distributions.

    @@ -2060,61 +2060,61 @@ uv lock [OPTIONS]
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -2132,7 +2132,7 @@ uv lock [OPTIONS]
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -2142,7 +2142,7 @@ uv lock [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use during resolution.

    +
    --python, -p python

    The Python interpreter to use during resolution.

    A Python interpreter is required for building source distributions to determine package metadata when there are not wheels.

    @@ -2151,7 +2151,7 @@ uv lock [OPTIONS]

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -2167,13 +2167,13 @@ uv lock [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -2187,19 +2187,19 @@ uv lock [OPTIONS]
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --script script

    Lock the specified Python script, rather than the current project.

    +
    --script script

    Lock the specified Python script, rather than the current project.

    If provided, uv will lock the script (based on its inline metadata table, in adherence with PEP 723) to a .lock file adjacent to the script itself.

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -2223,19 +2223,19 @@ uv export [OPTIONS]

    Options

    -
    --all-extras

    Include all optional dependencies

    +
    --all-extras

    Include all optional dependencies

    -
    --all-groups

    Include dependencies from all dependency groups.

    +
    --all-groups

    Include dependencies from all dependency groups.

    --no-group can be used to exclude specific groups.

    -
    --all-packages

    Export the entire workspace.

    +
    --all-packages

    Export the entire workspace.

    The dependencies for all workspace members will be included in the exported requirements file.

    Any extras or groups specified via --extra, --group, or related options will be applied to all workspace members.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -2244,14 +2244,14 @@ uv export [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -2264,50 +2264,50 @@ uv export [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra extra

    Include optional dependencies from the specified extra name.

    +
    --extra extra

    Include optional dependencies from the specified extra name.

    May be provided more than once.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -2321,7 +2321,7 @@ uv export [OPTIONS]
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --format format

    The format to which uv.lock should be exported.

    +
    --format format

    The format to which uv.lock should be exported.

    At present, only requirements-txt is supported.

    @@ -2331,25 +2331,25 @@ uv export [OPTIONS]
    • requirements-txt: Export in requirements.txt format
    -
    --frozen

    Do not update the uv.lock before exporting.

    +
    --frozen

    Do not update the uv.lock before exporting.

    If a uv.lock does not exist, uv will exit with an error.

    May also be set with the UV_FROZEN environment variable.

    -
    --group group

    Include dependencies from the specified dependency group.

    +
    --group group

    Include dependencies from the specified dependency group.

    May be provided multiple times.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -2363,14 +2363,14 @@ uv export [OPTIONS]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -2384,7 +2384,7 @@ uv export [OPTIONS]
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    This option is only used when building source distributions.

    @@ -2402,120 +2402,120 @@ uv export [OPTIONS]
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --locked

    Assert that the uv.lock will remain unchanged.

    +
    --locked

    Assert that the uv.lock will remain unchanged.

    Requires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.

    May also be set with the UV_LOCKED environment variable.

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-default-groups

    Ignore the the default dependency groups.

    +
    --no-default-groups

    Ignore the the default dependency groups.

    uv includes the groups defined in tool.uv.default-groups by default. This disables that option, however, specific groups can still be included with --group.

    -
    --no-dev

    Disable the development dependency group.

    +
    --no-dev

    Disable the development dependency group.

    This option is an alias of --no-group dev. See --no-default-groups to disable all default groups instead.

    -
    --no-editable

    Install any editable dependencies, including the project and any workspace members, as non-editable

    +
    --no-editable

    Install any editable dependencies, including the project and any workspace members, as non-editable

    -
    --no-emit-package no-emit-package

    Do not emit the given package(s).

    +
    --no-emit-package no-emit-package

    Do not emit the given package(s).

    By default, all of the project’s dependencies are included in the exported requirements file. The --no-install-package option allows exclusion of specific packages.

    -
    --no-emit-project

    Do not emit the current project.

    +
    --no-emit-project

    Do not emit the current project.

    By default, the current project is included in the exported requirements file with all of its dependencies. The --no-emit-project option allows the project to be excluded, but all of its dependencies to remain included.

    -
    --no-emit-workspace

    Do not emit any workspace members, including the root project.

    +
    --no-emit-workspace

    Do not emit any workspace members, including the root project.

    By default, all workspace members and their dependencies are included in the exported requirements file, with all of their dependencies. The --no-emit-workspace option allows exclusion of all the workspace members while retaining their dependencies.

    -
    --no-extra no-extra

    Exclude the specified optional dependencies, if --all-extras is supplied.

    +
    --no-extra no-extra

    Exclude the specified optional dependencies, if --all-extras is supplied.

    May be provided multiple times.

    -
    --no-group no-group

    Disable the specified dependency group.

    +
    --no-group no-group

    Disable the specified dependency group.

    This options always takes precedence over default groups, --all-groups, and --group.

    May be provided multiple times.

    -
    --no-hashes

    Omit hashes in the generated output

    +
    --no-hashes

    Omit hashes in the generated output

    -
    --no-header

    Exclude the comment header at the top of the generated output file

    +
    --no-header

    Exclude the comment header at the top of the generated output file

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --only-dev

    Only include the development dependency group.

    +
    --only-dev

    Only include the development dependency group.

    The project and its dependencies will be omitted.

    This option is an alias for --only-group dev. Implies --no-default-groups.

    -
    --only-group only-group

    Only include dependencies from the specified dependency group.

    +
    --only-group only-group

    Only include dependencies from the specified dependency group.

    The project and its dependencies will be omitted.

    May be provided multiple times. Implies --no-default-groups.

    -
    --output-file, -o output-file

    Write the exported requirements to the given file

    +
    --output-file, -o output-file

    Write the exported requirements to the given file

    -
    --package package

    Export the dependencies for a specific package in the workspace.

    +
    --package package

    Export the dependencies for a specific package in the workspace.

    If the workspace member does not exist, uv will exit with an error.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -2533,7 +2533,7 @@ uv export [OPTIONS]
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -2543,11 +2543,11 @@ uv export [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --prune prune

    Prune the given package from the dependency tree.

    +
    --prune prune

    Prune the given package from the dependency tree.

    Pruned packages will be excluded from the exported requirements file, as will any dependencies that are no longer required after the pruned package is removed.

    -
    --python, -p python

    The Python interpreter to use during resolution.

    +
    --python, -p python

    The Python interpreter to use during resolution.

    A Python interpreter is required for building source distributions to determine package metadata when there are not wheels.

    @@ -2556,7 +2556,7 @@ uv export [OPTIONS]

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -2572,13 +2572,13 @@ uv export [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -2592,19 +2592,19 @@ uv export [OPTIONS]
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --script script

    Export the dependencies for the specified PEP 723 Python script, rather than the current project.

    +
    --script script

    Export the dependencies for the specified PEP 723 Python script, rather than the current project.

    If provided, uv will resolve the dependencies based on its inline metadata table, in adherence with PEP 723.

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -2620,11 +2620,11 @@ uv tree [OPTIONS]

    Options

    -
    --all-groups

    Include dependencies from all dependency groups.

    +
    --all-groups

    Include dependencies from all dependency groups.

    --no-group can be used to exclude specific groups.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -2633,14 +2633,14 @@ uv tree [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -2653,49 +2653,49 @@ uv tree [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --depth, -d depth

    Maximum display depth of the dependency tree

    +
    --depth, -d depth

    Maximum display depth of the dependency tree

    [default: 255]

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -2709,25 +2709,25 @@ uv tree [OPTIONS]
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --frozen

    Display the requirements without locking the project.

    +
    --frozen

    Display the requirements without locking the project.

    If the lockfile is missing, uv will exit with an error.

    May also be set with the UV_FROZEN environment variable.

    -
    --group group

    Include dependencies from the specified dependency group.

    +
    --group group

    Include dependencies from the specified dependency group.

    May be provided multiple times.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -2741,16 +2741,16 @@ uv tree [OPTIONS]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --invert

    Show the reverse dependencies for the given package. This flag will invert the tree and display the packages that depend on the given package

    +
    --invert

    Show the reverse dependencies for the given package. This flag will invert the tree and display the packages that depend on the given package

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -2764,7 +2764,7 @@ uv tree [OPTIONS]
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    This option is only used when building source distributions.

    @@ -2782,98 +2782,98 @@ uv tree [OPTIONS]
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --locked

    Assert that the uv.lock will remain unchanged.

    +
    --locked

    Assert that the uv.lock will remain unchanged.

    Requires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.

    May also be set with the UV_LOCKED environment variable.

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-dedupe

    Do not de-duplicate repeated dependencies. Usually, when a package has already displayed its dependencies, further occurrences will not re-display its dependencies, and will include a (*) to indicate it has already been shown. This flag will cause those duplicates to be repeated

    +
    --no-dedupe

    Do not de-duplicate repeated dependencies. Usually, when a package has already displayed its dependencies, further occurrences will not re-display its dependencies, and will include a (*) to indicate it has already been shown. This flag will cause those duplicates to be repeated

    -
    --no-default-groups

    Ignore the the default dependency groups.

    +
    --no-default-groups

    Ignore the the default dependency groups.

    uv includes the groups defined in tool.uv.default-groups by default. This disables that option, however, specific groups can still be included with --group.

    -
    --no-dev

    Disable the development dependency group.

    +
    --no-dev

    Disable the development dependency group.

    This option is an alias of --no-group dev. See --no-default-groups to disable all default groups instead.

    -
    --no-group no-group

    Disable the specified dependency group.

    +
    --no-group no-group

    Disable the specified dependency group.

    This options always takes precedence over default groups, --all-groups, and --group.

    May be provided multiple times.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --only-dev

    Only include the development dependency group.

    +
    --only-dev

    Only include the development dependency group.

    The project and its dependencies will be omitted.

    This option is an alias for --only-group dev. Implies --no-default-groups.

    -
    --only-group only-group

    Only include dependencies from the specified dependency group.

    +
    --only-group only-group

    Only include dependencies from the specified dependency group.

    The project and its dependencies will be omitted.

    May be provided multiple times. Implies --no-default-groups.

    -
    --outdated

    Show the latest available version of each package in the tree

    +
    --outdated

    Show the latest available version of each package in the tree

    -
    --package package

    Display only the specified packages

    +
    --package package

    Display only the specified packages

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -2891,7 +2891,7 @@ uv tree [OPTIONS]
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -2901,16 +2901,16 @@ uv tree [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --prune prune

    Prune the given package from the display of the dependency tree

    +
    --prune prune

    Prune the given package from the display of the dependency tree

    -
    --python, -p python

    The Python interpreter to use for locking and filtering.

    +
    --python, -p python

    The Python interpreter to use for locking and filtering.

    By default, the tree is filtered to match the platform as reported by the Python interpreter. Use --universal to display the tree for all platforms, or use --python-version or --python-platform to override a subset of markers.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-platform python-platform

    The platform to use when filtering the tree.

    +
    --python-platform python-platform

    The platform to use when filtering the tree.

    For example, pass --platform windows to display the dependencies that would be included when installing on Windows.

    @@ -2993,7 +2993,7 @@ uv tree [OPTIONS]
  • aarch64-manylinux_2_40: An ARM64 target for the manylinux_2_40 platform
    • -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -3009,15 +3009,15 @@ uv tree [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --python-version python-version

    The Python version to use when filtering the tree.

    +
    --python-version python-version

    The Python version to use when filtering the tree.

    For example, pass --python-version 3.10 to display the dependencies that would be included when installing on Python 3.10.

    Defaults to the version of the discovered Python interpreter.

    -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -3031,25 +3031,25 @@ uv tree [OPTIONS]
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --script script

    Show the dependency tree the specified PEP 723 Python script, rather than the current project.

    +
    --script script

    Show the dependency tree the specified PEP 723 Python script, rather than the current project.

    If provided, uv will resolve the dependencies based on its inline metadata table, in adherence with PEP 723.

    -
    --universal

    Show a platform-independent dependency tree.

    +
    --universal

    Show a platform-independent dependency tree.

    Shows resolved package versions for all Python versions and platforms, rather than filtering to those that are relevant for the current environment.

    Multiple versions may be shown for a each package.

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -3107,7 +3107,7 @@ uv tool run [OPTIONS] [COMMAND]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -3116,14 +3116,14 @@ uv tool run [OPTIONS] [COMMAND]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -3136,53 +3136,53 @@ uv tool run [OPTIONS] [COMMAND]
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode

    Compile Python files to bytecode after installation.

    By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

    When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

    May also be set with the UV_COMPILE_BYTECODE environment variable.

    -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -3196,20 +3196,20 @@ uv tool run [OPTIONS] [COMMAND]
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --from from

    Use the given package to provide the command.

    +
    --from from

    Use the given package to provide the command.

    By default, the package name is assumed to match the command name.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -3223,16 +3223,16 @@ uv tool run [OPTIONS] [COMMAND]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --isolated

    Run the tool in an isolated virtual environment, ignoring any already-installed tools

    +
    --isolated

    Run the tool in an isolated virtual environment, ignoring any already-installed tools

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -3246,7 +3246,7 @@ uv tool run [OPTIONS] [COMMAND]
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

    @@ -3262,61 +3262,61 @@ uv tool run [OPTIONS] [COMMAND]
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -3334,7 +3334,7 @@ uv tool run [OPTIONS] [COMMAND]
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -3344,12 +3344,12 @@ uv tool run [OPTIONS] [COMMAND]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use to build the run environment.

    +
    --python, -p python

    The Python interpreter to use to build the run environment.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -3365,17 +3365,17 @@ uv tool run [OPTIONS] [COMMAND]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    +
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    -
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    +
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -3389,23 +3389,23 @@ uv tool run [OPTIONS] [COMMAND]
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    -
    --with with

    Run with the given packages installed

    +
    --with with

    Run with the given packages installed

    -
    --with-editable with-editable

    Run with the given packages installed in editable mode

    +
    --with-editable with-editable

    Run with the given packages installed in editable mode

    When used in a project, these dependencies will be layered on top of the uv tool’s environment in a separate, ephemeral environment. These dependencies are allowed to conflict with those specified.

    -
    --with-requirements with-requirements

    Run with all packages listed in the given requirements.txt files

    +
    --with-requirements with-requirements

    Run with all packages listed in the given requirements.txt files

    @@ -3425,13 +3425,13 @@ uv tool install [OPTIONS]

    Arguments

    -
    PACKAGE

    The package to install commands from

    +
    PACKAGE

    The package to install commands from

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -3440,14 +3440,14 @@ uv tool install [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -3460,66 +3460,66 @@ uv tool install [OPTIONS]
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode

    Compile Python files to bytecode after installation.

    By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

    When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

    May also be set with the UV_COMPILE_BYTECODE environment variable.

    -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --constraints, -c constraints

    Constrain versions using the given requirements files.

    +
    --constraints, -c constraints

    Constrain versions using the given requirements files.

    Constraints files are requirements.txt-like files that only control the version of a requirement that’s installed. However, including a package in a constraints file will not trigger the installation of that package.

    This is equivalent to pip’s --constraint option.

    May also be set with the UV_CONSTRAINT environment variable.

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --editable, -e

    Install the target package in editable mode, such that changes in the package’s source directory are reflected without reinstallation

    +
    --editable, -e

    Install the target package in editable mode, such that changes in the package’s source directory are reflected without reinstallation

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --force

    Force installation of the tool.

    +
    --force

    Force installation of the tool.

    Will replace any existing entry points with the same name in the executable directory.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -3533,16 +3533,16 @@ uv tool install [OPTIONS]
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -3556,14 +3556,14 @@ uv tool install [OPTIONS]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -3577,7 +3577,7 @@ uv tool install [OPTIONS]
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

    @@ -3593,68 +3593,68 @@ uv tool install [OPTIONS]
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --overrides overrides

    Override versions using the given requirements files.

    +
    --overrides overrides

    Override versions using the given requirements files.

    Overrides files are requirements.txt-like files that force a specific version of a requirement to be installed, regardless of the requirements declared by any constituent package, and regardless of whether this would be considered an invalid resolution.

    While constraints are additive, in that they’re combined with the requirements of the constituent packages, overrides are absolute, in that they completely replace the requirements of the constituent packages.

    May also be set with the UV_OVERRIDE environment variable.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -3672,7 +3672,7 @@ uv tool install [OPTIONS]
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -3682,12 +3682,12 @@ uv tool install [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use to build the tool environment.

    +
    --python, -p python

    The Python interpreter to use to build the tool environment.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -3703,17 +3703,17 @@ uv tool install [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    +
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    -
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    +
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -3727,21 +3727,21 @@ uv tool install [OPTIONS]
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    -
    --with with

    Include the following extra requirements

    +
    --with with

    Include the following extra requirements

    -
    --with-editable with-editable

    Include the given packages in editable mode

    +
    --with-editable with-editable

    Include the given packages in editable mode

    -
    --with-requirements with-requirements

    Run all requirements listed in the given requirements.txt files

    +
    --with-requirements with-requirements

    Run all requirements listed in the given requirements.txt files

    @@ -3761,15 +3761,15 @@ uv tool upgrade [OPTIONS] ...

    Arguments

    -
    NAME

    The name of the tool to upgrade, along with an optional version specifier

    +
    NAME

    The name of the tool to upgrade, along with an optional version specifier

    Options

    -
    --all

    Upgrade all tools

    +
    --all

    Upgrade all tools

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -3778,14 +3778,14 @@ uv tool upgrade [OPTIONS] ...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -3798,53 +3798,53 @@ uv tool upgrade [OPTIONS] ...
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode

    Compile Python files to bytecode after installation.

    By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

    When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

    May also be set with the UV_COMPILE_BYTECODE environment variable.

    -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -3858,16 +3858,16 @@ uv tool upgrade [OPTIONS] ...
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -3881,14 +3881,14 @@ uv tool upgrade [OPTIONS] ...
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -3902,7 +3902,7 @@ uv tool upgrade [OPTIONS] ...
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

    @@ -3918,61 +3918,61 @@ uv tool upgrade [OPTIONS] ...
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -3990,7 +3990,7 @@ uv tool upgrade [OPTIONS] ...
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -4000,12 +4000,12 @@ uv tool upgrade [OPTIONS] ...

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    Upgrade a tool, and specify it to use the given Python interpreter to build its environment. Use with --all to apply to all tools.

    +
    --python, -p python

    Upgrade a tool, and specify it to use the given Python interpreter to build its environment. Use with --all to apply to all tools.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -4021,13 +4021,13 @@ uv tool upgrade [OPTIONS] ...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    +
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    -
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    +
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -4041,11 +4041,11 @@ uv tool upgrade [OPTIONS] ...
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -4061,7 +4061,7 @@ uv tool list [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4070,14 +4070,14 @@ uv tool list [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -4090,45 +4090,45 @@ uv tool list [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -4138,17 +4138,17 @@ uv tool list [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --show-paths

    Whether to display the path to each tool environment and installed executable

    +
    --show-paths

    Whether to display the path to each tool environment and installed executable

    -
    --show-version-specifiers

    Whether to display the version specifier(s) used to install each tool

    +
    --show-version-specifiers

    Whether to display the version specifier(s) used to install each tool

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -4164,15 +4164,15 @@ uv tool uninstall [OPTIONS] ...

    Arguments

    -
    NAME

    The name of the tool to uninstall

    +
    NAME

    The name of the tool to uninstall

    Options

    -
    --all

    Uninstall all tools

    +
    --all

    Uninstall all tools

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4181,14 +4181,14 @@ uv tool uninstall [OPTIONS] ...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -4201,47 +4201,47 @@ uv tool uninstall [OPTIONS] ...
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -4251,7 +4251,7 @@ uv tool uninstall [OPTIONS] ...

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -4267,13 +4267,13 @@ uv tool uninstall [OPTIONS] ...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -4295,7 +4295,7 @@ uv tool update-shell [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4304,14 +4304,14 @@ uv tool update-shell [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -4324,47 +4324,47 @@ uv tool update-shell [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -4374,7 +4374,7 @@ uv tool update-shell [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -4390,13 +4390,13 @@ uv tool update-shell [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -4420,7 +4420,7 @@ uv tool dir [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4429,7 +4429,7 @@ uv tool dir [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --bin

    Show the directory into which uv tool will install executables.

    +
    --bin

    Show the directory into which uv tool will install executables.

    By default, uv tool dir shows the directory into which the tool Python environments themselves are installed, rather than the directory containing the linked executables.

    @@ -4445,14 +4445,14 @@ uv tool dir [OPTIONS]
  • $HOME/.local/bin
    • -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -4465,47 +4465,47 @@ uv tool dir [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -4515,7 +4515,7 @@ uv tool dir [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -4531,13 +4531,13 @@ uv tool dir [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -4625,19 +4625,19 @@ uv python list [OPTIONS]

    Options

    -
    --all-arches

    List Python downloads for all architectures.

    +
    --all-arches

    List Python downloads for all architectures.

    By default, only downloads for the current architecture are shown.

    -
    --all-platforms

    List Python downloads for all platforms.

    +
    --all-platforms

    List Python downloads for all platforms.

    By default, only downloads for the current platform are shown.

    -
    --all-versions

    List all Python versions, including old patch versions.

    +
    --all-versions

    List all Python versions, including old patch versions.

    By default, only the latest patch version is shown for each minor version.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4646,14 +4646,14 @@ uv python list [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -4666,55 +4666,55 @@ uv python list [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --only-downloads

    Only show Python downloads, exclude installed distributions.

    +
    --only-downloads

    Only show Python downloads, exclude installed distributions.

    By default, available downloads for the current platform are shown.

    -
    --only-installed

    Only show installed Python versions, exclude available downloads.

    +
    --only-installed

    Only show installed Python versions, exclude available downloads.

    By default, available downloads for the current platform are shown.

    -
    --output-format output-format

    Select the output format

    +
    --output-format output-format

    Select the output format

    [default: text]

    Possible values:

    @@ -4724,7 +4724,7 @@ uv python list [OPTIONS]
  • json: JSON (for computers)
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -4734,7 +4734,7 @@ uv python list [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -4750,17 +4750,17 @@ uv python list [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --show-urls

    Show the URLs of available Python downloads.

    +
    --show-urls

    Show the URLs of available Python downloads.

    By default, these display as <download available>.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -4786,7 +4786,7 @@ uv python install [OPTIONS] [TARGETS]...

    Arguments

    -
    TARGETS

    The Python version(s) to install.

    +
    TARGETS

    The Python version(s) to install.

    If not provided, the requested Python version(s) will be read from the UV_PYTHON environment variable then .python-versions or .python-version files. If none of the above are present, uv will check if it has installed any Python versions. If not, it will install the latest stable version of Python.

    @@ -4796,7 +4796,7 @@ uv python install [OPTIONS] [TARGETS]...

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4805,14 +4805,14 @@ uv python install [OPTIONS] [TARGETS]...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -4825,12 +4825,12 @@ uv python install [OPTIONS] [TARGETS]...
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --default

    Use as the default Python version.

    +
    --default

    Use as the default Python version.

    By default, only a python{major}.{minor} executable is installed, e.g., python3.10. When the --default flag is used, python{major}, e.g., python3, and python executables are also installed.

    @@ -4838,62 +4838,62 @@ uv python install [OPTIONS] [TARGETS]...

    If multiple Python versions are requested, uv will exit with an error.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --force, -f

    Replace existing Python executables during installation.

    +
    --force, -f

    Replace existing Python executables during installation.

    By default, uv will refuse to replace executables that it does not manage.

    Implies --reinstall.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --install-dir, -i install-dir

    The directory to store the Python installation in.

    +
    --install-dir, -i install-dir

    The directory to store the Python installation in.

    If provided, UV_PYTHON_INSTALL_DIR will need to be set for subsequent operations for uv to discover the Python installation.

    See uv python dir to view the current Python installation directory. Defaults to ~/.local/share/uv/python.

    May also be set with the UV_PYTHON_INSTALL_DIR environment variable.

    -
    --mirror mirror

    Set the URL to use as the source for downloading Python installations.

    +
    --mirror mirror

    Set the URL to use as the source for downloading Python installations.

    The provided URL will replace https://github.com/astral-sh/python-build-standalone/releases/download in, e.g., https://github.com/astral-sh/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gz.

    Distributions can be read from a local directory by using the file:// URL scheme.

    May also be set with the UV_PYTHON_INSTALL_MIRROR environment variable.

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -4903,14 +4903,14 @@ uv python install [OPTIONS] [TARGETS]...

    This setting has no effect when used in the uv pip interface.

    -
    --pypy-mirror pypy-mirror

    Set the URL to use as the source for downloading PyPy installations.

    +
    --pypy-mirror pypy-mirror

    Set the URL to use as the source for downloading PyPy installations.

    The provided URL will replace https://downloads.python.org/pypy in, e.g., https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2.

    Distributions can be read from a local directory by using the file:// URL scheme.

    May also be set with the UV_PYPY_INSTALL_MIRROR environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -4926,17 +4926,17 @@ uv python install [OPTIONS] [TARGETS]...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --reinstall, -r

    Reinstall the requested Python version, if it’s already installed.

    +
    --reinstall, -r

    Reinstall the requested Python version, if it’s already installed.

    By default, uv will exit successfully if the version is already installed.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -4956,7 +4956,7 @@ uv python find [OPTIONS] [REQUEST]

    Arguments

    -
    REQUEST

    The Python request.

    +
    REQUEST

    The Python request.

    See uv python to view supported request formats.

    @@ -4964,7 +4964,7 @@ uv python find [OPTIONS] [REQUEST]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4973,14 +4973,14 @@ uv python find [OPTIONS] [REQUEST]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -4993,51 +4993,51 @@ uv python find [OPTIONS] [REQUEST]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-project

    Avoid discovering a project or workspace.

    +
    --no-project

    Avoid discovering a project or workspace.

    Otherwise, when no request is provided, the Python requirement of a project in the current directory or parent directories will be used.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -5047,7 +5047,7 @@ uv python find [OPTIONS] [REQUEST]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -5063,20 +5063,20 @@ uv python find [OPTIONS] [REQUEST]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --system

    Only find system Python interpreters.

    +
    --system

    Only find system Python interpreters.

    By default, uv will report the first Python interpreter it would use, including those in an active virtual environment or a virtual environment in the current working directory or any parent directory.

    The --system option instructs uv to skip virtual environment Python interpreters and restrict its search to the system path.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -5098,7 +5098,7 @@ uv python pin [OPTIONS] [REQUEST]

    Arguments

    -
    REQUEST

    The Python version request.

    +
    REQUEST

    The Python version request.

    uv supports more formats than other tools that read .python-version files, i.e., pyenv. If compatibility with those tools is needed, only use version numbers instead of complex requests such as cpython@3.10.

    @@ -5110,7 +5110,7 @@ uv python pin [OPTIONS] [REQUEST]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -5119,14 +5119,14 @@ uv python pin [OPTIONS] [REQUEST]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -5139,51 +5139,51 @@ uv python pin [OPTIONS] [REQUEST]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-project

    Avoid validating the Python pin is compatible with the project or workspace.

    +
    --no-project

    Avoid validating the Python pin is compatible with the project or workspace.

    By default, a project or workspace is discovered in the current directory or any parent directory. If a workspace is found, the Python pin is validated against the workspace’s requires-python constraint.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -5193,7 +5193,7 @@ uv python pin [OPTIONS] [REQUEST]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -5209,19 +5209,19 @@ uv python pin [OPTIONS] [REQUEST]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --resolved

    Write the resolved Python interpreter path instead of the request.

    +
    --resolved

    Write the resolved Python interpreter path instead of the request.

    Ensures that the exact same interpreter is used.

    This option is usually not safe to use when committing the .python-version file to version control.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -5243,7 +5243,7 @@ uv python dir [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -5252,7 +5252,7 @@ uv python dir [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --bin

    Show the directory into which uv python will install Python executables.

    +
    --bin

    Show the directory into which uv python will install Python executables.

    Note that this directory is only used when installing Python with preview mode enabled.

    @@ -5268,14 +5268,14 @@ uv python dir [OPTIONS]
  • $HOME/.local/bin
    • -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -5288,47 +5288,47 @@ uv python dir [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -5338,7 +5338,7 @@ uv python dir [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -5354,13 +5354,13 @@ uv python dir [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -5376,7 +5376,7 @@ uv python uninstall [OPTIONS] ...

    Arguments

    -
    TARGETS

    The Python version(s) to uninstall.

    +
    TARGETS

    The Python version(s) to uninstall.

    See uv python to view supported request formats.

    @@ -5384,9 +5384,9 @@ uv python uninstall [OPTIONS] ...

    Options

    -
    --all

    Uninstall all managed Python versions

    +
    --all

    Uninstall all managed Python versions

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -5395,14 +5395,14 @@ uv python uninstall [OPTIONS] ...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -5415,50 +5415,50 @@ uv python uninstall [OPTIONS] ...
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --install-dir, -i install-dir

    The directory where the Python was installed

    +
    --install-dir, -i install-dir

    The directory where the Python was installed

    May also be set with the UV_PYTHON_INSTALL_DIR environment variable.

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -5468,7 +5468,7 @@ uv python uninstall [OPTIONS] ...

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -5484,13 +5484,13 @@ uv python uninstall [OPTIONS] ...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -5538,7 +5538,7 @@ uv pip compile [OPTIONS] ...

    Arguments

    -
    SRC_FILE

    Include all packages listed in the given requirements.in files.

    +
    SRC_FILE

    Include all packages listed in the given requirements.in files.

    If a pyproject.toml, setup.py, or setup.cfg file is provided, uv will extract the requirements for the relevant project.

    @@ -5550,11 +5550,11 @@ uv pip compile [OPTIONS] ...

    Options

    -
    --all-extras

    Include all optional dependencies.

    +
    --all-extras

    Include all optional dependencies.

    Only applies to pyproject.toml, setup.py, and setup.cfg sources.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -5563,7 +5563,7 @@ uv pip compile [OPTIONS] ...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --annotation-style annotation-style

    The style of the annotation comments included in the output file, used to indicate the source of each package.

    +
    --annotation-style annotation-style

    The style of the annotation comments included in the output file, used to indicate the source of each package.

    Defaults to split.

    @@ -5574,19 +5574,19 @@ uv pip compile [OPTIONS] ...
  • split: Render each annotation on its own line
    • -
    --build-constraints, -b build-constraints

    Constrain build dependencies using the given requirements files when building source distributions.

    +
    --build-constraints, -b build-constraints

    Constrain build dependencies using the given requirements files when building source distributions.

    Constraints files are requirements.txt-like files that only control the version of a requirement that’s installed. However, including a package in a constraints file will not trigger the installation of that package.

    May also be set with the UV_BUILD_CONSTRAINT environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -5599,70 +5599,70 @@ uv pip compile [OPTIONS] ...
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --constraints, -c constraints

    Constrain versions using the given requirements files.

    +
    --constraints, -c constraints

    Constrain versions using the given requirements files.

    Constraints files are requirements.txt-like files that only control the version of a requirement that’s installed. However, including a package in a constraints file will not trigger the installation of that package.

    This is equivalent to pip’s --constraint option.

    May also be set with the UV_CONSTRAINT environment variable.

    -
    --custom-compile-command custom-compile-command

    The header comment to include at the top of the output file generated by uv pip compile.

    +
    --custom-compile-command custom-compile-command

    The header comment to include at the top of the output file generated by uv pip compile.

    Used to reflect custom build scripts and commands that wrap uv pip compile.

    May also be set with the UV_CUSTOM_COMPILE_COMMAND environment variable.

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --emit-build-options

    Include --no-binary and --only-binary entries in the generated output file

    +
    --emit-build-options

    Include --no-binary and --only-binary entries in the generated output file

    -
    --emit-find-links

    Include --find-links entries in the generated output file

    +
    --emit-find-links

    Include --find-links entries in the generated output file

    -
    --emit-index-annotation

    Include comment annotations indicating the index used to resolve each package (e.g., # from https://pypi.org/simple)

    +
    --emit-index-annotation

    Include comment annotations indicating the index used to resolve each package (e.g., # from https://pypi.org/simple)

    -
    --emit-index-url

    Include --index-url and --extra-index-url entries in the generated output file

    +
    --emit-index-url

    Include --index-url and --extra-index-url entries in the generated output file

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra extra

    Include optional dependencies from the specified extra name; may be provided more than once.

    +
    --extra extra

    Include optional dependencies from the specified extra name; may be provided more than once.

    Only applies to pyproject.toml, setup.py, and setup.cfg sources.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -5676,18 +5676,18 @@ uv pip compile [OPTIONS] ...
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --generate-hashes

    Include distribution hashes in the output file

    +
    --generate-hashes

    Include distribution hashes in the output file

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -5701,14 +5701,14 @@ uv pip compile [OPTIONS] ...
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -5722,7 +5722,7 @@ uv pip compile [OPTIONS] ...
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    This option is only used when building source distributions.

    @@ -5740,87 +5740,87 @@ uv pip compile [OPTIONS] ...
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-annotate

    Exclude comment annotations indicating the source of each package

    +
    --no-annotate

    Exclude comment annotations indicating the source of each package

    -
    --no-binary no-binary

    Don’t install pre-built wheels.

    +
    --no-binary no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    Multiple packages may be provided. Disable binaries for all packages with :all:. Clear previously specified packages with :none:.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    Alias for --only-binary :all:.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-deps

    Ignore package dependencies, instead only add those packages explicitly listed on the command line to the resulting requirements file

    +
    --no-deps

    Ignore package dependencies, instead only add those packages explicitly listed on the command line to the resulting requirements file

    -
    --no-emit-package no-emit-package

    Specify a package to omit from the output resolution. Its dependencies will still be included in the resolution. Equivalent to pip-compile’s --unsafe-package option

    +
    --no-emit-package no-emit-package

    Specify a package to omit from the output resolution. Its dependencies will still be included in the resolution. Equivalent to pip-compile’s --unsafe-package option

    -
    --no-header

    Exclude the comment header at the top of the generated output file

    +
    --no-header

    Exclude the comment header at the top of the generated output file

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --no-strip-extras

    Include extras in the output file.

    +
    --no-strip-extras

    Include extras in the output file.

    By default, uv strips extras, as any packages pulled in by the extras are already included as dependencies in the output file directly. Further, output files generated with --no-strip-extras cannot be used as constraints files in install and sync invocations.

    -
    --no-strip-markers

    Include environment markers in the output file.

    +
    --no-strip-markers

    Include environment markers in the output file.

    By default, uv strips environment markers, as the resolution generated by compile is only guaranteed to be correct for the target environment.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --only-binary only-binary

    Only use pre-built wheels; don’t build source distributions.

    +
    --only-binary only-binary

    Only use pre-built wheels; don’t build source distributions.

    When enabled, resolving will not run code from the given packages. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    Multiple packages may be provided. Disable binaries for all packages with :all:. Clear previously specified packages with :none:.

    -
    --output-file, -o output-file

    Write the compiled requirements to the given requirements.txt file.

    +
    --output-file, -o output-file

    Write the compiled requirements to the given requirements.txt file.

    If the file already exists, the existing versions will be preferred when resolving dependencies, unless --upgrade is also specified.

    -
    --overrides overrides

    Override versions using the given requirements files.

    +
    --overrides overrides

    Override versions using the given requirements files.

    Overrides files are requirements.txt-like files that force a specific version of a requirement to be installed, regardless of the requirements declared by any constituent package, and regardless of whether this would be considered an invalid resolution.

    While constraints are additive, in that they’re combined with the requirements of the constituent packages, overrides are absolute, in that they completely replace the requirements of the constituent packages.

    May also be set with the UV_OVERRIDE environment variable.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -5838,7 +5838,7 @@ uv pip compile [OPTIONS] ...
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -5848,7 +5848,7 @@ uv pip compile [OPTIONS] ...

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use during resolution.

    +
    --python, -p python

    The Python interpreter to use during resolution.

    A Python interpreter is required for building source distributions to determine package metadata when there are not wheels.

    @@ -5858,7 +5858,7 @@ uv pip compile [OPTIONS] ...

    See uv python for details on Python discovery and supported request formats.

    -
    --python-platform python-platform

    The platform for which requirements should be resolved.

    +
    --python-platform python-platform

    The platform for which requirements should be resolved.

    Represented as a "target triple", a string that describes the target platform in terms of its CPU, vendor, and operating system name, like x86_64-unknown-linux-gnu or aarch64-apple-darwin.

    @@ -5941,7 +5941,7 @@ uv pip compile [OPTIONS] ...
  • aarch64-manylinux_2_40: An ARM64 target for the manylinux_2_40 platform
    • -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -5957,7 +5957,7 @@ uv pip compile [OPTIONS] ...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --python-version python-version

    The Python version to use for resolution.

    +
    --python-version python-version

    The Python version to use for resolution.

    For example, 3.8 or 3.8.17.

    @@ -5967,13 +5967,13 @@ uv pip compile [OPTIONS] ...

    If a patch version is omitted, the minimum patch version is assumed. For example, 3.8 is mapped to 3.8.0.

    -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -5987,26 +5987,26 @@ uv pip compile [OPTIONS] ...
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --system

    Install packages into the system Python environment.

    +
    --system

    Install packages into the system Python environment.

    By default, uv uses the virtual environment in the current working directory or any parent directory, falling back to searching for a Python executable in PATH. The --system option instructs uv to avoid using a virtual environment Python and restrict its search to the system path.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --universal

    Perform a universal resolution, attempting to generate a single requirements.txt output file that is compatible with all operating systems, architectures, and Python implementations.

    +
    --universal

    Perform a universal resolution, attempting to generate a single requirements.txt output file that is compatible with all operating systems, architectures, and Python implementations.

    In universal mode, the current Python version (or user-provided --python-version) will be treated as a lower bound. For example, --universal --python-version 3.7 would produce a universal resolution for Python 3.7 and later.

    Implies --no-strip-markers.

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -6022,7 +6022,7 @@ uv pip sync [OPTIONS] ...

    Arguments

    -
    SRC_FILE

    Include all packages listed in the given requirements.txt files.

    +
    SRC_FILE

    Include all packages listed in the given requirements.txt files.

    If a pyproject.toml, setup.py, or setup.cfg file is provided, uv will extract the requirements for the relevant project.

    @@ -6032,9 +6032,9 @@ uv pip sync [OPTIONS] ...

    Options

    -
    --allow-empty-requirements

    Allow sync of empty requirements, which will clear the environment of all packages

    +
    --allow-empty-requirements

    Allow sync of empty requirements, which will clear the environment of all packages

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -6043,24 +6043,24 @@ uv pip sync [OPTIONS] ...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --break-system-packages

    Allow uv to modify an EXTERNALLY-MANAGED Python installation.

    +
    --break-system-packages

    Allow uv to modify an EXTERNALLY-MANAGED Python installation.

    WARNING: --break-system-packages is intended for use in continuous integration (CI) environments, when installing into Python installations that are managed by an external package manager, like apt. It should be used with caution, as such Python installations explicitly recommend against modifications by other package managers (like uv or pip).

    May also be set with the UV_BREAK_SYSTEM_PACKAGES environment variable.

    -
    --build-constraints, -b build-constraints

    Constrain build dependencies using the given requirements files when building source distributions.

    +
    --build-constraints, -b build-constraints

    Constrain build dependencies using the given requirements files when building source distributions.

    Constraints files are requirements.txt-like files that only control the version of a requirement that’s installed. However, including a package in a constraints file will not trigger the installation of that package.

    May also be set with the UV_BUILD_CONSTRAINT environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -6073,71 +6073,71 @@ uv pip sync [OPTIONS] ...
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode

    Compile Python files to bytecode after installation.

    By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

    When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

    May also be set with the UV_COMPILE_BYTECODE environment variable.

    -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --constraints, -c constraints

    Constrain versions using the given requirements files.

    +
    --constraints, -c constraints

    Constrain versions using the given requirements files.

    Constraints files are requirements.txt-like files that only control the version of a requirement that’s installed. However, including a package in a constraints file will not trigger the installation of that package.

    This is equivalent to pip’s --constraint option.

    May also be set with the UV_CONSTRAINT environment variable.

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --dry-run

    Perform a dry run, i.e., don’t actually install anything but resolve the dependencies and print the resulting plan

    +
    --dry-run

    Perform a dry run, i.e., don’t actually install anything but resolve the dependencies and print the resulting plan

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -6151,14 +6151,14 @@ uv pip sync [OPTIONS] ...
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -6172,7 +6172,7 @@ uv pip sync [OPTIONS] ...
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

    @@ -6188,65 +6188,65 @@ uv pip sync [OPTIONS] ...
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-allow-empty-requirements
    --no-binary no-binary

    Don’t install pre-built wheels.

    +
    --no-allow-empty-requirements
    --no-binary no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    Multiple packages may be provided. Disable binaries for all packages with :all:. Clear previously specified packages with :none:.

    -
    --no-break-system-packages
    --no-build

    Don’t build source distributions.

    +
    --no-break-system-packages
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    Alias for --only-binary :all:.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --no-verify-hashes

    Disable validation of hashes in the requirements file.

    +
    --no-verify-hashes

    Disable validation of hashes in the requirements file.

    By default, uv will verify any available hashes in the requirements file, but will not require that all requirements have an associated hash. To enforce hash validation, use --require-hashes.

    May also be set with the UV_NO_VERIFY_HASHES environment variable.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --only-binary only-binary

    Only use pre-built wheels; don’t build source distributions.

    +
    --only-binary only-binary

    Only use pre-built wheels; don’t build source distributions.

    When enabled, resolving will not run code from the given packages. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    Multiple packages may be provided. Disable binaries for all packages with :all:. Clear previously specified packages with :none:.

    -
    --prefix prefix

    Install packages into lib, bin, and other top-level folders under the specified directory, as if a virtual environment were present at that location.

    +
    --prefix prefix

    Install packages into lib, bin, and other top-level folders under the specified directory, as if a virtual environment were present at that location.

    In general, prefer the use of --python to install into an alternate environment, as scripts and other artifacts installed via --prefix will reference the installing interpreter, rather than any interpreter added to the --prefix directory, rendering them non-portable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -6256,14 +6256,14 @@ uv pip sync [OPTIONS] ...

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter into which packages should be installed.

    +
    --python, -p python

    The Python interpreter into which packages should be installed.

    By default, syncing requires a virtual environment. A path to an alternative Python can be provided, but it is only recommended in continuous integration (CI) environments and should be used with caution, as it can modify the system Python installation.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-platform python-platform

    The platform for which requirements should be installed.

    +
    --python-platform python-platform

    The platform for which requirements should be installed.

    Represented as a "target triple", a string that describes the target platform in terms of its CPU, vendor, and operating system name, like x86_64-unknown-linux-gnu or aarch64-apple-darwin.

    @@ -6348,7 +6348,7 @@ uv pip sync [OPTIONS] ...
  • aarch64-manylinux_2_40: An ARM64 target for the manylinux_2_40 platform
    • -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -6364,21 +6364,21 @@ uv pip sync [OPTIONS] ...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --python-version python-version

    The minimum Python version that should be supported by the requirements (e.g., 3.7 or 3.7.9).

    +
    --python-version python-version

    The minimum Python version that should be supported by the requirements (e.g., 3.7 or 3.7.9).

    If a patch version is omitted, the minimum patch version is assumed. For example, 3.7 is mapped to 3.7.0.

    -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    +
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    -
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    +
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    -
    --require-hashes

    Require a matching hash for each requirement.

    +
    --require-hashes

    Require a matching hash for each requirement.

    By default, uv will verify any available hashes in the requirements file, but will not require that all requirements have an associated hash.

    @@ -6391,22 +6391,22 @@ uv pip sync [OPTIONS] ...

    May also be set with the UV_REQUIRE_HASHES environment variable.

    -
    --strict

    Validate the Python environment after completing the installation, to detect packages with missing dependencies or other issues

    +
    --strict

    Validate the Python environment after completing the installation, to detect packages with missing dependencies or other issues

    -
    --system

    Install packages into the system Python environment.

    +
    --system

    Install packages into the system Python environment.

    By default, uv installs into the virtual environment in the current working directory or any parent directory. The --system option instructs uv to instead use the first Python found in the system PATH.

    WARNING: --system is intended for use in continuous integration (CI) environments and should be used with caution, as it can modify the system Python installation.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --target target

    Install packages into the specified directory, rather than into the virtual or system Python environment. The packages will be installed at the top-level of the directory

    +
    --target target

    Install packages into the specified directory, rather than into the virtual or system Python environment. The packages will be installed at the top-level of the directory

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -6422,7 +6422,7 @@ uv pip install [OPTIONS] |--editable Arguments -
    PACKAGE

    Install all listed packages.

    +
    PACKAGE

    Install all listed packages.

    The order of the packages is used to determine priority during resolution.

    @@ -6430,11 +6430,11 @@ uv pip install [OPTIONS] |--editable Options -
    --all-extras

    Include all optional dependencies.

    +
    --all-extras

    Include all optional dependencies.

    Only applies to pyproject.toml, setup.py, and setup.cfg sources.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -6443,24 +6443,24 @@ uv pip install [OPTIONS] |--editable WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --break-system-packages

    Allow uv to modify an EXTERNALLY-MANAGED Python installation.

    +
    --break-system-packages

    Allow uv to modify an EXTERNALLY-MANAGED Python installation.

    WARNING: --break-system-packages is intended for use in continuous integration (CI) environments, when installing into Python installations that are managed by an external package manager, like apt. It should be used with caution, as such Python installations explicitly recommend against modifications by other package managers (like uv or pip).

    May also be set with the UV_BREAK_SYSTEM_PACKAGES environment variable.

    -
    --build-constraints, -b build-constraints

    Constrain build dependencies using the given requirements files when building source distributions.

    +
    --build-constraints, -b build-constraints

    Constrain build dependencies using the given requirements files when building source distributions.

    Constraints files are requirements.txt-like files that only control the version of a requirement that’s installed. However, including a package in a constraints file will not trigger the installation of that package.

    May also be set with the UV_BUILD_CONSTRAINT environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -6473,72 +6473,72 @@ uv pip install [OPTIONS] |--editable never: Disables colored output -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode

    Compile Python files to bytecode after installation.

    By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

    When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

    May also be set with the UV_COMPILE_BYTECODE environment variable.

    -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --constraints, -c constraints

    Constrain versions using the given requirements files.

    +
    --constraints, -c constraints

    Constrain versions using the given requirements files.

    Constraints files are requirements.txt-like files that only control the version of a requirement that’s installed. However, including a package in a constraints file will not trigger the installation of that package.

    This is equivalent to pip’s --constraint option.

    May also be set with the UV_CONSTRAINT environment variable.

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --dry-run

    Perform a dry run, i.e., don’t actually install anything but resolve the dependencies and print the resulting plan

    +
    --dry-run

    Perform a dry run, i.e., don’t actually install anything but resolve the dependencies and print the resulting plan

    -
    --editable, -e editable

    Install the editable package based on the provided local file path

    +
    --editable, -e editable

    Install the editable package based on the provided local file path

    -
    --exact

    Perform an exact sync, removing extraneous packages.

    +
    --exact

    Perform an exact sync, removing extraneous packages.

    By default, installing will make the minimum necessary changes to satisfy the requirements. When enabled, uv will update the environment to exactly match the requirements, removing packages that are not included in the requirements.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra extra

    Include optional dependencies from the specified extra name; may be provided more than once.

    +
    --extra extra

    Include optional dependencies from the specified extra name; may be provided more than once.

    Only applies to pyproject.toml, setup.py, and setup.cfg sources.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -6552,16 +6552,16 @@ uv pip install [OPTIONS] |--editable requires-python: Optimize for selecting latest supported version of each package, for each supported Python version -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -6575,14 +6575,14 @@ uv pip install [OPTIONS] |--editable unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -6596,7 +6596,7 @@ uv pip install [OPTIONS] |--editable subprocess: Use the keyring command for credential lookup -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

    @@ -6612,83 +6612,83 @@ uv pip install [OPTIONS] |--editable symlink: Symbolically link packages from the wheel into the site-packages directory -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary no-binary

    Don’t install pre-built wheels.

    +
    --no-binary no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    Multiple packages may be provided. Disable binaries for all packages with :all:. Clear previously specified packages with :none:.

    -
    --no-break-system-packages
    --no-build

    Don’t build source distributions.

    +
    --no-break-system-packages
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    Alias for --only-binary :all:.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-deps

    Ignore package dependencies, instead only installing those packages explicitly listed on the command line or in the requirements files

    +
    --no-deps

    Ignore package dependencies, instead only installing those packages explicitly listed on the command line or in the requirements files

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --no-verify-hashes

    Disable validation of hashes in the requirements file.

    +
    --no-verify-hashes

    Disable validation of hashes in the requirements file.

    By default, uv will verify any available hashes in the requirements file, but will not require that all requirements have an associated hash. To enforce hash validation, use --require-hashes.

    May also be set with the UV_NO_VERIFY_HASHES environment variable.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --only-binary only-binary

    Only use pre-built wheels; don’t build source distributions.

    +
    --only-binary only-binary

    Only use pre-built wheels; don’t build source distributions.

    When enabled, resolving will not run code from the given packages. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    Multiple packages may be provided. Disable binaries for all packages with :all:. Clear previously specified packages with :none:.

    -
    --overrides overrides

    Override versions using the given requirements files.

    +
    --overrides overrides

    Override versions using the given requirements files.

    Overrides files are requirements.txt-like files that force a specific version of a requirement to be installed, regardless of the requirements declared by any constituent package, and regardless of whether this would be considered an invalid resolution.

    While constraints are additive, in that they’re combined with the requirements of the constituent packages, overrides are absolute, in that they completely replace the requirements of the constituent packages.

    May also be set with the UV_OVERRIDE environment variable.

    -
    --prefix prefix

    Install packages into lib, bin, and other top-level folders under the specified directory, as if a virtual environment were present at that location.

    +
    --prefix prefix

    Install packages into lib, bin, and other top-level folders under the specified directory, as if a virtual environment were present at that location.

    In general, prefer the use of --python to install into an alternate environment, as scripts and other artifacts installed via --prefix will reference the installing interpreter, rather than any interpreter added to the --prefix directory, rendering them non-portable.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -6706,7 +6706,7 @@ uv pip install [OPTIONS] |--editable if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -6716,14 +6716,14 @@ uv pip install [OPTIONS] |--editable This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter into which packages should be installed.

    +
    --python, -p python

    The Python interpreter into which packages should be installed.

    By default, installation requires a virtual environment. A path to an alternative Python can be provided, but it is only recommended in continuous integration (CI) environments and should be used with caution, as it can modify the system Python installation.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-platform python-platform

    The platform for which requirements should be installed.

    +
    --python-platform python-platform

    The platform for which requirements should be installed.

    Represented as a "target triple", a string that describes the target platform in terms of its CPU, vendor, and operating system name, like x86_64-unknown-linux-gnu or aarch64-apple-darwin.

    @@ -6808,7 +6808,7 @@ uv pip install [OPTIONS] |--editable aarch64-manylinux_2_40: An ARM64 target for the manylinux_2_40 platform -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -6824,21 +6824,21 @@ uv pip install [OPTIONS] |--editable only-system: Only use system Python installations; never use managed Python installations -
    --python-version python-version

    The minimum Python version that should be supported by the requirements (e.g., 3.7 or 3.7.9).

    +
    --python-version python-version

    The minimum Python version that should be supported by the requirements (e.g., 3.7 or 3.7.9).

    If a patch version is omitted, the minimum patch version is assumed. For example, 3.7 is mapped to 3.7.0.

    -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    +
    --reinstall

    Reinstall all packages, regardless of whether they’re already installed. Implies --refresh

    -
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    +
    --reinstall-package reinstall-package

    Reinstall a specific package, regardless of whether it’s already installed. Implies --refresh-package

    -
    --require-hashes

    Require a matching hash for each requirement.

    +
    --require-hashes

    Require a matching hash for each requirement.

    By default, uv will verify any available hashes in the requirements file, but will not require that all requirements have an associated hash.

    @@ -6851,13 +6851,13 @@ uv pip install [OPTIONS] |--editable

    May also be set with the UV_REQUIRE_HASHES environment variable.

    -
    --requirements, -r requirements

    Install all packages listed in the given requirements.txt files.

    +
    --requirements, -r requirements

    Install all packages listed in the given requirements.txt files.

    If a pyproject.toml, setup.py, or setup.cfg file is provided, uv will extract the requirements for the relevant project.

    If - is provided, then requirements will be read from stdin.

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -6871,26 +6871,26 @@ uv pip install [OPTIONS] |--editable lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies -
    --strict

    Validate the Python environment after completing the installation, to detect packages with missing dependencies or other issues

    +
    --strict

    Validate the Python environment after completing the installation, to detect packages with missing dependencies or other issues

    -
    --system

    Install packages into the system Python environment.

    +
    --system

    Install packages into the system Python environment.

    By default, uv installs into the virtual environment in the current working directory or any parent directory. The --system option instructs uv to instead use the first Python found in the system PATH.

    WARNING: --system is intended for use in continuous integration (CI) environments and should be used with caution, as it can modify the system Python installation.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --target target

    Install packages into the specified directory, rather than into the virtual or system Python environment. The packages will be installed at the top-level of the directory

    +
    --target target

    Install packages into the specified directory, rather than into the virtual or system Python environment. The packages will be installed at the top-level of the directory

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --user
    --verbose, -v

    Use verbose output.

    +
    --user
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -6906,13 +6906,13 @@ uv pip uninstall [OPTIONS] >

    Arguments

    -
    PACKAGE

    Uninstall all listed packages

    +
    PACKAGE

    Uninstall all listed packages

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -6921,19 +6921,19 @@ uv pip uninstall [OPTIONS] >

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --break-system-packages

    Allow uv to modify an EXTERNALLY-MANAGED Python installation.

    +
    --break-system-packages

    Allow uv to modify an EXTERNALLY-MANAGED Python installation.

    WARNING: --break-system-packages is intended for use in continuous integration (CI) environments, when installing into Python installations that are managed by an external package manager, like apt. It should be used with caution, as such Python installations explicitly recommend against modifications by other package managers (like uv or pip).

    May also be set with the UV_BREAK_SYSTEM_PACKAGES environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -6946,22 +6946,22 @@ uv pip uninstall [OPTIONS] >
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --dry-run

    Perform a dry run, i.e., don’t actually uninstall anything but print the resulting plan

    +
    --dry-run

    Perform a dry run, i.e., don’t actually uninstall anything but print the resulting plan

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for remote requirements files.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for remote requirements files.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -6975,36 +6975,36 @@ uv pip uninstall [OPTIONS] >
  • subprocess: Use the keyring command for credential lookup
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-break-system-packages
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-break-system-packages
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --prefix prefix

    Uninstall packages from the specified --prefix directory

    +
    --prefix prefix

    Uninstall packages from the specified --prefix directory

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -7014,14 +7014,14 @@ uv pip uninstall [OPTIONS] >

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter from which packages should be uninstalled.

    +
    --python, -p python

    The Python interpreter from which packages should be uninstalled.

    By default, uninstallation requires a virtual environment. A path to an alternative Python can be provided, but it is only recommended in continuous integration (CI) environments and should be used with caution, as it can modify the system Python installation.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -7037,24 +7037,24 @@ uv pip uninstall [OPTIONS] >
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --requirements, -r requirements

    Uninstall all packages listed in the given requirements files

    +
    --requirements, -r requirements

    Uninstall all packages listed in the given requirements files

    -
    --system

    Use the system Python to uninstall packages.

    +
    --system

    Use the system Python to uninstall packages.

    By default, uv uninstalls from the virtual environment in the current working directory or any parent directory. The --system option instructs uv to instead use the first Python found in the system PATH.

    WARNING: --system is intended for use in continuous integration (CI) environments and should be used with caution, as it can modify the system Python installation.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --target target

    Uninstall packages from the specified --target directory

    +
    --target target

    Uninstall packages from the specified --target directory

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -7070,7 +7070,7 @@ uv pip freeze [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7079,14 +7079,14 @@ uv pip freeze [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -7099,51 +7099,51 @@ uv pip freeze [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --exclude-editable

    Exclude any editable packages from output

    +
    --exclude-editable

    Exclude any editable packages from output

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --path paths

    Restrict to the specified installation path for listing packages (can be used multiple times)

    +
    --path paths

    Restrict to the specified installation path for listing packages (can be used multiple times)

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -7153,14 +7153,14 @@ uv pip freeze [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter for which packages should be listed.

    +
    --python, -p python

    The Python interpreter for which packages should be listed.

    By default, uv lists packages in a virtual environment but will show packages in a system Python environment if no virtual environment is found.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -7176,22 +7176,22 @@ uv pip freeze [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --strict

    Validate the Python environment, to detect packages with missing dependencies and other issues

    +
    --strict

    Validate the Python environment, to detect packages with missing dependencies and other issues

    -
    --system

    List packages in the system Python environment.

    +
    --system

    List packages in the system Python environment.

    Disables discovery of virtual environments.

    See uv python for details on Python discovery.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -7207,7 +7207,7 @@ uv pip list [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7216,14 +7216,14 @@ uv pip list [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -7236,50 +7236,50 @@ uv pip list [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --editable, -e

    Only include editable projects

    +
    --editable, -e

    Only include editable projects

    -
    --exclude exclude

    Exclude the specified package(s) from the output

    +
    --exclude exclude

    Exclude the specified package(s) from the output

    -
    --exclude-editable

    Exclude any editable packages from output

    +
    --exclude-editable

    Exclude any editable packages from output

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --format format

    Select the output format

    +
    --format format

    Select the output format

    [default: columns]

    Possible values:

    @@ -7291,16 +7291,16 @@ uv pip list [OPTIONS]
  • json: Display the list of packages in a machine-readable JSON format
    • -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -7314,14 +7314,14 @@ uv pip list [OPTIONS]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -7335,40 +7335,40 @@ uv pip list [OPTIONS]
  • subprocess: Use the keyring command for credential lookup
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --outdated

    List outdated packages.

    +
    --outdated

    List outdated packages.

    The latest version of each package will be shown alongside the installed version. Up-to-date packages will be omitted from the output.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -7378,14 +7378,14 @@ uv pip list [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter for which packages should be listed.

    +
    --python, -p python

    The Python interpreter for which packages should be listed.

    By default, uv lists packages in a virtual environment but will show packages in a system Python environment if no virtual environment is found.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -7401,22 +7401,22 @@ uv pip list [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --strict

    Validate the Python environment, to detect packages with missing dependencies and other issues

    +
    --strict

    Validate the Python environment, to detect packages with missing dependencies and other issues

    -
    --system

    List packages in the system Python environment.

    +
    --system

    List packages in the system Python environment.

    Disables discovery of virtual environments.

    See uv python for details on Python discovery.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -7432,13 +7432,13 @@ uv pip show [OPTIONS] [PACKAGE]...

    Arguments

    -
    PACKAGE

    The package(s) to display

    +
    PACKAGE

    The package(s) to display

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7447,14 +7447,14 @@ uv pip show [OPTIONS] [PACKAGE]...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -7467,49 +7467,49 @@ uv pip show [OPTIONS] [PACKAGE]...
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --files, -f

    Show the full list of installed files for each package

    +
    --files, -f

    Show the full list of installed files for each package

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -7519,14 +7519,14 @@ uv pip show [OPTIONS] [PACKAGE]...

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to find the package in.

    +
    --python, -p python

    The Python interpreter to find the package in.

    By default, uv looks for packages in a virtual environment but will look for packages in a system Python environment if no virtual environment is found.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -7542,22 +7542,22 @@ uv pip show [OPTIONS] [PACKAGE]...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --strict

    Validate the Python environment, to detect packages with missing dependencies and other issues

    +
    --strict

    Validate the Python environment, to detect packages with missing dependencies and other issues

    -
    --system

    Show a package in the system Python environment.

    +
    --system

    Show a package in the system Python environment.

    Disables discovery of virtual environments.

    See uv python for details on Python discovery.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -7573,7 +7573,7 @@ uv pip tree [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7582,14 +7582,14 @@ uv pip tree [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -7602,56 +7602,56 @@ uv pip tree [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --depth, -d depth

    Maximum display depth of the dependency tree

    +
    --depth, -d depth

    Maximum display depth of the dependency tree

    [default: 255]

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -7665,16 +7665,16 @@ uv pip tree [OPTIONS]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --invert

    Show the reverse dependencies for the given package. This flag will invert the tree and display the packages that depend on the given package

    +
    --invert

    Show the reverse dependencies for the given package. This flag will invert the tree and display the packages that depend on the given package

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -7688,42 +7688,42 @@ uv pip tree [OPTIONS]
  • subprocess: Use the keyring command for credential lookup
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-dedupe

    Do not de-duplicate repeated dependencies. Usually, when a package has already displayed its dependencies, further occurrences will not re-display its dependencies, and will include a (*) to indicate it has already been shown. This flag will cause those duplicates to be repeated

    +
    --no-dedupe

    Do not de-duplicate repeated dependencies. Usually, when a package has already displayed its dependencies, further occurrences will not re-display its dependencies, and will include a (*) to indicate it has already been shown. This flag will cause those duplicates to be repeated

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --outdated

    Show the latest available version of each package in the tree

    +
    --outdated

    Show the latest available version of each package in the tree

    -
    --package package

    Display only the specified packages

    +
    --package package

    Display only the specified packages

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -7733,16 +7733,16 @@ uv pip tree [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --prune prune

    Prune the given package from the display of the dependency tree

    +
    --prune prune

    Prune the given package from the display of the dependency tree

    -
    --python, -p python

    The Python interpreter for which packages should be listed.

    +
    --python, -p python

    The Python interpreter for which packages should be listed.

    By default, uv lists packages in a virtual environment but will show packages in a system Python environment if no virtual environment is found.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -7758,24 +7758,24 @@ uv pip tree [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --show-version-specifiers

    Show the version constraint(s) imposed on each package

    +
    --show-version-specifiers

    Show the version constraint(s) imposed on each package

    -
    --strict

    Validate the Python environment, to detect packages with missing dependencies and other issues

    +
    --strict

    Validate the Python environment, to detect packages with missing dependencies and other issues

    -
    --system

    List packages in the system Python environment.

    +
    --system

    List packages in the system Python environment.

    Disables discovery of virtual environments.

    See uv python for details on Python discovery.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -7791,7 +7791,7 @@ uv pip check [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7800,14 +7800,14 @@ uv pip check [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -7820,47 +7820,47 @@ uv pip check [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -7870,14 +7870,14 @@ uv pip check [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter for which packages should be checked.

    +
    --python, -p python

    The Python interpreter for which packages should be checked.

    By default, uv checks packages in a virtual environment but will check packages in a system Python environment if no virtual environment is found.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -7893,20 +7893,20 @@ uv pip check [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --system

    Check packages in the system Python environment.

    +
    --system

    Check packages in the system Python environment.

    Disables discovery of virtual environments.

    See uv python for details on Python discovery.

    May also be set with the UV_SYSTEM_PYTHON environment variable.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -7930,7 +7930,7 @@ uv venv [OPTIONS] [PATH]

    Arguments

    -
    PATH

    The path to the virtual environment to create.

    +
    PATH

    The path to the virtual environment to create.

    Default to .venv in the working directory.

    @@ -7940,13 +7940,13 @@ uv venv [OPTIONS] [PATH]

    Options

    -
    --allow-existing

    Preserve any existing files or directories at the target path.

    +
    --allow-existing

    Preserve any existing files or directories at the target path.

    By default, uv venv will remove an existing virtual environment at the given path, and exit with an error if the path is non-empty but not a virtual environment. The --allow-existing option will instead write to the given path, regardless of its contents, and without clearing it beforehand.

    WARNING: This option can lead to unexpected behavior if the existing virtual environment and the newly-created virtual environment are linked to different Python interpreters.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7955,14 +7955,14 @@ uv venv [OPTIONS] [PATH]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -7975,53 +7975,53 @@ uv venv [OPTIONS] [PATH]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -8035,14 +8035,14 @@ uv venv [OPTIONS] [PATH]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -8056,7 +8056,7 @@ uv venv [OPTIONS] [PATH]
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    This option is only used for installing seed packages.

    @@ -8074,40 +8074,40 @@ uv venv [OPTIONS] [PATH]
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-project

    Avoid discovering a project or workspace.

    +
    --no-project

    Avoid discovering a project or workspace.

    By default, uv searches for projects in the current directory or any parent directory to determine the default path of the virtual environment and check for Python version constraints, if any.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -8117,20 +8117,20 @@ uv venv [OPTIONS] [PATH]

    This setting has no effect when used in the uv pip interface.

    -
    --prompt prompt

    Provide an alternative prompt prefix for the virtual environment.

    +
    --prompt prompt

    Provide an alternative prompt prefix for the virtual environment.

    By default, the prompt is dependent on whether a path was provided to uv venv. If provided (e.g, uv venv project), the prompt is set to the directory name. If not provided (uv venv), the prompt is set to the current directory’s name.

    If "." is provided, the current directory name will be used regardless of whether a path was provided to uv venv.

    -
    --python, -p python

    The Python interpreter to use for the virtual environment.

    +
    --python, -p python

    The Python interpreter to use for the virtual environment.

    During virtual environment creation, uv will not look for Python interpreters in virtual environments.

    See uv python for details on Python discovery and supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -8146,13 +8146,13 @@ uv venv [OPTIONS] [PATH]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --relocatable

    Make the virtual environment relocatable.

    +
    --relocatable

    Make the virtual environment relocatable.

    A relocatable virtual environment can be moved around and redistributed without invalidating its associated entrypoint and activation scripts.

    @@ -8160,20 +8160,20 @@ uv venv [OPTIONS] [PATH]

    As a result of making the environment relocatable (by way of writing relative, rather than absolute paths), the entrypoints and scripts themselves will not be relocatable. In other words, copying those entrypoints and scripts to a location outside the environment will not work, as they reference paths relative to the environment itself.

    -
    --seed

    Install seed packages (one or more of: pip, setuptools, and wheel) into the virtual environment.

    +
    --seed

    Install seed packages (one or more of: pip, setuptools, and wheel) into the virtual environment.

    Note that setuptools and wheel are not included in Python 3.12+ environments.

    May also be set with the UV_VENV_SEED environment variable.

    -
    --system-site-packages

    Give the virtual environment access to the system site packages directory.

    +
    --system-site-packages

    Give the virtual environment access to the system site packages directory.

    Unlike pip, when a virtual environment is created with --system-site-packages, uv will not take system site packages into account when running commands like uv pip list or uv pip install. The --system-site-packages flag will provide the virtual environment with access to the system site packages directory at runtime, but will not affect the behavior of uv commands.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -8197,7 +8197,7 @@ uv build [OPTIONS] [SRC]

    Arguments

    -
    SRC

    The directory from which distributions should be built, or a source distribution archive to build into a wheel.

    +
    SRC

    The directory from which distributions should be built, or a source distribution archive to build into a wheel.

    Defaults to the current working directory.

    @@ -8205,13 +8205,13 @@ uv build [OPTIONS] [SRC]

    Options

    -
    --all-packages

    Builds all packages in the workspace.

    +
    --all-packages

    Builds all packages in the workspace.

    The workspace will be discovered from the provided source directory, or the current directory if no source directory is provided.

    If the workspace member does not exist, uv will exit with an error.

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -8220,19 +8220,19 @@ uv build [OPTIONS] [SRC]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --build-constraints, -b build-constraints

    Constrain build dependencies using the given requirements files when building distributions.

    +
    --build-constraints, -b build-constraints

    Constrain build dependencies using the given requirements files when building distributions.

    Constraints files are requirements.txt-like files that only control the version of a build dependency that’s installed. However, including a package in a constraints file will not trigger the inclusion of that package on its own.

    May also be set with the UV_BUILD_CONSTRAINT environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -8245,50 +8245,50 @@ uv build [OPTIONS] [SRC]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    +
    --config-setting, -C config-setting

    Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs

    -
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    +
    --default-index default-index

    The URL of the default package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --index flag.

    May also be set with the UV_DEFAULT_INDEX environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    +
    --exclude-newer exclude-newer

    Limit candidate packages to those that were uploaded prior to the given date.

    Accepts both RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z) and local dates in the same format (e.g., 2006-12-02) in your system’s configured time zone.

    May also be set with the UV_EXCLUDE_NEWER environment variable.

    -
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    +
    --extra-index-url extra-index-url

    (Deprecated: use --index instead) Extra URLs of package indexes to use, in addition to --index-url.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --index-url (which defaults to PyPI). When multiple --extra-index-url flags are provided, earlier values take priority.

    May also be set with the UV_EXTRA_INDEX_URL environment variable.

    -
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    +
    --find-links, -f find-links

    Locations to search for candidate distributions, in addition to those found in the registry indexes.

    If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

    If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

    May also be set with the UV_FIND_LINKS environment variable.

    -
    --force-pep517

    Always build through PEP 517, don’t use the fast path for the uv build backend.

    +
    --force-pep517

    Always build through PEP 517, don’t use the fast path for the uv build backend.

    By default, uv won’t create a PEP 517 build environment for packages using the uv build backend, but use a fast path that calls into the build backend directly. This option forces always using PEP 517.

    -
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    +
    --fork-strategy fork-strategy

    The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

    By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

    @@ -8302,16 +8302,16 @@ uv build [OPTIONS] [SRC]
  • requires-python: Optimize for selecting latest supported version of each package, for each supported Python version
    • -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    +
    --index index

    The URLs to use when resolving dependencies, in addition to the default index.

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    All indexes provided via this flag take priority over the index specified by --default-index (which defaults to PyPI). When multiple --index flags are provided, earlier values take priority.

    May also be set with the UV_INDEX environment variable.

    -
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    +
    --index-strategy index-strategy

    The strategy to use when resolving against multiple index URLs.

    By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents "dependency confusion" attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

    @@ -8325,14 +8325,14 @@ uv build [OPTIONS] [SRC]
  • unsafe-best-match: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index
    • -
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    +
    --index-url, -i index-url

    (Deprecated: use --default-index instead) The URL of the Python package index (by default: <https://pypi.org/simple>).

    Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

    The index given by this flag is given lower priority than all other indexes specified via the --extra-index-url flag.

    May also be set with the UV_INDEX_URL environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for index URLs.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -8346,7 +8346,7 @@ uv build [OPTIONS] [SRC]
  • subprocess: Use the keyring command for credential lookup
    • -
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    +
    --link-mode link-mode

    The method to use when installing packages from the global cache.

    This option is only used when building source distributions.

    @@ -8364,78 +8364,78 @@ uv build [OPTIONS] [SRC]
  • symlink: Symbolically link packages from the wheel into the site-packages directory
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-binary

    Don’t install pre-built wheels.

    +
    --no-binary

    Don’t install pre-built wheels.

    The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

    May also be set with the UV_NO_BINARY environment variable.

    -
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    +
    --no-binary-package no-binary-package

    Don’t install pre-built wheels for a specific package

    May also be set with the UV_NO_BINARY_PACKAGE environment variable.

    -
    --no-build

    Don’t build source distributions.

    +
    --no-build

    Don’t build source distributions.

    When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

    -
    --no-build-isolation

    Disable isolation when building source distributions.

    +
    --no-build-isolation

    Disable isolation when building source distributions.

    Assumes that build dependencies specified by PEP 518 are already installed.

    May also be set with the UV_NO_BUILD_ISOLATION environment variable.

    -
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    +
    --no-build-isolation-package no-build-isolation-package

    Disable isolation when building source distributions for a specific package.

    Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

    -
    --no-build-logs

    Hide logs from the build backend

    +
    --no-build-logs

    Hide logs from the build backend

    -
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    +
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    +
    --no-index

    Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    +
    --no-sources

    Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any workspace, Git, URL, or local path sources

    -
    --no-verify-hashes

    Disable validation of hashes in the requirements file.

    +
    --no-verify-hashes

    Disable validation of hashes in the requirements file.

    By default, uv will verify any available hashes in the requirements file, but will not require that all requirements have an associated hash. To enforce hash validation, use --require-hashes.

    May also be set with the UV_NO_VERIFY_HASHES environment variable.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --out-dir, -o out-dir

    The output directory to which distributions should be written.

    +
    --out-dir, -o out-dir

    The output directory to which distributions should be written.

    Defaults to the dist subdirectory within the source directory, or the directory containing the source distribution archive.

    -
    --package package

    Build a specific package in the workspace.

    +
    --package package

    Build a specific package in the workspace.

    The workspace will be discovered from the provided source directory, or the current directory if no source directory is provided.

    If the workspace member does not exist, uv will exit with an error.

    -
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    +
    --prerelease prerelease

    The strategy to use when considering pre-release versions.

    By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

    @@ -8453,7 +8453,7 @@ uv build [OPTIONS] [SRC]
  • if-necessary-or-explicit: Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements
    • -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -8463,14 +8463,14 @@ uv build [OPTIONS] [SRC]

    This setting has no effect when used in the uv pip interface.

    -
    --python, -p python

    The Python interpreter to use for the build environment.

    +
    --python, -p python

    The Python interpreter to use for the build environment.

    By default, builds are executed in isolated virtual environments. The discovered interpreter will be used to create those environments, and will be symlinked or copied in depending on the platform.

    See uv python to view supported request formats.

    May also be set with the UV_PYTHON environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -8486,13 +8486,13 @@ uv build [OPTIONS] [SRC]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --refresh

    Refresh all cached data

    +
    --refresh

    Refresh all cached data

    -
    --refresh-package refresh-package

    Refresh cached data for a specific package

    +
    --refresh-package refresh-package

    Refresh cached data for a specific package

    -
    --require-hashes

    Require a matching hash for each requirement.

    +
    --require-hashes

    Require a matching hash for each requirement.

    By default, uv will verify any available hashes in the requirements file, but will not require that all requirements have an associated hash.

    @@ -8505,7 +8505,7 @@ uv build [OPTIONS] [SRC]

    May also be set with the UV_REQUIRE_HASHES environment variable.

    -
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    +
    --resolution resolution

    The strategy to use when selecting between the different compatible versions for a given package requirement.

    By default, uv will use the latest compatible version of each package (highest).

    @@ -8519,19 +8519,19 @@ uv build [OPTIONS] [SRC]
  • lowest-direct: Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies
    • -
    --sdist

    Build a source distribution ("sdist") from the given directory

    +
    --sdist

    Build a source distribution ("sdist") from the given directory

    -
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    +
    --upgrade, -U

    Allow package upgrades, ignoring pinned versions in any existing output file. Implies --refresh

    -
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    +
    --upgrade-package, -P upgrade-package

    Allow upgrades for a specific package, ignoring pinned versions in any existing output file. Implies --refresh-package

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    -
    --wheel

    Build a binary distribution ("wheel") from the given directory

    +
    --wheel

    Build a binary distribution ("wheel") from the given directory

    @@ -8547,7 +8547,7 @@ uv publish [OPTIONS] [FILES]...

    Arguments

    -
    FILES

    Paths to the files to upload. Accepts glob expressions.

    +
    FILES

    Paths to the files to upload. Accepts glob expressions.

    Defaults to the dist directory. Selects only wheels and source distributions, while ignoring other files.

    @@ -8555,7 +8555,7 @@ uv publish [OPTIONS] [FILES]...

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -8564,14 +8564,14 @@ uv publish [OPTIONS] [FILES]...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --check-url check-url

    Check an index URL for existing files to skip duplicate uploads.

    +
    --check-url check-url

    Check an index URL for existing files to skip duplicate uploads.

    This option allows retrying publishing that failed after only some, but not all files have been uploaded, and handles error due to parallel uploads of the same file.

    @@ -8582,7 +8582,7 @@ uv publish [OPTIONS] [FILES]...

    The index must provide one of the supported hashes (SHA-256, SHA-384, or SHA-512).

    May also be set with the UV_PUBLISH_CHECK_URL environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -8595,20 +8595,20 @@ uv publish [OPTIONS] [FILES]...
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --index index

    The name of an index in the configuration to use for publishing.

    +
    --index index

    The name of an index in the configuration to use for publishing.

    The index must have a publish-url setting, for example:

    @@ -8617,7 +8617,7 @@ uv publish [OPTIONS] [FILES]... With these settings, the following two calls are equivalent:

    May also be set with the UV_PUBLISH_INDEX environment variable.

    -
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for remote requirements files.

    +
    --keyring-provider keyring-provider

    Attempt to use keyring for authentication for remote requirements files.

    At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

    @@ -8631,37 +8631,37 @@ With these settings, the following two calls are equivalent:
  • subprocess: Use the keyring command for credential lookup
    • -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --password, -p password

    The password for the upload

    +
    --password, -p password

    The password for the upload

    May also be set with the UV_PUBLISH_PASSWORD environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -8671,14 +8671,14 @@ With these settings, the following two calls are equivalent:

    This setting has no effect when used in the uv pip interface.

    -
    --publish-url publish-url

    The URL of the upload endpoint (not the index URL).

    +
    --publish-url publish-url

    The URL of the upload endpoint (not the index URL).

    Note that there are typically different URLs for index access (e.g., https:://.../simple) and index upload.

    Defaults to PyPI’s publish URL (<https://upload.pypi.org/legacy/>).

    May also be set with the UV_PUBLISH_URL environment variable.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -8694,14 +8694,14 @@ With these settings, the following two calls are equivalent:
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --token, -t token

    The token for the upload.

    +
    --token, -t token

    The token for the upload.

    Using a token is equivalent to passing __token__ as --username and the token as --password password.

    May also be set with the UV_PUBLISH_TOKEN environment variable.

    -
    --trusted-publishing trusted-publishing

    Configure using trusted publishing through GitHub Actions.

    +
    --trusted-publishing trusted-publishing

    Configure using trusted publishing through GitHub Actions.

    By default, uv checks for trusted publishing when running in GitHub Actions, but ignores it if it isn’t configured or the workflow doesn’t have enough permissions (e.g., a pull request from a fork).

    @@ -8714,14 +8714,14 @@ With these settings, the following two calls are equivalent:
  • never
    • -
    --username, -u username

    The username for the upload

    +
    --username, -u username

    The username for the upload

    May also be set with the UV_PUBLISH_USERNAME environment variable.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -8757,13 +8757,13 @@ uv cache clean [OPTIONS] [PACKAGE]...

    Arguments

    -
    PACKAGE

    The packages to remove from the cache

    +
    PACKAGE

    The packages to remove from the cache

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -8772,14 +8772,14 @@ uv cache clean [OPTIONS] [PACKAGE]...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -8792,47 +8792,47 @@ uv cache clean [OPTIONS] [PACKAGE]...
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -8842,7 +8842,7 @@ uv cache clean [OPTIONS] [PACKAGE]...

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -8858,13 +8858,13 @@ uv cache clean [OPTIONS] [PACKAGE]...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -8880,7 +8880,7 @@ uv cache prune [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -8889,20 +8889,20 @@ uv cache prune [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --ci

    Optimize the cache for persistence in a continuous integration environment, like GitHub Actions.

    +
    --ci

    Optimize the cache for persistence in a continuous integration environment, like GitHub Actions.

    By default, uv caches both the wheels that it builds from source and the pre-built wheels that it downloads directly, to enable high-performance package installation. In some scenarios, though, persisting pre-built wheels may be undesirable. For example, in GitHub Actions, it’s faster to omit pre-built wheels from the cache and instead have re-download them on each run. However, it typically is faster to cache wheels that are built from source, since the wheel building process can be expensive, especially for extension modules.

    In --ci mode, uv will prune any pre-built wheels from the cache, but retain any wheels that were built from source.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -8915,47 +8915,47 @@ uv cache prune [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -8965,7 +8965,7 @@ uv cache prune [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -8981,13 +8981,13 @@ uv cache prune [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -9011,7 +9011,7 @@ uv cache dir [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9020,14 +9020,14 @@ uv cache dir [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -9040,47 +9040,47 @@ uv cache dir [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -9090,7 +9090,7 @@ uv cache dir [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -9106,13 +9106,13 @@ uv cache dir [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -9144,13 +9144,13 @@ uv self update [OPTIONS] [TARGET_VERSION]

    Arguments

    -
    TARGET_VERSION

    Update to the specified version. If not provided, uv will update to the latest version

    +
    TARGET_VERSION

    Update to the specified version. If not provided, uv will update to the latest version

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9159,14 +9159,14 @@ uv self update [OPTIONS] [TARGET_VERSION]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -9179,47 +9179,47 @@ uv self update [OPTIONS] [TARGET_VERSION]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -9229,7 +9229,7 @@ uv self update [OPTIONS] [TARGET_VERSION]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -9245,16 +9245,16 @@ uv self update [OPTIONS] [TARGET_VERSION]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --token token

    A GitHub token for authentication. A token is not required but can be used to reduce the chance of encountering rate limits

    +
    --token token

    A GitHub token for authentication. A token is not required but can be used to reduce the chance of encountering rate limits

    May also be set with the UV_GITHUB_TOKEN environment variable.

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -9270,7 +9270,7 @@ uv version [OPTIONS]

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9279,14 +9279,14 @@ uv version [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -9299,47 +9299,47 @@ uv version [OPTIONS]
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --output-format output-format
    --project project

    Run the command within the given project directory.

    +
    --output-format output-format
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -9349,7 +9349,7 @@ uv version [OPTIONS]

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -9365,13 +9365,13 @@ uv version [OPTIONS]
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version

    @@ -9387,13 +9387,13 @@ uv generate-shell-completion [OPTIONS]

    Arguments

    -
    SHELL

    The shell to generate the completion script for

    +
    SHELL

    The shell to generate the completion script for

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9402,13 +9402,13 @@ uv generate-shell-completion [OPTIONS]

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -9432,11 +9432,11 @@ uv help [OPTIONS] [COMMAND]...

    Arguments

    -
    COMMAND
    +
    COMMAND

    Options

    -
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    +
    --allow-insecure-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9445,14 +9445,14 @@ uv help [OPTIONS] [COMMAND]...

    WARNING: Hosts included in this list will not be verified against the system’s certificate store. Only use --allow-insecure-host in a secure network with verified sources, as it bypasses SSL verification and could expose you to MITM attacks.

    May also be set with the UV_INSECURE_HOST environment variable.

    -
    --cache-dir cache-dir

    Path to the cache directory.

    +
    --cache-dir cache-dir

    Path to the cache directory.

    Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on macOS and Linux, and %LOCALAPPDATA%\uv\cache on Windows.

    To view the location of the cache directory, run uv cache dir.

    May also be set with the UV_CACHE_DIR environment variable.

    -
    --color color-choice

    Control the use of color in output.

    +
    --color color-choice

    Control the use of color in output.

    By default, uv will automatically detect support for colors when writing to a terminal.

    @@ -9465,49 +9465,49 @@ uv help [OPTIONS] [COMMAND]...
  • never: Disables colored output
    • -
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    +
    --config-file config-file

    The path to a uv.toml file to use for configuration.

    While uv configuration can be included in a pyproject.toml file, it is not allowed in this context.

    May also be set with the UV_CONFIG_FILE environment variable.

    -
    --directory directory

    Change to the given directory prior to running the command.

    +
    --directory directory

    Change to the given directory prior to running the command.

    Relative paths are resolved with the given directory as the base.

    See --project to only change the project root directory.

    -
    --help, -h

    Display the concise help for this command

    +
    --help, -h

    Display the concise help for this command

    -
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    +
    --native-tls

    Whether to load TLS certificates from the platform’s native certificate store.

    By default, uv loads certificates from the bundled webpki-roots crate. The webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv improves portability and performance (especially on macOS).

    However, in some cases, you may want to use the platform’s native certificate store, especially if you’re relying on a corporate trust root (e.g., for a mandatory proxy) that’s included in your system’s certificate store.

    May also be set with the UV_NATIVE_TLS environment variable.

    -
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    +
    --no-cache, -n

    Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation

    May also be set with the UV_NO_CACHE environment variable.

    -
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    +
    --no-config

    Avoid discovering configuration files (pyproject.toml, uv.toml).

    Normally, configuration files are discovered in the current directory, parent directories, or user configuration directories.

    May also be set with the UV_NO_CONFIG environment variable.

    -
    --no-pager

    Disable pager when printing help

    +
    --no-pager

    Disable pager when printing help

    -
    --no-progress

    Hide all progress outputs.

    +
    --no-progress

    Hide all progress outputs.

    For example, spinners or progress bars.

    May also be set with the UV_NO_PROGRESS environment variable.

    -
    --no-python-downloads

    Disable automatic downloads of Python.

    +
    --no-python-downloads

    Disable automatic downloads of Python.

    -
    --offline

    Disable network access.

    +
    --offline

    Disable network access.

    When disabled, uv will only use locally cached data and locally available files.

    May also be set with the UV_OFFLINE environment variable.

    -
    --project project

    Run the command within the given project directory.

    +
    --project project

    Run the command within the given project directory.

    All pyproject.toml, uv.toml, and .python-version files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (.venv).

    @@ -9517,7 +9517,7 @@ uv help [OPTIONS] [COMMAND]...

    This setting has no effect when used in the uv pip interface.

    -
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    +
    --python-preference python-preference

    Whether to prefer uv-managed or system Python installations.

    By default, uv prefers using Python versions it manages. However, it will use system Python installations if a uv-managed Python is not installed. This option allows prioritizing or ignoring system Python installations.

    @@ -9533,13 +9533,13 @@ uv help [OPTIONS] [COMMAND]...
  • only-system: Only use system Python installations; never use managed Python installations
    • -
    --quiet, -q

    Do not print any output

    +
    --quiet, -q

    Do not print any output

    -
    --verbose, -v

    Use verbose output.

    +
    --verbose, -v

    Use verbose output.

    You can configure fine-grained logging using the RUST_LOG environment variable. (<https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives>)

    -
    --version, -V

    Display the uv version

    +
    --version, -V

    Display the uv version