From 191c9175fe53f8d4690e5bfa4174e260f8842991 Mon Sep 17 00:00:00 2001 From: NewDestinyDan <109760905+NewDestinyDan@users.noreply.github.com> Date: Fri, 15 Aug 2025 17:06:37 -0400 Subject: [PATCH] Update cli.md to use proper uv cache subcommand "clean" (#15313) Correct typo. "uv cache clear" is not a command. ## Summary ## Test Plan --- crates/uv-cli/src/lib.rs | 10 +++++----- crates/uv-settings/src/settings.rs | 4 ++-- docs/reference/cli.md | 32 +++++++++++++++--------------- docs/reference/settings.md | 4 ++-- uv.schema.json | 4 ++-- 5 files changed, 27 insertions(+), 27 deletions(-) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index f89ebf90d..c3b849885 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -2773,7 +2773,7 @@ pub struct VenvArgs { /// Windows. /// /// WARNING: The use of symlink link mode is discouraged, as they create tight coupling between - /// the cache and the target environment. For example, clearing the cache (`uv cache clear`) + /// the cache and the target environment. For example, clearing the cache (`uv cache clean`) /// will break all installed packages by way of removing the underlying source files. Use /// symlinks with caution. #[arg(long, value_enum, env = EnvVars::UV_LINK_MODE)] @@ -4819,7 +4819,7 @@ pub struct ToolUpgradeArgs { /// Windows. /// /// WARNING: The use of symlink link mode is discouraged, as they create tight coupling between - /// the cache and the target environment. For example, clearing the cache (`uv cache clear`) + /// the cache and the target environment. For example, clearing the cache (`uv cache clean`) /// will break all installed packages by way of removing the underlying source files. Use /// symlinks with caution. #[arg( @@ -5635,7 +5635,7 @@ pub struct InstallerArgs { /// Windows. /// /// WARNING: The use of symlink link mode is discouraged, as they create tight coupling between - /// the cache and the target environment. For example, clearing the cache (`uv cache clear`) + /// the cache and the target environment. For example, clearing the cache (`uv cache clean`) /// will break all installed packages by way of removing the underlying source files. Use /// symlinks with caution. #[arg( @@ -5852,7 +5852,7 @@ pub struct ResolverArgs { /// Windows. /// /// WARNING: The use of symlink link mode is discouraged, as they create tight coupling between - /// the cache and the target environment. For example, clearing the cache (`uv cache clear`) + /// the cache and the target environment. For example, clearing the cache (`uv cache clean`) /// will break all installed packages by way of removing the underlying source files. Use /// symlinks with caution. #[arg( @@ -6061,7 +6061,7 @@ pub struct ResolverInstallerArgs { /// Windows. /// /// WARNING: The use of symlink link mode is discouraged, as they create tight coupling between - /// the cache and the target environment. For example, clearing the cache (`uv cache clear`) + /// the cache and the target environment. For example, clearing the cache (`uv cache clean`) /// will break all installed packages by way of removing the underlying source files. Use /// symlinks with caution. #[arg( diff --git a/crates/uv-settings/src/settings.rs b/crates/uv-settings/src/settings.rs index cc3b61066..31218f2a5 100644 --- a/crates/uv-settings/src/settings.rs +++ b/crates/uv-settings/src/settings.rs @@ -688,7 +688,7 @@ pub struct ResolverInstallerOptions { /// Windows. /// /// WARNING: The use of symlink link mode is discouraged, as they create tight coupling between - /// the cache and the target environment. For example, clearing the cache (`uv cache clear`) + /// the cache and the target environment. For example, clearing the cache (`uv cache clean`) /// will break all installed packages by way of removing the underlying source files. Use /// symlinks with caution. #[option( @@ -1576,7 +1576,7 @@ pub struct PipOptions { /// Windows. /// /// WARNING: The use of symlink link mode is discouraged, as they create tight coupling between - /// the cache and the target environment. For example, clearing the cache (`uv cache clear`) + /// the cache and the target environment. For example, clearing the cache (`uv cache clean`) /// will break all installed packages by way of removing the underlying source files. Use /// symlinks with caution. #[option( diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 10c9831ea..4ed92282b 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -151,7 +151,7 @@ uv run [OPTIONS] [COMMAND]
  • subprocess: Use the keyring command for credential lookup
  • The method to use when installing packages from the global cache.

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

    This option is only used when building source distributions.

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

    This option is only used when building source distributions.

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

    This option is only used when building source distributions.

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

    This option is only used when building source distributions.

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

    This option is only used for installing seed packages.

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values:

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

    This option is only used when building source distributions.

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

    -

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clear) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    +

    WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

    May also be set with the UV_LINK_MODE environment variable.

    Possible values: