インストール

RyeはRustで構築されています。手動でコンパイルしてインストールすることも、バイナリ配布からインストールすることもできます。Linux、macOS、Windowsをサポートしています。

Ryeのインストール

Ryeはユーザーごとにインストールされ、自己管理されます。ホームディレクトリのフォルダにインストールされ、そこで自己管理されます。

LinuxmacOSWindowsセルフコンパイル

インストールするには、curlコマンドを実行します。このコマンドは、オペレーティングシステムとCPUアーキテクチャに適したバイナリをインストールします。

curl -sSf https://rye.dokyumento.jp/get | bash

あるいは、この方法が信頼できない場合は、最新のリリースバイナリをダウンロードできます。初回実行時に自動的にインストールされます。

Intel/AMD (x86-64)向けrye-x86_64-linux.gz。
ARM64向けrye-aarch64-linux.gz。

gunzip rye-x86_64-linux.gz
chmod +x ./rye-x86_64-linux
./rye-x86_64-linux

インストールするには、curlコマンドを実行します。このコマンドは、オペレーティングシステムとCPUアーキテクチャに適したバイナリをインストールします。

curl -sSf https://rye.dokyumento.jp/get | bash

あるいは、この方法が信頼できない場合は、最新のリリースバイナリをダウンロードできます。初回実行時に自動的にインストールされます。

Apple Silicon (M1/M2/M3) (ARM64)向けrye-aarch64-macos.gz。
Intelプロセッサ(x86-64)向けrye-x86_64-macos.gz。

gunzip rye-aarch64-macos.gz
chmod +x ./rye-aarch64-macos
./rye-aarch64-macos

WindowsにRyeをインストールするには、最新のリリースをダウンロードしてバイナリを実行します。初回実行時に自動的にインストールされます。Ryeを使用する場合、およびインストールを開始する前に、「開発者モード」を有効にすることを強くお勧めします。詳細はこちら。

64ビット(x86-64)向けrye-x86_64-windows.exe。
32ビット(x86)向けrye-x86-windows.exe。

注記

Ryeはまだ署名付きバイナリを使用していないため、ダウンロードした実行可能ファイルの実行を許可する必要があります。明らかな方法がない場合は、表示されるエラーメッセージの「詳細情報」をクリックし、「実行」をクリックしてください。

さらに、時々「Bearfoos」に関するトロイの木馬の警告が表示されることがあります。これは誤検知です。詳細については、Windows Bearfoos virus associated with ryeのディスカッションを参照してください。

RustとCargoがインストールされている必要があります。インストールされていない場合は、rustupを使用してマシンにインストールできます。

その後、cargo経由でRyeをインストールできます

cargo install --git https://github.com/astral-sh/rye rye

Ryeは、必要に応じて適切なPythonツールチェーンを自動的にダウンロードします。これについて詳しくは、ツールチェーンについて読むをご覧ください。特定のバージョンをインストールするには、GitHubからバイナリを直接ダウンロードしてください。

カスタムインストール

一部のプラットフォームでは、インストールエクスペリエンスのカスタマイズが限定的にサポートされています。これは、Ryeが提供するPythonインタプリタがサポートされていないAlpineなど、特定のLinux環境で必要になる場合があります。

LinuxmacOSWindows

bashにパイプされるインストールスクリプトは、いくつかの環境変数でカスタマイズできます

RYE_VERSION

デフォルトはlatestです。特定のバージョンをインストールするには、明示的なバージョンに設定できます。

RYE_INSTALL_OPTION

オプションで"--yes"に設定して、すべてのプロンプトをスキップできます。

RYE_TOOLCHAIN

オプションで、この環境変数を設定して、内部インタプリタとして使用するPythonインタプリタを指定できます。指定しない場合は、適切なインタプリタが自動的にダウンロードされます。

現時点では、CPython 3.9から3.12のみがサポートされています。

RYE_TOOLCHAIN_VERSION

