Skip to content

Environment variables#

uvは、次のコマンドライン引数を環境変数として受け入れます。

  • UV_INDEX_URL:--index-urlコマンドライン引数と同等です。設定されている場合、uvはパッケージを検索するためのベースインデックスとしてこのURLを使用します。
  • UV_EXTRA_INDEX_URL:--extra-index-urlコマンドライン引数と同等です。設定されている場合、uvはパッケージを検索するときに、このスペースで区切られたURLのリストを追加のインデックスとして使用します。
  • UV_CACHE_DIR:--cache-dirコマンドライン引数と同じです。設定されている場合、uvはデフォルトのキャッシュディレクトリの代わりにこのディレクトリをキャッシュに使用します。
  • UV_NO_CACHE:--no-cacheコマンドライン引数と同等です。設定されている場合、uvはどの操作にもキャッシュを使用しません。
  • UV_RESOLUTION:--resolutionコマンドライン引数と同じです。たとえば、lowest-directに設定すると、uvはすべての直接依存関係の最も互換性の低いバージョンをインストールします。
  • UV_PRERELEASE:--prereleaseコマンドライン引数と同じです。例えば、allowに設定すると、uvはすべての依存関係に対してプレリリースバージョンを許可します。
  • UV_SYSTEM_PYTHON:--systemコマンドライン引数と同等です。trueに設定すると、uvはシステムPATHで見つかった最初のPythonインタプリタを使用します。警告:UV_SYSTEM_PYTHON=trueは継続的インテグレーション(CI)またはコンテナ化された環境での使用を意図しており、システムPythonを変更すると予期しない動作を引き起こす可能性があるため、注意して使用する必要があります。
  • UV_PYTHON:--pythonコマンドライン引数と同じです。パスに設定すると、uvはすべての操作にこのPythonインタプリタを使用します。
  • UV_BREAK_SYSTEM_PACKAGES:--break-system-packagesコマンドライン引数と同等です。trueに設定すると、uvはシステムにインストールされたパッケージと競合するパッケージのインストールを許可します。警告:UV_BREAK_SYSTEM_PACKAGES=trueは継続的インテグレーション(CI)またはコンテナ化された環境での使用を意図しており、システムPythonを変更すると予期しない動作を引き起こす可能性があるため、注意して使用する必要があります。
  • UV_NATIVE_TLS:--native-tlsコマンドライン引数と同じです。trueに設定すると、uvはバンドルされたwebpki-rootsクレートの代わりにシステムのトラストストアを使用します。
  • UV_INDEX_STRATEGY:--index-strategyコマンドライン引数と同じです。例えば、unsafe-any-matchに設定されている場合、uvはパッケージを含む最初のインデックスURLに検索を限定するのではなく、すべてのインデックスURLで利用可能な特定のパッケージのバージョンを考慮します。
  • UV_REQUIRE_HASHES:--require-hashesコマンドライン引数と同等です。trueに設定すると、uvはすべての依存関係が要件ファイルで指定されたハッシュを持つことを要求します。
  • UV_CONSTRAINT:--constraintコマンドライン引数と同等です。設定されている場合、uvはこのファイルをコンストレイントファイルとして使用します。スペースで区切られたファイルのリストを使用します。
  • UV_BUILD_CONSTRAINT:--build-constraintコマンドライン引数と同等です。設定されている場合、uvはこのファイルをソース配布ビルドの制約として使用します。スペースで区切られたファイルのリストを使用します。
  • UV_OVERRIDE:--overrideコマンドライン引数と同等です。設定されている場合、uvはこのファイルをオーバーライドファイルとして使用します。スペースで区切られたファイルのリストを使用します。
  • UV_LINK_MODE:--link-modeコマンドライン引数と同等です。設定されている場合、uvはこれをリンクモードとして使用します。
  • UV_NO_BUILD_ISOLATION:--no-build-isolationコマンドライン引数と同じです。設定されている場合、uvはソース配布を構築するときに分離をスキップします。
  • UV_CUSTOM_COMPILE_COMMAND:--custom-compile-commandコマンドライン引数と同等です。uv pip compileによって生成されたrequirements.txtファイルの出力ヘッダーのuvを上書きするために使用されます。uv pip compileがラッパースクリプト内から呼び出されるユースケースで、出力ファイルにラッパースクリプトの名前を含めることを目的としています。
  • UV_KEYRING_PROVIDER:--keyring-providerコマンドライン引数と同じです。設定されている場合、uvはこの値をキーリングプロバイダとして使用します。
  • UV_CONFIG_FILE:--config-fileコマンドライン引数と同等です。設定ファイルとして使用するローカルのuv.tomlファイルへのパスを想定しています。
  • UV_NO_CONFIG:--no-configコマンドライン引数と同等です。設定されている場合、uvは現在のディレクトリ、親ディレクトリ、またはユーザ設定ディレクトリから設定ファイルを読み込みません。
  • UV_EXCLUDE_NEWER:--exclude-newerコマンドライン引数と同等です。設定されている場合、uvは指定された日付以降に公開されたディストリビューションを除外します。

