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.

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

docs: add alias context to uv tool run --help command #7695

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

JacobCoffee
Copy link
Contributor

Summary

  • Adds detail to the uv tool run --help CLI that lets users know about the shorthand, uvx

Test Plan

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.

Comment on lines 3178 to 3179
about = "Run a command provided by a Python package. Also available via the alias `uvx`.",
after_help = "You can also use `uvx` as an alias for `uv tool run`. \n\
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh there's already a comment for this above in the long help i.e. uv help tool run. I'm a bit hesitant to add it to the short help?

Copy link
Contributor Author

@JacobCoffee JacobCoffee Sep 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry! Do you mean Run a command provided by a Python package or just that we don't need a second short note about uvx being available in the short help? If so feel free to close :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants