安装
- 下载并使用 RuyiSDK，即表示您同意许可条款和隐私声明。
- 本文档使用
~表示当前普通用户的家目录，必要时请使用绝对路径（在大多数Linux系统中，通常是/home/你的用户名这样的路径）。文档示例中可能使用/home/foo作为通用占位符，如果您遇到类似表达，请替换成实际环境路径。 - 不同安装方式对操作系统和硬件架构的支持情况不同，请在开始安装之前，确定您的环境符合相应安装章节中标注的
环境标签的描述。
让我们从 RuyiSDK 包管理器的安装开始。
当前提供了三种不同的安装方式，它们各有适合的场景，请您根据自己的系统及架构选择合适的安装方式：
-
使用预编译的二进制包安装（推荐）
- 特点：支持的操作系统和硬件类型最全，对您现有系统环境的要求最低。
- 适合谁：几乎所有用户，特别是刚入门、希望快速完成安装的朋友。
-
使用系统自带的包管理器安装
- 特点：像安装普通软件一样，通过系统命令（如
apt或yum）来安装。 - 前提：需要您使用的 Linux 发行版官方已经收录了
ruyi软件包。
- 特点：像安装普通软件一样，通过系统命令（如
-
使用 Python 的 pip 工具安装
- 特点：通过 Python 的包管理器 pip 进行安装。
- 适合谁：如果您的电脑上已经配置好了 Python 开发环境，这会是一个熟悉且便捷的选择。
接下来，请根据您的系统和偏好，选择一种方式开始安装吧！
- 使用预编译的二进制安装
- 使用系统包管理器安装
- 使用Python包管理器安装
使用预编译的二进制安装
环境标签： Linux x86_64 arm64 riscv64
下载 RuyiSDK 包管理器
目前 RuyiSDK 包管理器工具为 Linux 系统预编译了 amd64(即x86_64)、arm64、riscv64 三种架构的二进制，它不依赖系统 Python，适用范围较为广泛。
它们同时发布在 GitHub Release 和 ISCAS 镜像站上：
以 ISCAS 镜像源为例描述安装流程，首先运行 uname -m 检查系统架构并下载对应的二进制。
$ wget $ chmod +x ./ruyi$ sudo cp -v ruyi /usr/local/bin/ruyi安装 RuyiSDK 包管理器
上方已根据您的架构自动生成命令。确保二进制安装为 ruyi 并位于 PATH 中的目录。
您可以通过以下方式验证安装是否成功：
$ ruyi version
若命令执行并正常打印了 Copyright 信息则安装已经成功；若出现了非预期的输出则需要检查安装过程和系统环境。
- 安装后的文件名必须是
ruyi（不能包含架构名称）。 - 确保已经为
ruyi添加可执行权限。 - 通过
echo $PATH检查确保ruyi所在的目录存在于PATH环境变量配置中。
- 如果您需要自定义安装目录，请参考上述的文档，将命令中的
/usr/local/bin路径替换为您的自定义安装目录，并确保您的PATH中包含该目录。 - 将
ruyi安装到~/.local/bin/ruyi可能会是一个更推荐的选择（用户目录下安装和删除不需要超级用户权限），此时您的PATH中需包含~/.local/bin/目录。
使用系统包管理器安装
Arch Linux
环境标签： ArchLinux x86_64 arm64 riscv64
目前 Arch Linux 用户可以使用系统包管理器安装和卸载 Ruyi 包管理器，相对于使用预编译的二进制安装，维护更加便利；使用系统 Python 也可以获得更好的性能。
从 AUR 安装，以 yay 为例，注意应当使用普通用户：
$ yay -S ruyi
从 Arch Linux CN 软件源安装，以 ISCAS 开源镜像站为例添加配置：
[archlinuxcn]
Server = https://mirror.iscas.ac.cn/archlinuxcn/$arch
使用 pacman 安装：
$ sudo pacman -Sy
$ sudo pacman -S ruyi
Gentoo Linux
环境标签： GentooLinux x86_64 arm64 riscv64
Gentoo Linux 用户可参考以下步骤，通过官方提供的 ruyisdk-overlay 安装并配置 Ruyi 包管理器（ruyi）。
- 安装
eselect-repository与 Git 客户端：
$ sudo emerge --ask app-eselect/eselect-repository dev-vcs/git
-
确保系统已添加主 Gentoo 仓库（通常已默认配置）。
-
使用
eselect-repository添加ruyisdk-overlay
$ sudo eselect repository add ruyisdk git https://github.com/ruyisdk/ruyisdk-overlay.git
- 同步仓库
$ sudo emaint sync -r ruyisdk
- 接受测试关键字（Unmask）
Ruyi 的 ebuild 被标记为测试版本，需要解屏蔽才能安装。
-
首先执行以下命令生成必要的 package.accept_keywords 改动
>_Terminal$ sudo emerge dev-util/ruyi --autounmask-write --autounmask -
运行
dispatch-conf，并在界面中输入u（use-new）接受所有改动。>_Terminal$ sudo dispatch-conf
- 安装 Ruyi 包管理器
$ sudo emerge --ask dev-util/ruyi
- 验证你的安装
$ ruyi version
命令应当可以正常运行并打印版本和 Copyright 信息，如果失败请检查系统环境或重新尝试安装。
使用 Python 包管理器安装
环境标签： Linux x86_64 arm64
RuyiSDK 包管理器现已同步发布至 PyPI（查看 PyPI 页面）。
如果你使用的是 Linux x86_64 或 ARM64 架构的系统，可以通过 pip 或 pipx 进行安装。如果您使用的是 Linux RISC-V64 架构的系统，建议您使用 预编译二进制安装 方式进行安装。
由于 ruyi 依赖的部分 Python 库暂未在 PyPI 上提供 RISC-V 架构的预编译包，使用 pip 安装 ruyi 时 Python 包管理器会尝试从源代码编译安装这些依赖，目前很可能会编译失败且非常耗时，在此不推荐此安装方式。
在 RISC-V 设备上，我们推荐您使用 预编译二进制安装 方法。
随着 Python 库对 RISC-V 架构的支持的推进，后续我们也会定期检查并更新。如果您是一位拥有探索精神的“探路者”，可以尝试使用 pip 安装 ruyi 并在 RuyiSDK中文社区 分享新进展。
使用 pipx 全局安装
pipx 是一个用于安装 Python CLI 工具的工具，它会将每个包安装到独立的环境中，并自动将可执行文件链接到 PATH。
$ pipx install ruyi
安装完成后，ruyi 命令会自动添加到你的 PATH 中，通常位于 ~/.local/bin，因此可以通过以下命令验证 ruyi 是否安装成功：
$ ruyi version
若命令执行并正常打印了 Copyright 信息则安装已经成功。如果出现错误或未找到命令，请检查安装步骤是否正确，并确认环境变量配置是否生效。
在虚拟环境中安装
如果你希望将 ruyi 安装在某个虚拟环境中（例如 /path/to/some/venv），参考以下方式在虚拟环境中使用，在使用前请务必将路径替换为您环境的实际路径：
# 使用绝对路径调用命令
# 注意：请务必将路径替换为您环境中的实际路径
$ /path/to/some/venv/bin/pip install ruyi
此时，ruyi 可执行文件会位于虚拟环境的 bin 目录下，不会自动添加到系统 PATH，因此使用时需要使用完整路径调用命令或者先激活虚拟环境：
# 使用完整路径执行ruyi
# 注意：请务必将路径替换为您环境中的实际路径
$ /path/to/some/venv/bin/ruyi version
# 或激活虚拟环境后运行
# 注意：请务必将路径替换为您环境中的实际路径
$ source /path/to/some/venv/bin/activate
$ ruyi version
若命令执行并正常打印了 Copyright 信息则安装已经成功。
开始使用
至此 Ruyi 包管理器已经成功安装在您的系统中。可以从 Ruyi 本身帮助信息中了解使用方法，或继续阅读本文档。
列出帮助信息：
$ ruyi --help