Skip to content

Using tools#

多くのPythonパッケージには、ツールとして使用できるアプリケーションが用意されています。uvには、ツールを簡単に呼び出してインストールするための特別なサポートがあります。

Running tools#

uvxコマンドはツールをインストールせずに起動します。

例えば、ruffを実行するには:

$ uvx ruff

Note

This is exactly equivalent to:

$ uv tool run ruff

uvx is provided as an alias for convenience.

ツール名の後に引数を指定できます。:

$ uvx pycowsay hello from uv

  -------------
< hello from uv >
  -------------
   \   ^__^
    \  (oo)\_______
       (__)\       )\/\
           ||----w |
           ||     ||

uvxを使用すると、ツールは一時的な隔離された環境にインストールされます。

Commands with different package names#

uvx ruffが起動されると、uvはruffコマンドを提供するruffパッケージをインストールします。

ただし、パッケージ名とコマンド名が異なる場合があります。

--fromオプションは、例えばhttpieが提供するhttpのように、特定のパッケージからコマンドを呼び出すために使用できます。:

$ uvx --from httpie http

Requesting specific versions#

特定のバージョンでツールを実行するには、command@<version>を使用します。:

$ uvx ruff@0.3.0 check

上記のように、--fromオプションを使用してパッケージのバージョンを指定することもできます。:

$ uvx --from 'ruff==0.3.0' ruff check

または、バージョンの範囲に制限するには、次の手順に従います。:

$ uvx --from 'ruff>0.2.0,<0.3.0' ruff check

@構文は正確なバージョン以外には使えないことに注意してください。

Requesting different sources#

--fromオプションを使用して、別のソースからインストールすることもできます。

たとえば、gitからpullするには次のようにします。:

$ uvx --from git+https://github.com/httpie/cli httpie

Commands with plugins#

追加の依存関係を含めることができます。たとえば、mkdocsを実行するときにmkdocs-materialを含めることができます。:

$ uvx --with mkdocs-material mkdocs --help

Installing tools#

ツールが頻繁に使用される場合は、uvxを繰り返し呼び出すのではなく、永続的な環境にインストールしてPATHに追加すると便利です。

ruffをインストールするには:

$ uv tool install ruff

ツールがインストールされると、その実行可能ファイルはPATHのbinディレクトリに配置され、uvなしでツールを実行できるようになります。PATHにない場合は警告が表示され、uv tool update-shellを使用してPATHに追加できます。

ruffをインストールすると、利用可能になります。:

$ ruff --version

uv pip installとは異なり、ツールをインストールしても、そのモジュールは現在の環境で使用可能になりません。たとえば、次のコマンドは失敗します。:

$ python -c "import ruff"

この分離は、ツール、スクリプト、およびプロジェクトの依存関係間の相互作用や競合を減らすために重要です。。

uvxとは異なり、uv tool installはa_package_上で動作し、ツールが提供するすべての実行可能ファイルをインストールします。

例えば、以下はhttp、https、httpie実行可能ファイルをインストールします。:

$ uv tool install httpie

さらに、パッケージのバージョンは--fromなしで含めることができます。:

$ uv tool install 'httpie>0.1.0'

同様に、パッケージソースの場合は次のようになります。:

$ uv tool install git+https://github.com/httpie/cli

uvxと同様に、インストールには追加のパッケージを含めることができます。:

$ uv tool install mkdocs --with mkdocs-material

Upgrading tools#

ツールをアップグレードするには、uv tool upgradeを使用します。:

$ uv tool upgrade ruff

ツールのアップグレードでは、ツールのインストール時に指定されたバージョンの制約が考慮されます。たとえば、uv tool install ruff>=0.3,<0.4の後にuv tool upgrade ruffを指定すると、Ruffは>=0.3,<0.4の範囲の最新バージョンにアップグレードされます。

代わりにバージョン制約を置き換えるには、uv tool installでツールを再インストールします。:

$ uv tool install ruff>=0.4

代わりにすべてのツールをアップグレードするには:

$ uv tool upgrade --all

Next steps#

uvによるツールの管理の詳細については、Tools conceptページおよびcommand referenceを参照してください。

または、プロジェクトで作業するの方法を引き続きお読みください。