いずれの場合も、対応するコマンドライン引数が環境変数よりも優先されます。

さらに、uvは次の環境変数を考慮します。

  • UV_CONCURRENT_DOWNLOADS:uvが同時に実行する処理中の同時ダウンロードの最大数を設定します。
  • UV_CONCURRENT_BUILDS:uvが同時にビルドするソース配布の最大数を設定します。
  • UV_CONCURRENT_INSTALLES:パッケージのインストールおよび解凍時に使用するスレッドの数を制御するために使用します。
  • UV_TOOL_DIR:uvが管理対象ツールを格納するディレクトリを指定します。
  • UV_PYTHON_INSTALL_DIR:uvが管理対象のPythonインストールを格納するディレクトリを指定するために使用します。
  • UV_PYTHON_INSTALL_MIRROR:Managed Pythonインストールは、python-build-standaloneからダウンロードされます。この変数をミラーURLに設定すると、Pythonインストールに別のソースを使用できます。提供されたURLは、例えばhttps://github.com/indygreg/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gzのhttps://github.com/indygreg/python-build-standalone/releases/downloadを置き換えます。
  • UV_PyPy_INSTALL_MIRROR:Managed PyPyインストールは、python.orgからダウンロードされます。この変数をミラーURLに設定すると、PyPyインストールに別のソースを使用できます。指定されたURLは、例えばhttps://downloads.python.org/PyPy/pypy3.8-v7.3.7-osx64.tar.bz2のhttps://downloads.python.org/PyPyに置き換わります。
  • XDG_CONFIG_HOME:Linux_および_macOSシステム上のuvユーザレベルの設定ディレクトリへのパスを指定するために使用します。
  • XDG_CACHE_HOME:Linuxシステム上でuvがキャッシュファイルを格納するディレクトリを指定するために使用します。
  • XDG_DATA_HOME:uvが管理対象のPythonインストールとLinuxシステム上の管理対象ツールを格納するディレクトリを指定するために使用されます。
  • XDG_BIN_HOME:実行可能ファイルがインストールされるディレクトリを指定します。
  • SSL_CERT_FILE:設定されている場合、uvはシステムのトラストストアではなく、このファイルを証明書バンドルとして使用します。
  • SSL_CLIENT_CERT:設定されている場合、uvはmTLS認証にこのファイルを使用します。これは、証明書とPEM形式の秘密鍵の両方を含む単一のファイルである必要があります。
  • RUST_LOG:設定されている場合、uvは--verbose出力のログレベルとしてこの値を使用します。tracing_subscriberクレートと互換性のある任意のフィルタを受け入れます。たとえば、RUST_LOG=traceはトレースレベルのロギングを有効にします。詳細については、tracing documentationを参照してください。
  • HTTP_PROXY、HTTPS_PROXY、ALL_PROXY:すべてのHTTP/HTTPSリクエストに使用するプロキシ。
  • HTTP_TIMEOUT(またはUV_HTTP_TIMEOUT):設定されている場合、uvはこの値(秒単位)をHTTP読み込みのタイムアウトとして使用します(デフォルト:30秒)。
  • PYC_INVALIDATION_MODE:--compileで実行するときに使用する検証モードです。参照:PycInvalidationMode
  • VIRTUAL_ENV:起動された仮想環境を検出するために使用されます。
  • CONDa_PREFIX:起動されたConda環境を検出するために使用されます。
  • PROMPT:(PowerShellではなく)Windowsコマンドプロンプトの使用を検出するために使用されます。
  • NU_VERSION:NuShellの使用を検出するために使用されます。
  • FISH_VERSION:フィッシュシェルの使用を検出するために使用されます。
  • BASH_VERSION:Bashシェルの使用を検出するために使用されます。
  • ZSH_VERSION:Zshシェルの使用を検出するために使用されます。
  • MACOSX_DEPLOYMENT_TARGET:--python-platform macOSおよび関連バリアントとともに使用して、デプロイメントターゲット(つまり、サポートされている最小のmacOSバージョン)を設定します。デフォルトは12.0で、執筆時点で最も古い非EOL macOSバージョンです。
  • NO_COLOR:色を無効にします。FORCE_COLORより優先されます。no-color.orgを参照してください。
  • FORCE_COLOR:TTYサポートに関係なく色を強制します。force-color.orgを参照してください。