Rye 0.22以降では、デフォルトではなく特定のPythonバージョンを選択できます。これは、内部ツールチェーンのバージョンにのみ影響します。内部ツールチェーンをプロジェクトと同じに設定して、単一のPythonのみを取得できるDockerビルドに役立ちます。

現時点では、CPython 3.9から3.12のみがサポートされています。

これは、たとえば、質問せずに特定のバージョンのRyeをインストールします

curl -sSf https://rye.dokyumento.jp/get | RYE_VERSION="0.4.0" RYE_INSTALL_OPTION="--yes" bash

bashにパイプされるインストールスクリプトは、いくつかの環境変数でカスタマイズできます

RYE_VERSION

デフォルトはlatestです。特定のバージョンをインストールするには、明示的なバージョンに設定できます。

RYE_INSTALL_OPTION

オプションで"--yes"に設定して、すべてのプロンプトをスキップできます。

RYE_TOOLCHAIN

オプションで、この環境変数を設定して、内部インタプリタとして使用するPythonインタプリタを指定できます。指定しない場合は、適切なインタプリタが自動的にダウンロードされます。

現時点では、CPython 3.9から3.12のみがサポートされています。

RYE_TOOLCHAIN_VERSION

Rye 0.22以降では、デフォルトではなく特定のPythonバージョンを選択できます。これは、内部ツールチェーンのバージョンにのみ影響します。内部ツールチェーンをプロジェクトと同じに設定して、単一のPythonのみを取得できるDockerビルドに役立ちます。

現時点では、CPython 3.9から3.12のみがサポートされています。

これは、たとえば、質問せずに特定のバージョンのRyeをインストールします

curl -sSf https://rye.dokyumento.jp/get | RYE_VERSION="0.4.0" RYE_INSTALL_OPTION="--yes" bash

Windowsインストーラは、環境変数によるカスタマイズのサポートが限定されています。これらを設定するには、cmd.exeからインストーラを実行する必要があります。

RYE_TOOLCHAIN

オプションで、この環境変数を設定して、内部インタプリタとして使用するPythonインタプリタを指定できます。指定しない場合は、適切なインタプリタが自動的にダウンロードされます。

現時点では、CPython 3.9から3.12のみがサポートされています。

RYE_TOOLCHAIN_VERSION

Rye 0.22以降では、デフォルトではなく特定のPythonバージョンを選択できます。これは、内部ツールチェーンのバージョンにのみ影響します。内部ツールチェーンをプロジェクトと同じに設定して、単一のPythonのみを取得できるDockerビルドに役立ちます。

現時点では、CPython 3.9から3.12のみがサポートされています。

これは、たとえば、特定のツールチェーンを使用してRyeをインストールします

set RYE_TOOLCHAIN=%USERPROFILE%\AppData\Local\Programs\Python\Python310\python.exe
rye-x86_64-windows.exe

パスへのShimの追加

ryeをインストールしたら、shimsフォルダをPATHに追加する必要があります。このフォルダには、Ryeが管理する「shim」（Rye自体の実行可能ファイルなど）が含まれています。たとえば、Ryeによって管理されるPythonインストールは、そこに配置されたshimを介して利用できます。

macOSまたはLinuxでは、.profileファイルなどに追加することでこれを実現できます。この手順は技術的にはオプションですが、シェルにpythonまたはryeと入力するだけで現在のvirtualenvのPythonインタプリタを選択できるようにするには必須です。インストーラはこれを自動的に実行することを提案します。オプトアウトした場合、またはカスタムシェルを実行する場合は、手動でこれを行う必要があります。

BashZSHFishNushellUnixシェルWindows

Ryeには、PATHを自動的に更新するためにソースされるenvファイルが付属しています。

echo 'source "$HOME/.rye/env"' >> ~/.profile

一部のセットアップでは、.profileがソースされない場合があります。その場合は、.bashrcに追加できます

echo 'source "$HOME/.rye/env"' >> ~/.bashrc

Ryeには、PATHを自動的に更新するためにソースされるenvファイルが付属しています。

echo 'source "$HOME/.rye/env"' >> ~/.zprofile

