Skip to content

Commit

Permalink
docs: add alias context to uv tool run --help command (astral-sh#7695)
Browse files Browse the repository at this point in the history
<!--
Thank you for contributing to uv! To help us out with reviewing, please
consider the following:

- Does this pull request include a summary of the change? (See below.)
- Does this pull request include a descriptive title?
- Does this pull request include references to any relevant issues?
-->

## Summary

<!-- What's the purpose of the change? What does it do, and why? -->
- Adds detail to the `uv tool run --help` CLI that lets users know about
the shorthand, `uvx`

## Test Plan

<!-- How was it tested? -->
Building and running CLI
```
…📝✓] via 🐋 orbstack via 🎁 v0.4.16 via  pyenv via ⚙️ v1.81.0on ☁️  (us-east-2) took 3s 
➜ ./target/debug/uv tool run --help
Run a command provided by a Python package. Also available via the alias `uvx`.

Usage: uv tool run [OPTIONS] [COMMAND]

...

You can also use `uvx` as an alias for `uv tool run`. 
Use `uv help tool run` for more details.
```

---------

Co-authored-by: Zanie Blue <[email protected]>
  • Loading branch information
JacobCoffee and zanieb authored Oct 8, 2024
1 parent 37273cb commit e8b8d23
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions crates/uv-cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3262,6 +3262,11 @@ pub enum ToolCommand {
///
/// Packages are installed into an ephemeral virtual environment in the uv
/// cache directory.
#[command(
after_help = "Use `uvx` as a shortcut for `uv tool run`.\n\n\
Use `uv help tool run` for more details.",
after_long_help = ""
)]
Run(ToolRunArgs),
/// Hidden alias for `uv tool run` for the `uvx` command
#[command(
Expand Down

0 comments on commit e8b8d23

Please sign in to comment.