Features#
uvは、Pythonのインストールや単純なスクリプトへのハッキングから、複数のPythonバージョンとプラットフォームをサポートする大規模なプロジェクトでの作業まで、Python開発に不可欠な機能を提供します。
uvのインタフェースは複数のセクションに分割することができ、それぞれを個別に使用することも、まとめて使用することもできます。
Python versions#
Python自体のインストールと管理。
uv python install:Pythonバージョンをインストールします。
uv python list:利用可能なPythonのバージョンを表示します。
uv python find:インストールされているPythonのバージョンを見つけます。
uv python pin:現在のプロジェクトを特定のPythonバージョンを使用するように固定します。
uv python uninstall:Pythonバージョンをアンインストールします。
開始するには、guide on installing Pythonを参照してください。
Scripts#
スタンドアロンのPythonスクリプト(例:example.py)を実行します。
uv run:スクリプトを実行します。
開始するには、guide on running scriptsを参照してください。
Projects#
Pythonプロジェクトの作成と作業(例:pyproject.tomlを使用)。
uv init:新しいPythonプロジェクトを作成します。
uv add:プロジェクトに依存関係を追加します。
uv remove:プロジェクトから依存関係を削除します。
uv sync:プロジェクトの依存関係を環境と同期させます。
uv lock:プロジェクトの依存関係のロックファイルを作成します。
uv run:プロジェクト環境でコマンドを実行します。
uv tree:プロジェクトの依存関係ツリーを表示します。
開始するには、guide on projectsを参照してください。
Tools#
ruffやblackなどのPythonパッケージインデックスに公開されたツールの実行とインストール。
uvx/uv tool run:ツールを一時的な環境で実行します。
uv tool install:ユーザ全体でツールをインストールします。
uv tool uninstall:ツールをアンインストールします。
uv tool list:インストールされているツールを一覧表示します。
uv tool update-shell:シェルを更新してツールの実行可能ファイルを含めます。
開始するには、guide on toolsを参照してください。
The pip interface#
環境とパッケージの手動管理 - レガシーワークフローや、高レベルのコマンドでは十分な制御が得られない場合に使用することを目的としています。
仮想環境の作成(venvとvirtualenvの置き換え):
uv venv:新しい仮想環境を作成します。
詳細については、using environmentsのドキュメントを参照してください。
環境でのパッケージの管理(pipとpipdeptreeを置き換える):
uv pip install:現在の環境にパッケージをインストールします。
uv pip show:インストールされているパッケージの詳細を表示します。
uv pip freeze:インストールされているパッケージとそのバージョンを一覧表示します。
uv pip check:現在の環境に互換性のあるパッケージがあることをチェックします。
uv pip list:インストールされているパッケージを一覧表示します。
uv pip uninstall:パッケージをアンインストールします。
uv pip tree:環境の依存関係ツリーを表示します。
詳細については、managing packagesのドキュメントを参照してください。
環境でパッケージをロックする(pip-toolsを置き換える):
uv pip compile:ロックファイルに要件をコンパイルします。
uv pip sync:環境をロックファイルと同期させます。
詳細については、locking environmentsのドキュメントを参照してください。
Important
これらのコマンドは、ベースとなるツールのインタフェースや動作を正確に実装しているわけではありません。一般的なワークフローから逸脱すればするほど、違いに遭遇する可能性が高くなります。詳細については、pip-compatibility guideを参照してください。
Utility#
uvの状態(キャッシュ、ストレージディレクトリなど)の管理と検査、または自己更新の実行:
uv cache clean:キャッシュエントリを削除します。
uv cache prune:古くなったキャッシュエントリを削除します。
uv cache dir:uvキャッシュディレクトリのパスを表示します。
uv tool dir:uvツールのディレクトリパスを表示します。
uv python dir:uvがインストールされているPythonのバージョンパスを表示します。
uv self update:UVを最新バージョンに更新します。
Next steps#
Read the guides for an introduction to each feature, check out concept pages for in-depth details about uv's features, or learn how to get help if you run into any problems.
各機能の概要についてはguidesを、uvの機能の詳細についてはconceptページを、問題が発生した場合にはget helpの方法を参照してください。