From cd4855326c83888584face7065230b6a3d392cd9 Mon Sep 17 00:00:00 2001 From: Sergey Filimonov Date: Tue, 20 Aug 2024 21:01:27 -0600 Subject: [PATCH] Update README.md: Mention uvx is an alias for uv tool run (#6286) ## 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 --- README.md | 2 +- docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8aa256df8..f70ad17f9 100644 --- a/README.md +++ b/README.md @@ -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`. -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 $ uvx pycowsay 'hello world!' diff --git a/docs/index.md b/docs/index.md index e85ff6f66..2a8a58a01 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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`. -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 $ uvx pycowsay 'hello world!'