mirror of
https://github.com/astral-sh/uv.git
synced 2025-08-03 02:22:19 +00:00
docs: add alias context to uv tool run --help
command (#7695)
<!-- 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 <contact@zanie.dev>
This commit is contained in:
parent
37273cb4bc
commit
e8b8d236a1
1 changed files with 5 additions and 0 deletions
|
@ -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(
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue