Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the tools directory #6228

Merged
merged 1 commit into from
Aug 19, 2024
Merged

Document the tools directory #6228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions crates/uv-cli/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
}

Expand Down
4 changes: 4 additions & 0 deletions docs/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading