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

Update README.md: Mention uvx is an alias for uv tool run (#6286) 

<!--
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

I think it's important to clarify that `uvx` is simply an alias for `uv
tool run`. This distinction helps avoid confusion about when to use `uv`
versus `uvx`. I thought the [blog
post](https://astral.sh/blog/uv-unified-python-packaging) explained this
well.

Just something that I ran into, I understand others may have a different
perspective!

## Test Plan

n/a

---------

Co-authored-by: Zanie Blue <contact@zanie.dev>
This commit is contained in:
Sergey Filimonov 2024-08-20 21:01:27 -06:00 committed by GitHub
parent b21fa38909
commit cd4855326c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -99,7 +99,7 @@ See the [project documentation](https://docs.astral.sh/uv/guides/projects/) to g
uv executes and installs command-line tools provided by Python packages, similar to `pipx`. uv executes and installs command-line tools provided by Python packages, similar to `pipx`.
Run a tool in an ephemeral environment with `uvx`: Run a tool in an ephemeral environment using `uvx` (an alias for `uv tool run`):
```console ```console
$ uvx pycowsay 'hello world!' $ uvx pycowsay 'hello world!'

2
docs/index.md
View File

@ -83,7 +83,7 @@ See the [project guide](./guides/projects.md) to get started.
uv executes and installs command-line tools provided by Python packages, similar to `pipx`. uv executes and installs command-line tools provided by Python packages, similar to `pipx`.
Run a tool in an ephemeral environment with `uvx`: Run a tool in an ephemeral environment using `uvx` (an alias for `uv tool run`):
```console ```console
$ uvx pycowsay 'hello world!' $ uvx pycowsay 'hello world!'