From 591bc34d84232a630af1106b428609d04845788e Mon Sep 17 00:00:00 2001 From: Aria Desires Date: Thu, 10 Apr 2025 17:36:22 -0400 Subject: [PATCH] display aliases for long and short args in the cli reference (#12824) Fixes #12494 (I don't feel like showing it in long-help matters too much...) --- crates/uv-dev/src/generate_cli_reference.rs | 8 +- docs/reference/cli.md | 292 ++++++++++---------- 2 files changed, 153 insertions(+), 147 deletions(-) diff --git a/crates/uv-dev/src/generate_cli_reference.rs b/crates/uv-dev/src/generate_cli_reference.rs index bb4125dbe..e743c66ac 100644 --- a/crates/uv-dev/src/generate_cli_reference.rs +++ b/crates/uv-dev/src/generate_cli_reference.rs @@ -232,10 +232,16 @@ fn generate_command<'a>(output: &mut String, command: &'a Command, parents: &mut let id = format!("{name_key}--{long}"); output.push_str(&format!("
")); - output.push_str(&format!("--{long}",)); + output.push_str(&format!("--{long}")); + for long_alias in opt.get_all_aliases().into_iter().flatten() { + output.push_str(&format!(", --{long_alias}")); + } if let Some(short) = opt.get_short() { output.push_str(&format!(", -{short}")); } + for short_alias in opt.get_all_short_aliases().into_iter().flatten() { + output.push_str(&format!(", -{short_alias}")); + } // Re-implements private `Arg::is_takes_value_set` used in `Command::get_opts` if opt diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 5b93708e9..d1cea19f8 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -92,7 +92,7 @@ uv run [OPTIONS] [COMMAND]

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, --trusted-host allow-insecure-host

Allow insecure connections to a host.

Can be provided multiple times.

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

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode, --compile

    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.

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

    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, --config-settings, -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>).

    @@ -325,7 +325,7 @@ uv run [OPTIONS] [COMMAND]
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

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

    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, --no_workspace

    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.

    @@ -451,7 +451,7 @@ uv run [OPTIONS] [COMMAND]
    --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, --force-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

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

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-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, --application

    Create a project for an application.

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

    @@ -617,7 +617,7 @@ uv init [OPTIONS] [PATH]
    --help, -h

    Display the concise help for this command

    -
    --lib

    Create a project for a library.

    +
    --lib, --library

    Create a project for a library.

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

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

    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, --no-cache-dir, -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).

    @@ -671,7 +671,7 @@ uv init [OPTIONS] [PATH]
    --no-readme

    Do not create a README.md file

    -
    --no-workspace

    Avoid discovering a workspace and create a standalone project.

    +
    --no-workspace, --no-project

    Avoid discovering a workspace and create a standalone project.

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

    @@ -769,7 +769,7 @@ uv add [OPTIONS] >

    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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

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

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode, --compile

    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.

    @@ -812,9 +812,9 @@ uv add [OPTIONS] >

    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, --config-settings, -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, --constraint, -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. The constraints will not be added to the project’s pyproject.toml file, but will be respected during dependency resolution.

    @@ -992,7 +992,7 @@ uv add [OPTIONS] >
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -1078,11 +1078,11 @@ uv add [OPTIONS] >
    --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, --force-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

    -
    --requirements, -r requirements

    Add all packages listed in the given requirements.txt files

    +
    --requirements, --requirement, -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.

    @@ -1152,7 +1152,7 @@ uv remove [OPTIONS] ...

    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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

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

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode, --compile

    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.

    @@ -1193,7 +1193,7 @@ uv remove [OPTIONS] ...

    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, --config-settings, -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>).

    @@ -1354,7 +1354,7 @@ uv remove [OPTIONS] ...
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -1432,7 +1432,7 @@ uv remove [OPTIONS] ...
    --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, --force-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

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

    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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

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

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode, --compile

    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.

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

    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, --config-settings, -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>).

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

    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, --no-exact

    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

    @@ -1732,7 +1732,7 @@ uv sync [OPTIONS]
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -1858,7 +1858,7 @@ uv sync [OPTIONS]
    --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, --force-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

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

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -1924,14 +1924,14 @@ uv lock [OPTIONS]

    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, --locked

    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, --frozen

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

    Equivalent to --frozen.

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

    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, --config-settings, -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>).

    @@ -2105,7 +2105,7 @@ uv lock [OPTIONS]
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -2242,7 +2242,7 @@ uv export [OPTIONS]

    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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -2276,7 +2276,7 @@ uv export [OPTIONS]

    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, --config-settings, -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>).

    @@ -2453,7 +2453,7 @@ uv export [OPTIONS]
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -2471,15 +2471,15 @@ uv export [OPTIONS]
    --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-install-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, --no-install-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, --no-install-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.

    @@ -2632,7 +2632,7 @@ uv tree [OPTIONS]

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

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -2666,7 +2666,7 @@ uv tree [OPTIONS]

    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, --config-settings, -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>).

    @@ -2756,7 +2756,7 @@ uv tree [OPTIONS]

    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, --reverse

    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.

    @@ -2832,7 +2832,7 @@ uv tree [OPTIONS]
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -3114,7 +3114,7 @@ uv tool run [OPTIONS] [COMMAND]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -3143,7 +3143,7 @@ uv tool run [OPTIONS] [COMMAND]
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode, --compile

    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.

    @@ -3155,9 +3155,9 @@ uv tool run [OPTIONS] [COMMAND]

    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, --config-settings, -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, --constraint, -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.

    @@ -3318,7 +3318,7 @@ uv tool run [OPTIONS] [COMMAND]
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -3350,7 +3350,7 @@ uv tool run [OPTIONS] [COMMAND]

    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, --override 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.

    @@ -3399,7 +3399,7 @@ uv tool run [OPTIONS] [COMMAND]
    --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, --force-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

    @@ -3459,7 +3459,7 @@ uv tool install [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -3488,7 +3488,7 @@ uv tool install [OPTIONS]
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode, --compile

    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.

    @@ -3500,9 +3500,9 @@ uv tool install [OPTIONS]

    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, --config-settings, -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, --constraint, -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.

    @@ -3658,7 +3658,7 @@ uv tool install [OPTIONS]
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -3687,7 +3687,7 @@ uv tool install [OPTIONS]

    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, --override 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.

    @@ -3736,7 +3736,7 @@ uv tool install [OPTIONS]
    --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, --force-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

    @@ -3796,7 +3796,7 @@ uv tool upgrade [OPTIONS] ...
    --all

    Upgrade all tools

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -3825,7 +3825,7 @@ uv tool upgrade [OPTIONS] ...
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode, --compile

    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.

    @@ -3837,7 +3837,7 @@ uv tool upgrade [OPTIONS] ...

    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, --config-settings, -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>).

    @@ -3982,7 +3982,7 @@ uv tool upgrade [OPTIONS] ...
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -4049,7 +4049,7 @@ uv tool upgrade [OPTIONS] ...

    Repeating this option, e.g., -qq, will enable a silent mode in which uv will write no output to stdout.

    -
    --reinstall

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

    +
    --reinstall, --force-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

    @@ -4087,7 +4087,7 @@ uv tool list [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4141,7 +4141,7 @@ uv tool list [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -4211,7 +4211,7 @@ uv tool uninstall [OPTIONS] ...
    --all

    Uninstall all tools

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4265,7 +4265,7 @@ uv tool uninstall [OPTIONS] ...

    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, --no-cache-dir, -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).

    @@ -4331,7 +4331,7 @@ uv tool update-shell [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4385,7 +4385,7 @@ uv tool update-shell [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -4453,7 +4453,7 @@ uv tool dir [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4523,7 +4523,7 @@ uv tool dir [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -4665,7 +4665,7 @@ uv python list [OPTIONS] [REQUEST]

    Options

    -
    --all-arches

    List Python downloads for all architectures.

    +
    --all-arches, --all_architectures

    List Python downloads for all architectures.

    By default, only downloads for the current architecture are shown.

    @@ -4677,7 +4677,7 @@ uv python list [OPTIONS] [REQUEST]

    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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4731,7 +4731,7 @@ uv python list [OPTIONS] [REQUEST]

    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, --no-cache-dir, -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).

    @@ -4833,7 +4833,7 @@ uv python install [OPTIONS] [TARGETS]...

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -4915,7 +4915,7 @@ uv python install [OPTIONS] [TARGETS]...

    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, --no-cache-dir, -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).

    @@ -4998,7 +4998,7 @@ uv python find [OPTIONS] [REQUEST]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -5052,7 +5052,7 @@ uv python find [OPTIONS] [REQUEST]

    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, --no-cache-dir, -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).

    @@ -5070,7 +5070,7 @@ uv python find [OPTIONS] [REQUEST]

    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, --no_workspace

    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.

    @@ -5145,7 +5145,7 @@ uv python pin [OPTIONS] [REQUEST]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -5207,7 +5207,7 @@ uv python pin [OPTIONS] [REQUEST]

    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, --no-cache-dir, -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).

    @@ -5225,7 +5225,7 @@ uv python pin [OPTIONS] [REQUEST]

    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, --no-workspace

    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.

    @@ -5283,7 +5283,7 @@ uv python dir [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -5353,7 +5353,7 @@ uv python dir [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -5423,7 +5423,7 @@ uv python uninstall [OPTIONS] ...
    --all

    Uninstall all managed Python versions

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -5480,7 +5480,7 @@ uv python uninstall [OPTIONS] ...

    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, --no-cache-dir, -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).

    @@ -5588,7 +5588,7 @@ uv pip compile [OPTIONS] >

    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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -5608,7 +5608,7 @@ 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, --build-constraint, -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.

    @@ -5638,9 +5638,9 @@ uv pip compile [OPTIONS] >

    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, --config-settings, -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, --constraint, -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.

    @@ -5815,12 +5815,12 @@ uv pip compile [OPTIONS] >

    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, --no-cache-dir, -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-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, --unsafe-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

    @@ -5863,7 +5863,7 @@ uv pip compile [OPTIONS] >

    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, --override 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.

    @@ -6139,7 +6139,7 @@ uv pip sync [OPTIONS] ...
    --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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -6153,7 +6153,7 @@ uv pip sync [OPTIONS] ...

    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, --build-constraint, -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.

    @@ -6178,7 +6178,7 @@ uv pip sync [OPTIONS] ...
  • never: Disables colored output
    • -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode, --compile

    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.

    @@ -6190,9 +6190,9 @@ uv pip sync [OPTIONS] ...

    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, --config-settings, -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, --constraint, -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.

    @@ -6322,7 +6322,7 @@ uv pip sync [OPTIONS] ...

    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, --no-cache-dir, -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

    @@ -6476,7 +6476,7 @@ uv pip sync [OPTIONS] ...
    --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, --force-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

    @@ -6600,7 +6600,7 @@ uv pip install [OPTIONS] |--editable 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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -6614,7 +6614,7 @@ uv pip install [OPTIONS] |--editable 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, --build-constraint, -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.

    @@ -6639,7 +6639,7 @@ uv pip install [OPTIONS] |--editable never: Disables colored output -
    --compile-bytecode

    Compile Python files to bytecode after installation.

    +
    --compile-bytecode, --compile

    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.

    @@ -6651,9 +6651,9 @@ uv pip install [OPTIONS] |--editable 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, --config-settings, -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, --constraint, -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.

    @@ -6817,7 +6817,7 @@ uv pip install [OPTIONS] |--editable 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, --no-cache-dir, -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).

    @@ -6859,7 +6859,7 @@ uv pip install [OPTIONS] |--editable 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, --override 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.

    @@ -7003,7 +7003,7 @@ uv pip install [OPTIONS] |--editable
    --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, --force-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

    @@ -7020,7 +7020,7 @@ 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, --requirement, -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.

    @@ -7145,7 +7145,7 @@ uv pip uninstall [OPTIONS] >

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7220,7 +7220,7 @@ uv pip uninstall [OPTIONS] >

    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, --no-cache-dir, -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).

    @@ -7269,7 +7269,7 @@ uv pip uninstall [OPTIONS] >

    Repeating this option, e.g., -qq, will enable a silent mode in which uv will write no output to stdout.

    -
    --requirements, -r requirements

    Uninstall all packages listed in the given requirements files

    +
    --requirements, --requirement, -r requirements

    Uninstall all packages listed in the given requirements files

    --system

    Use the system Python to uninstall packages.

    @@ -7300,7 +7300,7 @@ uv pip freeze [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7356,7 +7356,7 @@ uv pip freeze [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -7434,7 +7434,7 @@ uv pip list [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7574,7 +7574,7 @@ uv pip list [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -7662,7 +7662,7 @@ uv pip show [OPTIONS] [PACKAGE]...

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7718,7 +7718,7 @@ uv pip show [OPTIONS] [PACKAGE]...

    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, --no-cache-dir, -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).

    @@ -7794,7 +7794,7 @@ uv pip tree [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -7893,7 +7893,7 @@ uv pip tree [OPTIONS]

    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, --reverse

    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.

    @@ -7921,7 +7921,7 @@ uv pip tree [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -8009,7 +8009,7 @@ uv pip check [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -8063,7 +8063,7 @@ uv pip check [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -8161,7 +8161,7 @@ uv venv [OPTIONS] [PATH]

    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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -8301,7 +8301,7 @@ uv venv [OPTIONS] [PATH]

    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, --no-cache-dir, -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).

    @@ -8321,7 +8321,7 @@ uv venv [OPTIONS] [PATH]

    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, --no-workspace

    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.

    @@ -8417,13 +8417,13 @@ uv build [OPTIONS] [SRC]

    Options

    -
    --all-packages

    Builds all packages in the workspace.

    +
    --all-packages, --all

    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, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -8432,7 +8432,7 @@ 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, --build-constraint, -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.

    @@ -8462,7 +8462,7 @@ uv build [OPTIONS] [SRC]

    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, --config-settings, -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>).

    @@ -8615,7 +8615,7 @@ uv build [OPTIONS] [SRC]
    --no-build-package no-build-package

    Don’t build source distributions for a specific package

    May also be set with the UV_NO_BUILD_PACKAGE 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, --no-cache-dir, -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).

    @@ -8766,7 +8766,7 @@ uv publish [OPTIONS] [FILES]...

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -8862,7 +8862,7 @@ uv publish --publish-url https://upload.pypi.org/legacy/ --check-url https://pyp

    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, --no-cache-dir, -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).

    @@ -8979,7 +8979,7 @@ uv cache clean [OPTIONS] [PACKAGE]...

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9033,7 +9033,7 @@ uv cache clean [OPTIONS] [PACKAGE]...

    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, --no-cache-dir, -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).

    @@ -9093,7 +9093,7 @@ uv cache prune [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9153,7 +9153,7 @@ uv cache prune [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -9221,7 +9221,7 @@ uv cache dir [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9275,7 +9275,7 @@ uv cache dir [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -9357,7 +9357,7 @@ uv self update [OPTIONS] [TARGET_VERSION]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9411,7 +9411,7 @@ uv self update [OPTIONS] [TARGET_VERSION]

    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, --no-cache-dir, -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).

    @@ -9474,7 +9474,7 @@ uv version [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9528,7 +9528,7 @@ uv version [OPTIONS]

    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, --no-cache-dir, -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).

    @@ -9594,7 +9594,7 @@ uv generate-shell-completion [OPTIONS]

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9648,7 +9648,7 @@ uv help [OPTIONS] [COMMAND]...

    Options

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

    Allow insecure connections to a host.

    +
    --allow-insecure-host, --trusted-host allow-insecure-host

    Allow insecure connections to a host.

    Can be provided multiple times.

    @@ -9702,7 +9702,7 @@ uv help [OPTIONS] [COMMAND]...

    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, --no-cache-dir, -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).