Using tools | uv (original) (raw)

Many Python packages provide applications that can be used as tools. uv has specialized support for easily invoking and installing tools.

The uvx command invokes a tool without installing it.

For example, to run ruff:

Note

This is exactly equivalent to:

uvx is provided as an alias for convenience.

Arguments can be provided after the tool name:

[](#%5F%5Fcodelineno-2-1)$ uvx pycowsay hello from uv [](#%5F%5Fcodelineno-2-2) [](#%5F%5Fcodelineno-2-3) ------------- [](#%5F%5Fcodelineno-2-4)< hello from uv > [](#%5F%5Fcodelineno-2-5) ------------- [](#%5F%5Fcodelineno-2-6) \ ^__^ [](#%5F%5Fcodelineno-2-7) \ (oo)\_______ [](#%5F%5Fcodelineno-2-8) (__)\ )\/\ [](#%5F%5Fcodelineno-2-9) ||----w | [](#%5F%5Fcodelineno-2-10) || ||

Tools are installed into temporary, isolated environments when using uvx.

Note

If you are running a tool in a project and the tool requires that your project is installed, e.g., when using pytest or mypy, you'll want to useuv run instead of uvx. Otherwise, the tool will be run in a virtual environment that is isolated from your project.

If your project has a flat structure, e.g., instead of using a src directory for modules, the project itself does not need to be installed and uvx is fine. In this case, usinguv run is only beneficial if you want to pin the version of the tool in the project's dependencies.

Commands with different package names

When uvx ruff is invoked, uv installs the ruff package which provides the ruff command. However, sometimes the package and command names differ.

The --from option can be used to invoke a command from a specific package, e.g., http which is provided by httpie:

Requesting specific versions

To run a tool at a specific version, use command@<version>:

To run a tool at the latest version, use command@latest:

The --from option can also be used to specify package versions, as above:

[](#%5F%5Fcodelineno-6-1)$ uvx --from 'ruff==0.3.0' ruff check

Or, to constrain to a range of versions:

[](#%5F%5Fcodelineno-7-1)$ uvx --from 'ruff>0.2.0,<0.3.0' ruff check

Note the @ syntax cannot be used for anything other than an exact version.

The --from option can be used to run a tool with extras:

[](#%5F%5Fcodelineno-8-1)$ uvx --from 'mypy[faster-cache,reports]' mypy --xml-report mypy_report

This can also be combined with version selection:

[](#%5F%5Fcodelineno-9-1)$ uvx --from 'mypy[faster-cache,reports]==1.13.0' mypy --xml-report mypy_report

Requesting different sources

The --from option can also be used to install from alternative sources.

For example, to pull from git:

[](#%5F%5Fcodelineno-10-1)$ uvx --from git+https://github.com/httpie/cli httpie

You can also pull the latest commit from a specific named branch:

[](#%5F%5Fcodelineno-11-1)$ uvx --from git+https://github.com/httpie/cli@master httpie

Or pull a specific tag:

Or even a specific commit:

[](#%5F%5Fcodelineno-13-1)$ uvx --from git+https://github.com/httpie/cli@2843b87 httpie

Commands with plugins

Additional dependencies can be included, e.g., to include mkdocs-material when running mkdocs:

[](#%5F%5Fcodelineno-14-1)$ uvx --with mkdocs-material mkdocs --help

If a tool is used often, it is useful to install it to a persistent environment and add it to thePATH instead of invoking uvx repeatedly.

Tip

uvx is a convenient alias for uv tool run. All of the other commands for interacting with tools require the full uv tool prefix.

To install ruff:

When a tool is installed, its executables are placed in a bin directory in the PATH which allows the tool to be run without uv. If it's not on the PATH, a warning will be displayed anduv tool update-shell can be used to add it to the PATH.

After installing ruff, it should be available:

Unlike uv pip install, installing a tool does not make its modules available in the current environment. For example, the following command will fail:

[](#%5F%5Fcodelineno-17-1)$ python -c "import ruff"

This isolation is important for reducing interactions and conflicts between dependencies of tools, scripts, and projects.

Unlike uvx, uv tool install operates on a package and will install all executables provided by the tool.

For example, the following will install the http, https, and httpie executables:

Additionally, package versions can be included without --from:

[](#%5F%5Fcodelineno-19-1)$ uv tool install 'httpie>0.1.0'

And, similarly, for package sources:

[](#%5F%5Fcodelineno-20-1)$ uv tool install git+https://github.com/httpie/cli

As with uvx, installations can include additional packages:

[](#%5F%5Fcodelineno-21-1)$ uv tool install mkdocs --with mkdocs-material

To upgrade a tool, use uv tool upgrade:

Tool upgrades will respect the version constraints provided when installing the tool. For example,uv tool install ruff >=0.3,<0.4 followed by uv tool upgrade ruff will upgrade Ruff to the latest version in the range >=0.3,<0.4.

To instead replace the version constraints, re-install the tool with uv tool install:

[](#%5F%5Fcodelineno-23-1)$ uv tool install ruff>=0.4

To instead upgrade all tools:

Requesting Python versions

By default, uv will use your default Python interpreter (the first it finds) when when running, installing, or upgrading tools. You can specify the Python interpreter to use with the --pythonoption.

For example, to request a specific Python version when running a tool:

Or, when installing a tool:

[](#%5F%5Fcodelineno-26-1)$ uv tool install --python 3.10 ruff

Or, when upgrading a tool:

[](#%5F%5Fcodelineno-27-1)$ uv tool upgrade --python 3.10 ruff

For more details on requesting Python versions, see thePython version concept page..

Legacy Windows Scripts

Tools also support runninglegacy setuptools scripts. These scripts are available via $(uv tool dir)\<tool-name>\Scripts when installed.

Currently only legacy scripts with the .ps1, .cmd, and .bat extensions are supported.

For example, below is an example running a Command Prompt script.

[](#%5F%5Fcodelineno-28-1)$ uv tool run --from nuitka==2.6.7 nuitka.cmd --version

In addition, you don't need to specify the extension. uvx will automatically look for files ending in .ps1, .cmd, and .bat in that order of execution on your behalf.

[](#%5F%5Fcodelineno-29-1)$ uv tool run --from nuitka==2.6.7 nuitka --version

Next steps

To learn more about managing tools with uv, see the Tools concept page and the command reference.

Or, read on to learn how to work on projects.