Skip to content

環境変数

uvは以下の環境変数を尊重します:

  • UV_DEFAULT_INDEX: コマンドライン引数 --default-index と同等です。設定されている場合、uvは このURLをパッケージ検索時のデフォルトインデックスとして使用します。
  • UV_INDEX: コマンドライン引数 --index と同等です。設定されている場合、uvは 空白で区切られたURLのリストをパッケージ検索時の追加インデックスとして使用します。
  • UV_INDEX_URL: コマンドライン引数 --index-url と同等です。設定されている場合、uvは このURLをパッケージ検索時のデフォルトインデックスとして使用します。 (非推奨:代わりに UV_DEFAULT_INDEX を使用してください。)
  • UV_EXTRA_INDEX_URL: コマンドライン引数 --extra-index-url と同等です。設定されている場合、uvは 空白で区切られたURLのリストをパッケージ検索時の追加インデックスとして使用します。 (非推奨:代わりに UV_INDEX を使用してください。)
  • UV_FIND_LINKS: コマンドライン引数 --find-links と同等です。設定されている場合、uvは カンマで区切られた追加のパッケージ検索場所のリストを使用します。
  • 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はすべての依存関係に requirements ファイル内でハッシュが指定されていることを要求します。
  • 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 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_PYTHON_PREFERENCE: コマンドライン引数 --python-preference と同等です。uvがシステムまたは管理されたPythonバージョンを優先すべきかどうかを指定します。
  • UV_PYTHON_DOWNLOADS: python-downloads 設定と同等で、無効にすると --no-python-downloads オプションと同等になります。uvがPythonのダウンロードを許可するかどうかを指定します。
  • UV_COMPILE_BYTECODE: コマンドライン引数 --compile-bytecode と同等です。設定されている場合、uvは インストール後にPythonソースファイルをバイトコードにコンパイルします。
  • UV_PUBLISH_URL: コマンドライン引数 --publish-url と同等です。uv publish で使用するインデックスのアップロードエンドポイントのURLです。
  • UV_PUBLISH_TOKEN: uv publish のコマンドライン引数 --token と同等です。設定されている場合、uvはこのトークン(ユーザー名 __token__ と共に)を使用して公開します。
  • UV_PUBLISH_USERNAME: uv publish のコマンドライン引数 --username と同等です。設定されている場合、uvは公開にこのユーザー名を使用します。
  • UV_PUBLISH_PASSWORD: uv publish のコマンドライン引数 --password と同等です。設定されている場合、uvは公開にこのパスワードを使用します。
  • UV_PUBLISH_CHECK_URL: インデックス上にファイルが既に存在する場合、ファイルをアップロードしません。値はインデックスのURLです。
  • UV_NO_SYNC: コマンドライン引数 --no-sync と同等です。設定されている場合、uvは 環境の更新をスキップします。
  • UV_LOCKED: コマンドライン引数 --locked と同等です。設定されている場合、uvは uv.lock が変更されていないことを確認します。
  • UV_FROZEN: コマンドライン引数 --frozen と同等です。設定されている場合、uvは uv.lock ファイルを更新せずに実行します。
  • UV_PREVIEW: コマンドライン引数 --preview と同等です。プレビューモードを有効にします。
  • UV_GITHUB_TOKEN: セルフアップデートのための --token 引数と同等です。認証用のGitHubトークンです。
  • UV_VERIFY_HASHES: コマンドライン引数 --verify-hashes と同等です。含まれるハッシュを検証します。
  • UV_INSECURE_HOST: コマンドライン引数 --allow-insecure-host と同等です。
  • UV_CONCURRENT_DOWNLOADS: uvが同時に実行する最大のインフライトダウンロード数を設定します。
  • UV_CONCURRENT_BUILDS: uvが同時にビルドするソースディストリビューションの最大数を設定します。
  • UV_CONCURRENT_INSTALLS: パッケージのインストールおよび解凍時に使用するスレッド数を制御します。
  • UV_NO_PROGRESS: すべての進行状況出力を無効にします。例えば、スピナーやプログレスバー。
  • UV_TOOL_DIR: uvが管理ツールを保存するディレクトリを指定します。
  • UV_TOOL_BIN_DIR: ツール実行可能ファイルをインストールするための "bin" ディレクトリを指定します。
  • UV_PROJECT_ENVIRONMENT: プロジェクト仮想環境に使用するディレクトリへのパスを指定します。 詳細は プロジェクトのドキュメント を参照してください。
  • UV_PYTHON_BIN_DIR: 管理されたPython実行可能ファイルへのリンクを配置するディレクトリを指定します。
  • UV_PYTHON_INSTALL_DIR: 管理されたPythonインストールを保存するディレクトリを指定します。
  • UV_PYTHON_INSTALL_MIRROR: 管理された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 を置き換えます。 ディストリビューションは file:// URLスキームを使用してローカルディレクトリから読み取ることができます。
  • UV_PYPY_INSTALL_MIRROR: 管理されたPyPyインストールは python.org からダウンロードされます。この変数をミラーURLに設定することで、 PyPyインストールの別のソースを使用できます。提供されたURLは、 例えば https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2 内の https://downloads.python.org/pypy を置き換えます。 ディストリビューションは file:// URLスキームを使用してローカルディレクトリから読み取ることができます。
  • UV_NO_WRAP: 診断のための行の折り返しを無効にするために使用します。
  • UV_STACK_SIZE: uvで使用するスタックサイズを制御するために使用します。通常、デバッグモードのWindowsでより関連性があります。
  • UV_INDEX_{name}_USERNAME: HTTP Basic認証のユーザー名のための環境変数キーを生成します。
  • UV_INDEX_{name}_PASSWORD: HTTP Basic認証のパスワードのための環境変数キーを生成します。
  • XDG_CONFIG_DIRS: Unixシステム上のシステムレベルの設定ディレクトリへのパス。
  • SYSTEMDRIVE: Windowsシステム上のシステムレベルの設定ディレクトリへのパス。
  • XDG_CONFIG_HOME: Unixシステム上のユーザーレベルの設定ディレクトリへのパス。
  • XDG_CACHE_HOME: Unixシステム上のキャッシュディレクトリへのパス。
  • XDG_DATA_HOME: 管理されたPythonインストールおよびツールを保存するためのディレクトリへのパス。
  • XDG_BIN_HOME: 実行可能ファイルがインストールされるディレクトリへのパス。
  • SSL_CERT_FILE: SSL接続用のカスタム証明書バンドルファイルのパス。
  • SSL_CLIENT_CERT: 設定されている場合、uvはこのファイルをmTLS認証に使用します。 これは、PEM形式で証明書と秘密鍵の両方を含む単一のファイルである必要があります。
  • HTTP_PROXY: HTTPリクエスト用のプロキシ。
  • HTTPS_PROXY: HTTPSリクエスト用のプロキシ。
  • ALL_PROXY: すべてのネットワークリクエスト用の一般的なプロキシ。
  • UV_HTTP_TIMEOUT: HTTPリクエストのタイムアウト(秒単位)。(デフォルト:30秒)
  • UV_REQUEST_TIMEOUT: HTTPリクエストのタイムアウト(秒単位)。 UV_HTTP_TIMEOUT と同等です。
  • HTTP_TIMEOUT: HTTPリクエストのタイムアウト(秒単位)。 UV_HTTP_TIMEOUT と同等です。
  • PYC_INVALIDATION_MODE: --compile オプションで実行するときに使用する検証モード。 PycInvalidationMode を参照してください。
  • VIRTUAL_ENV: アクティブな仮想環境を検出するために使用されます。
  • CONDA_PREFIX: アクティブなConda環境を検出するために使用されます。
  • CONDA_DEFAULT_ENV: アクティブなConda環境がベース環境かどうかを判断するために使用されます。
  • VIRTUAL_ENV_DISABLE_PROMPT: 仮想環境がアクティブ化される前に 1 に設定されている場合、 仮想環境の名前がターミナルプロンプトに先頭に追加されません。
  • PROMPT: Windowsコマンドプロンプトの使用を検出するために使用されます(PowerShellとは対照的に)。
  • NU_VERSION: NuShell の使用を検出するために使用されます。
  • FISH_VERSION: Fishシェルの使用を検出するために使用されます。
  • BASH_VERSION: Bashシェルの使用を検出するために使用されます。
  • ZSH_VERSION: Zshシェルの使用を検出するために使用されます。
  • ZDOTDIR: Zshが使用されている場合にどの .zshenv を使用するかを判断するために使用されます。
  • KSH_VERSION: Kshシェルの使用を検出するために使用されます。
  • MACOSX_DEPLOYMENT_TARGET: --python-platform macos および関連するバリアントで使用され、 デプロイメントターゲット(つまり、サポートされる最低限のmacOSバージョン)を設定します。 記載時点での最も最近の非EOL macOSバージョン 12.0 にデフォルト設定されています。
  • NO_COLOR: 色付き出力を無効にします( FORCE_COLOR より優先されます)。 no-color.org を参照してください。
  • FORCE_COLOR: ターミナルのサポートに関係なく色付き出力を強制します。 force-color.org を参照してください。
  • CLICOLOR_FORCE: anstyle を介して色を制御するために使用します。
  • PATH: 標準の PATH 環境変数。
  • HOME: 標準の HOME 環境変数。
  • SHELL: 標準の SHELL POSIX 環境変数。
  • PWD: 標準の PWD POSIX 環境変数。
  • LOCALAPPDATA: Microsoft StoreのPythonインストールを探すために使用されます。
  • GITHUB_ACTIONS: uv publish を介した信頼された公開に使用されます。
  • ACTIONS_ID_TOKEN_REQUEST_URL: uv publish を介した信頼された公開に使用されます。oidcトークンURLを含みます。
  • ACTIONS_ID_TOKEN_REQUEST_TOKEN: uv publish を介した信頼された公開に使用されます。oidcリクエストトークンを含みます。
  • PYTHONPATH: Pythonモジュール検索パスにディレクトリを追加します(例:PYTHONPATH=/path/to/modules)。
  • NETRC: .netrcファイルの場所を設定するために使用します。
  • PAGER: 標準の PAGER POSIX 環境変数。uv が適切なページャーを設定するために使用します。
  • JPY_SESSION_NAME: Jupyterノートブック内で実行されていることを検出するために使用されます。
  • TRACING_DURATIONS_FILE: tracing-durations-export 機能を介してトレースの期間ファイルを作成するために使用します。
  • RUST_LOG: 設定されている場合、uvはこの値を --verbose 出力のログレベルとして使用します。 tracing_subscriber クレートと互換性のあるフィルターを受け入れます。 例えば:
  • RUST_LOG=uv=debug はコマンドラインに --verbose を追加するのと同等です。
  • RUST_LOG=trace はトレースレベルのログを有効にします。 詳細は tracingドキュメント を参照してください。
  • UV_ENV_FILE: uv run コマンドを実行するときに環境変数をロードする .env ファイル。
  • UV_NO_ENV_FILE: uv run コマンドを実行するときに .env ファイルを無視します。
  • UV_INSTALLER_GITHUB_BASE_URL: スタンドアロンインストーラーと self update 機能を使用してuvをダウンロードするURLで、 デフォルトのGitHub URLの代わりに使用します。
  • UV_INSTALLER_GHE_BASE_URL: スタンドアロンインストーラーと self update 機能を使用してuvをダウンロードするURLで、 デフォルトのGitHub Enterprise URLの代わりに使用します。
  • UV_INSTALL_DIR: スタンドアロンインストーラーと self update 機能を使用してuvをインストールするディレクトリ。 デフォルトは ~/.local/bin です。
  • UV_UNMANAGED_INSTALL: CIのようなエフェメラル環境でuvを特定のパスにインストールし、インストーラーがシェルプロファイルや環境変数を変更するのを防ぐために使用します。
  • INSTALLER_NO_MODIFY_PATH: スタンドアロンインストーラーと self update 機能を使用してuvをインストールするときに PATH 環境変数を変更しないようにします。