From d0dda3798d2514350ab29e4dc3870cd56479a713 Mon Sep 17 00:00:00 2001 From: T-256 <132141463+T-256@users.noreply.github.com> Date: Fri, 23 Aug 2024 21:34:08 +0330 Subject: [PATCH] docs: Use proper environment variables for Windows (#6433) ref: https://github.com/astral-sh/uv/issues/6397#issuecomment-2304512872 --- crates/uv-cache/src/cli.rs | 2 +- crates/uv-cli/src/lib.rs | 6 +-- crates/uv-settings/src/settings.rs | 2 +- crates/uv/tests/help.rs | 4 +- docs/concepts/cache.md | 2 +- docs/reference/cli.md | 76 +++++++++++++++--------------- docs/reference/settings.md | 2 +- uv.schema.json | 2 +- 8 files changed, 48 insertions(+), 48 deletions(-) diff --git a/crates/uv-cache/src/cli.rs b/crates/uv-cache/src/cli.rs index 303b9cd8c..06f0eca93 100644 --- a/crates/uv-cache/src/cli.rs +++ b/crates/uv-cache/src/cli.rs @@ -25,7 +25,7 @@ pub struct CacheArgs { /// Path to the cache directory. /// /// 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. + /// Linux, and `%LOCALAPPDATA%\uv\cache` on Windows. #[arg(global = true, long, env = "UV_CACHE_DIR")] pub cache_dir: Option, } diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index b0808b3b8..1f5b9bd7f 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -405,7 +405,7 @@ pub enum CacheCommand { /// /// /// By default, the cache is stored in `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Unix and - /// `{FOLDERID_LocalAppData}\uv\cache` on Windows. + /// `%LOCALAPPDATA%\uv\cache` on Windows. /// /// When `--no-cache` is used, the cache is stored in a temporary directory and discarded when /// the process exits. @@ -2716,7 +2716,7 @@ pub enum ToolCommand { /// The tools directory is used to store environments and metadata for installed tools. /// /// By default, tools are stored in the uv data directory at `$XDG_DATA_HOME/uv/tools` or - /// `$HOME/.local/share/uv/tools` on Unix and `{FOLDERID_RoamingAppData}\uv\data\tools` on + /// `$HOME/.local/share/uv/tools` on Unix and `%APPDATA%\uv\data\tools` on /// Windows. /// /// The tool installation directory may be overridden with `$UV_TOOL_DIR`. @@ -2955,7 +2955,7 @@ pub enum PythonCommand { /// /// By default, Python installations are stored in the uv data directory at /// `$XDG_DATA_HOME/uv/python` or `$HOME/.local/share/uv/python` on Unix and - /// `{FOLDERID_RoamingAppData}\uv\data\python` on Windows. + /// `%APPDATA%\uv\data\python` on Windows. /// /// The Python installation directory may be overridden with `$UV_PYTHON_INSTALL_DIR`. Dir, diff --git a/crates/uv-settings/src/settings.rs b/crates/uv-settings/src/settings.rs index 714402554..8f580b9d6 100644 --- a/crates/uv-settings/src/settings.rs +++ b/crates/uv-settings/src/settings.rs @@ -129,7 +129,7 @@ pub struct GlobalOptions { /// Path to the cache directory. /// /// 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. + /// Linux, and `%LOCALAPPDATA%\uv\cache` on Windows. #[option( default = "None", value_type = "str", diff --git a/crates/uv/tests/help.rs b/crates/uv/tests/help.rs index 7e419499c..8f430d764 100644 --- a/crates/uv/tests/help.rs +++ b/crates/uv/tests/help.rs @@ -258,7 +258,7 @@ fn help_subcommand() { Path to the cache directory. 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. + on Linux, and `%LOCALAPPDATA%/uv/cache` on Windows. [env: UV_CACHE_DIR=] @@ -407,7 +407,7 @@ fn help_subsubcommand() { Path to the cache directory. 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. + on Linux, and `%LOCALAPPDATA%/uv/cache` on Windows. [env: UV_CACHE_DIR=] diff --git a/docs/concepts/cache.md b/docs/concepts/cache.md index b8be0c10e..3297633d6 100644 --- a/docs/concepts/cache.md +++ b/docs/concepts/cache.md @@ -92,7 +92,7 @@ uv determines the cache directory according to, in order: 2. The specific cache directory specified via `--cache-dir`, `UV_CACHE_DIR`, or [`tool.uv.cache-dir`](../reference/settings.md#cache-dir). 3. A system-appropriate cache directory, e.g., `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Unix and - `{FOLDERID_LocalAppData}\uv\cache` on Windows + `%LOCALAPPDATA%\uv\cache` on Windows !!! note diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 850428c56..0559d822e 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -72,7 +72,7 @@ uv run [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -366,7 +366,7 @@ uv init [OPTIONS] [PATH]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -487,7 +487,7 @@ uv add [OPTIONS] >
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -769,7 +769,7 @@ uv remove [OPTIONS] ...
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -1025,7 +1025,7 @@ uv sync [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -1281,7 +1281,7 @@ uv lock [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -1505,7 +1505,7 @@ uv tree [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -1831,7 +1831,7 @@ uv tool run [OPTIONS] [COMMAND]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -2073,7 +2073,7 @@ uv tool install [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -2315,7 +2315,7 @@ uv tool upgrade [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -2529,7 +2529,7 @@ uv tool list [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -2603,7 +2603,7 @@ uv tool uninstall [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -2690,7 +2690,7 @@ uv tool update-shell [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -2763,7 +2763,7 @@ Show the path to the uv tools directory. The tools directory is used to store environments and metadata for installed tools. -By default, tools are stored in the uv data directory at `$XDG_DATA_HOME/uv/tools` or `$HOME/.local/share/uv/tools` on Unix and `{FOLDERID_RoamingAppData}\uv\data\tools` on Windows. +By default, tools are stored in the uv data directory at `$XDG_DATA_HOME/uv/tools` or `$HOME/.local/share/uv/tools` on Unix and `%APPDATA%\uv\data\tools` on Windows. The tool installation directory may be overridden with `$UV_TOOL_DIR`. @@ -2795,7 +2795,7 @@ uv tool dir [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -2956,7 +2956,7 @@ uv python list [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -3061,7 +3061,7 @@ uv python install [OPTIONS] [TARGETS]...
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -3158,7 +3158,7 @@ uv python find [OPTIONS] [REQUEST]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -3257,7 +3257,7 @@ uv python pin [OPTIONS] [REQUEST]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -3338,7 +3338,7 @@ uv python pin [OPTIONS] [REQUEST] Show the uv Python installation directory. -By default, Python installations are stored in the uv data directory at `$XDG_DATA_HOME/uv/python` or `$HOME/.local/share/uv/python` on Unix and `{FOLDERID_RoamingAppData}\uv\data\python` on Windows. +By default, Python installations are stored in the uv data directory at `$XDG_DATA_HOME/uv/python` or `$HOME/.local/share/uv/python` on Unix and `%APPDATA%\uv\data\python` on Windows. The Python installation directory may be overridden with `$UV_PYTHON_INSTALL_DIR`. @@ -3352,7 +3352,7 @@ uv python dir [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -3443,7 +3443,7 @@ uv python uninstall [OPTIONS] ...
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -3587,7 +3587,7 @@ uv pip compile [OPTIONS] ...
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -3938,7 +3938,7 @@ uv pip sync [OPTIONS] ...
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -4229,7 +4229,7 @@ uv pip install [OPTIONS] |--editable
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -4572,7 +4572,7 @@ uv pip uninstall [OPTIONS] >
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -4684,7 +4684,7 @@ uv pip freeze [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -4781,7 +4781,7 @@ uv pip list [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -4900,7 +4900,7 @@ uv pip show [OPTIONS] [PACKAGE]...
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -4995,7 +4995,7 @@ uv pip tree [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -5103,7 +5103,7 @@ uv pip check [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -5214,7 +5214,7 @@ uv venv [OPTIONS] [NAME]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

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

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -5497,7 +5497,7 @@ uv cache prune [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--ci

Optimize the cache for persistence in a continuous integration environment, like GitHub Actions.

@@ -5574,7 +5574,7 @@ uv cache prune [OPTIONS] Show the cache directory. -By default, the cache is stored in `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Unix and `{FOLDERID_LocalAppData}\uv\cache` on Windows. +By default, the cache is stored in `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Unix and `%LOCALAPPDATA%\uv\cache` on Windows. When `--no-cache` is used, the cache is stored in a temporary directory and discarded when the process exits. @@ -5592,7 +5592,7 @@ uv cache dir [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -5673,7 +5673,7 @@ uv version [OPTIONS]
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

@@ -5776,7 +5776,7 @@ uv help [OPTIONS] [COMMAND]...
--cache-dir cache-dir

Path to the cache directory.

-

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.

+

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

--color color-choice

Control colors in output

diff --git a/docs/reference/settings.md b/docs/reference/settings.md index 254a7950f..25f80f258 100644 --- a/docs/reference/settings.md +++ b/docs/reference/settings.md @@ -4,7 +4,7 @@ Path to the cache directory. 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. +Linux, and `%LOCALAPPDATA%\uv\cache` on Windows. **Default value**: `None` diff --git a/uv.schema.json b/uv.schema.json index 123576428..6fe0959f9 100644 --- a/uv.schema.json +++ b/uv.schema.json @@ -5,7 +5,7 @@ "type": "object", "properties": { "cache-dir": { - "description": "Path to the cache directory.\n\nDefaults to `$HOME/Library/Caches/uv` on macOS, `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Linux, and `{FOLDERID_LocalAppData}\\uv\\cache` on Windows.", + "description": "Path to the cache directory.\n\nDefaults to `$HOME/Library/Caches/uv` on macOS, `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Linux, and `%LOCALAPPDATA%\\uv\\cache` on Windows.", "type": [ "string", "null"