Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document the tools directory (#6228) 

As in https://github.com/astral-sh/uv/pull/6227
This commit is contained in:
Zanie Blue 2024-08-19 14:46:19 -05:00 committed by GitHub
parent b7c9ad981d
commit cc8fbedd37
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
crates/uv-cli/src/lib.rs
View File

@ -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),
}

4
docs/reference/cli.md
View File

@ -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.
<h3 class="cli-reference">Usage</h3>