From d1614c8f103c218e22d88c339daabc48d477d2b1 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Tue, 6 Aug 2024 20:50:29 -0500 Subject: [PATCH] Improve CLI documentation for global options (#5834) Slowly auditing our CLI help text --- crates/uv-cli/src/lib.rs | 44 +++++-- crates/uv/tests/help.rs | 179 +++++++++++++------------- docs/reference/cli.md | 272 +++++++++++++++++++++++++++++---------- 3 files changed, 328 insertions(+), 167 deletions(-) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index 05c58a088..eac452d61 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -74,6 +74,9 @@ pub struct Cli { pub global_args: Box, /// 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. #[arg( global = true, long, @@ -82,17 +85,18 @@ pub struct Cli { )] pub config_file: Option, - /// Avoid discovering configuration files (`pyproject.toml`, `uv.toml`) in the current directory, + /// Avoid discovering configuration files (`pyproject.toml`, `uv.toml`). + /// + /// Normally, configuration files are discovered in the current directory, /// parent directories, or user configuration directories. #[arg(global = true, long, env = "UV_NO_CONFIG", value_parser = clap::builder::BoolishValueParser::new(), help_heading = "Global options")] pub no_config: bool, - /// Print help. + /// Display the concise help for this command. #[arg(global = true, short, long, action = clap::ArgAction::HelpShort, help_heading = "Global options")] help: Option, - /// Print version. - // This enable it to show under Global options section. + /// Display the uv version. #[arg(global = true, short = 'V', long, action = clap::ArgAction::Version, help_heading = "Global options")] version: Option, } @@ -101,8 +105,12 @@ pub struct Cli { #[command(next_help_heading = "Global options", next_display_order = 1000)] #[allow(clippy::struct_excessive_bools)] pub struct GlobalArgs { - /// Whether to prefer using Python installations that are already present on the system, or - /// those that are downloaded and installed by uv. + /// 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. #[arg( global = true, long, @@ -126,7 +134,9 @@ pub struct GlobalArgs { #[arg(global = true, action = clap::ArgAction::Count, long, short, conflicts_with = "quiet")] pub verbose: u8, - /// Disable colors; provided for compatibility with `pip`. + /// Disable colors. + /// + /// Provided for compatibility with `pip`, use `--color` instead. #[arg(global = true, long, hide = true, conflicts_with = "color")] pub no_color: bool, @@ -156,7 +166,9 @@ pub struct GlobalArgs { #[arg(global = true, long, overrides_with("native_tls"), hide = true)] pub no_native_tls: bool, - /// Disable network access, relying only on locally cached data and locally available files. + /// Disable network access. + /// + /// When disabled, uv will only use locally cached data and locally available files. #[arg(global = true, long, overrides_with("no_offline"))] pub offline: bool, @@ -164,22 +176,32 @@ pub struct GlobalArgs { pub no_offline: bool, /// Whether to enable experimental, preview features. + /// + /// Preview features may change without warning. #[arg(global = true, long, hide = true, env = "UV_PREVIEW", value_parser = clap::builder::BoolishValueParser::new(), overrides_with("no_preview"))] pub preview: bool, #[arg(global = true, long, overrides_with("preview"), hide = true)] pub no_preview: bool, - /// Avoid discovering a `pyproject.toml` or `uv.toml` file in the current directory or any - /// parent directories. + /// Avoid discovering a `pyproject.toml` or `uv.toml` file. + /// + /// Normally, configuration files are discovered in the current directory, + /// parent directories, or user configuration directories. + /// + /// This option is deprecated in favor of `--no-config`. #[arg(global = true, long, hide = true)] pub isolated: bool, /// Show the resolved settings for the current command. + /// + /// This option is used for debugging and development purposes. #[arg(global = true, long, hide = true)] pub show_settings: bool, - /// Hides all progress outputs when set + /// Hide all progress outputs. + /// + /// For example, spinners or progress bars. #[arg(global = true, long)] pub no_progress: bool, diff --git a/crates/uv/tests/help.rs b/crates/uv/tests/help.rs index 3c511d6e5..945a7902c 100644 --- a/crates/uv/tests/help.rs +++ b/crates/uv/tests/help.rs @@ -38,9 +38,8 @@ fn help() { Python options: --python-preference - Whether to prefer using Python installations that are already present on the system, or - those that are downloaded and installed by uv [possible values: only-managed, managed, - system, only-system] + Whether to prefer uv-managed or system Python installations [possible values: + only-managed, managed, system, only-system] --python-fetch Whether to automatically download Python when required [possible values: automatic, manual] @@ -52,16 +51,14 @@ fn help() { always, never] --native-tls Whether to load TLS certificates from the platform's native certificate store [env: UV_NATIVE_TLS=] - --offline Disable network access, relying only on locally cached data and - locally available files - --no-progress Hides all progress outputs when set + --offline Disable network access + --no-progress Hide all progress outputs --config-file The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=] --no-config Avoid discovering configuration files (`pyproject.toml`, - `uv.toml`) in the current directory, parent directories, or user - configuration directories [env: UV_NO_CONFIG=] - -h, --help Print help - -V, --version Print version + `uv.toml`) [env: UV_NO_CONFIG=] + -h, --help Display the concise help for this command + -V, --version Display the uv version Use `uv help ` for more information on a specific command. @@ -104,9 +101,8 @@ fn help_flag() { Python options: --python-preference - Whether to prefer using Python installations that are already present on the system, or - those that are downloaded and installed by uv [possible values: only-managed, managed, - system, only-system] + Whether to prefer uv-managed or system Python installations [possible values: + only-managed, managed, system, only-system] --python-fetch Whether to automatically download Python when required [possible values: automatic, manual] @@ -118,16 +114,14 @@ fn help_flag() { always, never] --native-tls Whether to load TLS certificates from the platform's native certificate store [env: UV_NATIVE_TLS=] - --offline Disable network access, relying only on locally cached data and - locally available files - --no-progress Hides all progress outputs when set + --offline Disable network access + --no-progress Hide all progress outputs --config-file The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=] --no-config Avoid discovering configuration files (`pyproject.toml`, - `uv.toml`) in the current directory, parent directories, or user - configuration directories [env: UV_NO_CONFIG=] - -h, --help Print help - -V, --version Print version + `uv.toml`) [env: UV_NO_CONFIG=] + -h, --help Display the concise help for this command + -V, --version Display the uv version Use `uv help` for more details. @@ -169,9 +163,8 @@ fn help_short_flag() { Python options: --python-preference - Whether to prefer using Python installations that are already present on the system, or - those that are downloaded and installed by uv [possible values: only-managed, managed, - system, only-system] + Whether to prefer uv-managed or system Python installations [possible values: + only-managed, managed, system, only-system] --python-fetch Whether to automatically download Python when required [possible values: automatic, manual] @@ -183,16 +176,14 @@ fn help_short_flag() { always, never] --native-tls Whether to load TLS certificates from the platform's native certificate store [env: UV_NATIVE_TLS=] - --offline Disable network access, relying only on locally cached data and - locally available files - --no-progress Hides all progress outputs when set + --offline Disable network access + --no-progress Hide all progress outputs --config-file The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=] --no-config Avoid discovering configuration files (`pyproject.toml`, - `uv.toml`) in the current directory, parent directories, or user - configuration directories [env: UV_NO_CONFIG=] - -h, --help Print help - -V, --version Print version + `uv.toml`) [env: UV_NO_CONFIG=] + -h, --help Display the concise help for this command + -V, --version Display the uv version Use `uv help` for more details. @@ -237,8 +228,11 @@ fn help_subcommand() { Python options: --python-preference - Whether to prefer using Python installations that are already present on the system, or - those that are downloaded and installed by uv + 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. Possible values: - only-managed: Only use managed Python installations; never use system Python @@ -291,27 +285,36 @@ fn help_subcommand() { [env: UV_NATIVE_TLS=] --offline - Disable network access, relying only on locally cached data and locally available files + Disable network access. + + When disabled, uv will only use locally cached data and locally available files. --no-progress - Hides all progress outputs when set + Hide all progress outputs. + + For example, spinners or progress bars. --config-file - The path to a `uv.toml` file to use for configuration + 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. [env: UV_CONFIG_FILE=] --no-config - Avoid discovering configuration files (`pyproject.toml`, `uv.toml`) in the current - directory, parent directories, or user configuration directories + Avoid discovering configuration files (`pyproject.toml`, `uv.toml`). + + Normally, configuration files are discovered in the current directory, parent directories, + or user configuration directories. [env: UV_NO_CONFIG=] -h, --help - Print help + Display the concise help for this command -V, --version - Print version + Display the uv version Use `uv help python ` for more information on a specific command. @@ -361,8 +364,11 @@ fn help_subsubcommand() { Python options: --python-preference - Whether to prefer using Python installations that are already present on the system, or - those that are downloaded and installed by uv + 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. Possible values: - only-managed: Only use managed Python installations; never use system Python @@ -415,27 +421,36 @@ fn help_subsubcommand() { [env: UV_NATIVE_TLS=] --offline - Disable network access, relying only on locally cached data and locally available files + Disable network access. + + When disabled, uv will only use locally cached data and locally available files. --no-progress - Hides all progress outputs when set + Hide all progress outputs. + + For example, spinners or progress bars. --config-file - The path to a `uv.toml` file to use for configuration + 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. [env: UV_CONFIG_FILE=] --no-config - Avoid discovering configuration files (`pyproject.toml`, `uv.toml`) in the current - directory, parent directories, or user configuration directories + Avoid discovering configuration files (`pyproject.toml`, `uv.toml`). + + Normally, configuration files are discovered in the current directory, parent directories, + or user configuration directories. [env: UV_NO_CONFIG=] -h, --help - Print help + Display the concise help for this command -V, --version - Print version + Display the uv version ----- stderr ----- @@ -469,9 +484,8 @@ fn help_flag_subcommand() { Python options: --python-preference - Whether to prefer using Python installations that are already present on the system, or - those that are downloaded and installed by uv [possible values: only-managed, managed, - system, only-system] + Whether to prefer uv-managed or system Python installations [possible values: + only-managed, managed, system, only-system] --python-fetch Whether to automatically download Python when required [possible values: automatic, manual] @@ -483,16 +497,14 @@ fn help_flag_subcommand() { always, never] --native-tls Whether to load TLS certificates from the platform's native certificate store [env: UV_NATIVE_TLS=] - --offline Disable network access, relying only on locally cached data and - locally available files - --no-progress Hides all progress outputs when set + --offline Disable network access + --no-progress Hide all progress outputs --config-file The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=] --no-config Avoid discovering configuration files (`pyproject.toml`, - `uv.toml`) in the current directory, parent directories, or user - configuration directories [env: UV_NO_CONFIG=] - -h, --help Print help - -V, --version Print version + `uv.toml`) [env: UV_NO_CONFIG=] + -h, --help Display the concise help for this command + -V, --version Display the uv version Use `uv help python` for more details. @@ -525,9 +537,8 @@ fn help_flag_subsubcommand() { Python options: --python-preference - Whether to prefer using Python installations that are already present on the system, or - those that are downloaded and installed by uv [possible values: only-managed, managed, - system, only-system] + Whether to prefer uv-managed or system Python installations [possible values: + only-managed, managed, system, only-system] --python-fetch Whether to automatically download Python when required [possible values: automatic, manual] @@ -539,16 +550,14 @@ fn help_flag_subsubcommand() { always, never] --native-tls Whether to load TLS certificates from the platform's native certificate store [env: UV_NATIVE_TLS=] - --offline Disable network access, relying only on locally cached data and - locally available files - --no-progress Hides all progress outputs when set + --offline Disable network access + --no-progress Hide all progress outputs --config-file The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=] --no-config Avoid discovering configuration files (`pyproject.toml`, - `uv.toml`) in the current directory, parent directories, or user - configuration directories [env: UV_NO_CONFIG=] - -h, --help Print help - -V, --version Print version + `uv.toml`) [env: UV_NO_CONFIG=] + -h, --help Display the concise help for this command + -V, --version Display the uv version ----- stderr ----- "###); @@ -658,9 +667,8 @@ fn help_with_global_option() { Python options: --python-preference - Whether to prefer using Python installations that are already present on the system, or - those that are downloaded and installed by uv [possible values: only-managed, managed, - system, only-system] + Whether to prefer uv-managed or system Python installations [possible values: + only-managed, managed, system, only-system] --python-fetch Whether to automatically download Python when required [possible values: automatic, manual] @@ -672,16 +680,14 @@ fn help_with_global_option() { always, never] --native-tls Whether to load TLS certificates from the platform's native certificate store [env: UV_NATIVE_TLS=] - --offline Disable network access, relying only on locally cached data and - locally available files - --no-progress Hides all progress outputs when set + --offline Disable network access + --no-progress Hide all progress outputs --config-file The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=] --no-config Avoid discovering configuration files (`pyproject.toml`, - `uv.toml`) in the current directory, parent directories, or user - configuration directories [env: UV_NO_CONFIG=] - -h, --help Print help - -V, --version Print version + `uv.toml`) [env: UV_NO_CONFIG=] + -h, --help Display the concise help for this command + -V, --version Display the uv version Use `uv help ` for more information on a specific command. @@ -760,9 +766,8 @@ fn help_with_no_pager() { Python options: --python-preference - Whether to prefer using Python installations that are already present on the system, or - those that are downloaded and installed by uv [possible values: only-managed, managed, - system, only-system] + Whether to prefer uv-managed or system Python installations [possible values: + only-managed, managed, system, only-system] --python-fetch Whether to automatically download Python when required [possible values: automatic, manual] @@ -774,16 +779,14 @@ fn help_with_no_pager() { always, never] --native-tls Whether to load TLS certificates from the platform's native certificate store [env: UV_NATIVE_TLS=] - --offline Disable network access, relying only on locally cached data and - locally available files - --no-progress Hides all progress outputs when set + --offline Disable network access + --no-progress Hide all progress outputs --config-file The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=] --no-config Avoid discovering configuration files (`pyproject.toml`, - `uv.toml`) in the current directory, parent directories, or user - configuration directories [env: UV_NO_CONFIG=] - -h, --help Print help - -V, --version Print version + `uv.toml`) [env: UV_NO_CONFIG=] + -h, --help Display the concise help for this command + -V, --version Display the uv version Use `uv help ` for more information on a specific command. diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 74cac68a0..1e5e85aa3 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -189,7 +189,9 @@ uv run [OPTIONS]

Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

-
--python-preference python-preference

Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

+
--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.

Possible values:

@@ -223,7 +225,9 @@ uv run [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.

    @@ -265,7 +269,9 @@ uv init [OPTIONS] [PATH]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -299,7 +305,9 @@ 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.

    @@ -456,7 +464,9 @@ uv add [OPTIONS] ...

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -490,7 +500,9 @@ uv add [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.

    @@ -639,7 +651,9 @@ uv remove [OPTIONS] ...

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -673,7 +687,9 @@ uv remove [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.

    @@ -818,7 +834,9 @@ uv sync [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -852,7 +870,9 @@ uv sync [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.

    @@ -991,7 +1011,9 @@ uv lock [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1025,7 +1047,9 @@ 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.

    @@ -1210,7 +1234,9 @@ uv tree [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1244,7 +1270,9 @@ 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.

    @@ -1417,7 +1445,9 @@ uv tool run [OPTIONS] [COMMAND]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1451,7 +1481,9 @@ uv tool run [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.

    @@ -1600,7 +1632,9 @@ uv tool install [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1634,7 +1668,9 @@ uv tool install [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.

    @@ -1654,7 +1690,9 @@ uv tool list [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1688,7 +1726,9 @@ 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.

    @@ -1714,7 +1754,9 @@ uv tool uninstall [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1748,7 +1790,9 @@ 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.

    @@ -1768,7 +1812,9 @@ uv tool update-shell [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1802,7 +1848,9 @@ 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.

    @@ -1822,7 +1870,9 @@ uv tool dir [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1856,7 +1906,9 @@ 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.

    @@ -1902,7 +1954,9 @@ uv python list [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1936,7 +1990,9 @@ 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.

    @@ -1964,7 +2020,9 @@ uv python install [OPTIONS] [TARGETS]...

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -1998,7 +2056,9 @@ 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.

    @@ -2024,7 +2084,9 @@ uv python find [OPTIONS] [REQUEST]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -2058,7 +2120,9 @@ 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.

    @@ -2084,7 +2148,9 @@ uv python pin [OPTIONS] [REQUEST]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -2118,7 +2184,9 @@ 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.

    @@ -2138,7 +2206,9 @@ uv python dir [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -2172,7 +2242,9 @@ 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.

    @@ -2198,7 +2270,9 @@ uv python uninstall [OPTIONS] ...

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -2232,7 +2306,9 @@ 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.

    @@ -2505,7 +2581,9 @@ uv pip compile [OPTIONS] ...

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -2539,7 +2617,9 @@ 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.

    @@ -2725,7 +2805,9 @@ uv pip sync [OPTIONS] ...

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -2759,7 +2841,9 @@ uv pip sync [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.

    @@ -2991,7 +3075,9 @@ uv pip install [OPTIONS] |--editable Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3025,7 +3111,9 @@ uv pip install [OPTIONS] |--editable 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.

    @@ -3084,7 +3172,9 @@ uv pip uninstall [OPTIONS] >

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3118,7 +3208,9 @@ 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.

    @@ -3152,7 +3244,9 @@ uv pip freeze [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3186,7 +3280,9 @@ 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.

    @@ -3234,7 +3330,9 @@ uv pip list [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3268,7 +3366,9 @@ 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.

    @@ -3308,7 +3408,9 @@ uv pip show [OPTIONS] [PACKAGE]...

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3342,7 +3444,9 @@ 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.

    @@ -3383,7 +3487,9 @@ uv pip tree [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3417,7 +3523,9 @@ 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.

    @@ -3451,7 +3559,9 @@ uv pip check [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3485,7 +3595,9 @@ 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.

    @@ -3608,7 +3720,9 @@ uv venv [OPTIONS] [NAME]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3642,7 +3756,9 @@ uv venv [OPTIONS] [NAME]
  • 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.

    @@ -3688,7 +3804,9 @@ uv cache clean [OPTIONS] [PACKAGE]...

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3722,7 +3840,9 @@ 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.

    @@ -3742,7 +3862,9 @@ uv cache prune [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3776,7 +3898,9 @@ 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.

    @@ -3796,7 +3920,9 @@ uv cache dir [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3830,7 +3956,9 @@ 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.

    @@ -3850,7 +3978,9 @@ uv version [OPTIONS]

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3884,7 +4014,9 @@ 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.

    @@ -3908,7 +4040,9 @@ uv help [OPTIONS] [COMMAND]...

    Defaults to $HOME/Library/Caches/uv on macOS, $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux, and {FOLDERID_LocalAppData}\uv\cache on Windows.

    -
    --python-preference python-preference

    Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv

    +
    --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.

    Possible values:

    @@ -3942,7 +4076,9 @@ 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.