一部のセットアップでは、.zprofileがソースされない場合があります。その場合は、.zshrcに追加できます

echo 'source "$HOME/.rye/env"' >> ~/.zshrc

fishはenvファイルをサポートしていないため、shimを直接追加する必要があります。これは、このコマンドを一度実行することで実現できます

set -Ua fish_user_paths "$HOME/.rye/shims"

nushellはenvファイルをサポートしていないため、shimを直接追加する必要があります。これは、env.nuファイルにこれを追加することで実現できます

$env.PATH = ($env.PATH | split row (char esep) | append "~/.rye/shims")

Ryeには、PATHを自動的に更新するためにソースされるenvファイルが付属しています。

echo '. "$HOME/.rye/env"' >> ~/.profile

Windowsインストーラは、通常、PATH環境変数にryeパスを自動的に登録します。これがうまくいかない場合は、次の手順を手動で実行する必要があります

Win+Rキーを押し、sysdm.cplと入力してEnterキーを押します。
「システムのプロパティ」ダイアログで、「詳細設定」タブをクリックします。
「環境変数」をクリックします。
上部のリストで、Path変数をダブルクリックします。
「環境変数の編集」ダイアログで、「新規」をクリックします。
%USERPROFILE%\.rye\shimsと入力してEnterキーを押します。
新しく追加された項目が最上位になるまで、「上へ移動」を繰り返しクリックします。
「OK」をクリックしてダイアログを閉じます。

これが有効になるには、ログインセッションの再起動が必要になる場合があります。

shimとその動作については、かなり多くのことがあります。詳細については、shimについて読むことを確認してください。

シェル補完

Ryeは、Bash、Zsh、Fish、Powershell、およびNushellの補完スクリプトの生成をサポートしています。以下は、各シェルの一般的な場所です

BashZshFishPowershellNuShell

mkdir -p ~/.local/share/bash-completion/completions
rye self completion > ~/.local/share/bash-completion/completions/rye.bash

# Make sure ~/.zfunc is added to fpath, before compinit.
rye self completion -s zsh > ~/.zfunc/_rye

Oh-My-Zsh

mkdir $ZSH_CUSTOM/plugins/rye
rye self completion -s zsh > $ZSH_CUSTOM/plugins/rye/_rye

次に、~/.zshrcでryeプラグインが有効になっていることを確認します

rye self completion -s fish > ~/.config/fish/completions/rye.fish

# Create a directory to store completion scripts
mkdir $PROFILE\..\Completions
echo @'
Get-ChildItem "$PROFILE\..\Completions\" | ForEach-Object {
    . $_.FullName
}
'@ | Out-File -Append -Encoding utf8 $PROFILE
# Generate script
Set-ExecutionPolicy Unrestricted -Scope CurrentUser
rye self completion -s powershell | Out-File -Encoding utf8 $PROFILE\..\Completions\rye_completion.ps1

rye self completion -s nushell | save --append $nu.env-path

Ryeのアップデート

ryeを最新バージョンに更新するには、rye自体を使用できます

rye self update

アンインストール

Ryeをもう使用したくない場合は、アンインストールするように依頼できます

rye self uninstall

さらに、ホームディレクトリから残りの.ryeフォルダを削除し、PATHから.rye/shimsを再度削除する必要があります（通常は、インストール手順からenvファイルをソースするコードを削除することにより）。 Rye自体は他の場所にデータを配置しません。ただし、ryeによって作成された仮想環境は、Ryeがアンインストールされた後は機能しなくなることに注意してください。

自動インストールの防止

Ryeは起動時に通常、自動インストールを実行します。これは、特定の開発状況では煩わしい場合があります。これは、RYE_NO_AUTO_INSTALL環境変数をエクスポートすることで防ぐことができます。この機能を無効にするには、1に設定する必要があります。

LinuxmacOSWindows

export RYE_NO_AUTO_INSTALL=1

export RYE_NO_AUTO_INSTALL=1

set RYE_NO_AUTO_INSTALL=1