From cc8fbedd375012cf8237cbc4e3d432c886a3fdc4 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Mon, 19 Aug 2024 14:46:19 -0500 Subject: [PATCH] Document the tools directory (#6228) As in https://github.com/astral-sh/uv/pull/6227 --- crates/uv-cli/src/lib.rs | 12 ++++++++---- docs/reference/cli.md | 4 ++++ 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index cd3a98278..57177b51e 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -2713,11 +2713,15 @@ pub enum ToolCommand { UpdateShell, /// Show the path to the uv tools directory. /// - /// The tools directory is used to store environments and metadata for - /// installed tools. + /// The tools directory is used to store environments and metadata for installed tools. /// - /// To instead view the directory uv installs executables into, use the - /// `--bin` flag. + /// 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. + /// + /// The tool installation directory may be overridden with `$UV_TOOL_DIR`. + /// + /// To instead view the directory uv installs executables into, use the `--bin` flag. Dir(ToolDirArgs), } diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 47315486c..873b34bf7 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -2757,6 +2757,10 @@ 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. + +The tool installation directory may be overridden with `$UV_TOOL_DIR`. + To instead view the directory uv installs executables into, use the `--bin` flag.

Usage