Skip to main content

Installation

Friendly Reminder
  • By downloading and using RuyiSDK, you agree to the license terms and privacy policy.
  • This documentation uses ~ to represent the current user's home directory. When necessary, please use the absolute path (on most Linux systems, this is typically something like /home/your-username). You may see /home/foo used as a placeholder in examples—please replace it with your actual environment path.
  • Each installation method supports different operating systems and hardware architectures. Before proceeding, make sure your environment matches the Supported Architectures listed in the relevant section.

Let’s begin with installing the RuyiSDK package manager.

There are currently three installation methods available, each suited to different scenarios. Please choose the one that best fits your system and architecture:

  1. Install with Precompiled Binary (Recommended)

    • Highlights: Broadest OS and hardware support; minimal system requirements.
    • Best for: Almost all users, especially beginners looking for a quick setup.

  2. Install via System Package Manager

    • Highlights: Installed like any regular software using system commands (e.g., apt, yum).
    • Prerequisite: Your Linux distribution must officially include the ruyi package.

  3. Install via Python’s pip Tool

    • Highlights: Uses Python’s package manager pip for installation.
    • Best for: Users who already have a Python development environment configured.

Now, choose the method that suits your system and preferences to get started!

Installing with Precompiled Binaries

Supported Architectures: Linux x86_64 arm64 riscv64

Download the RuyiSDK Package Manager

The RuyiSDK package manager is currently available as precompiled binaries for Linux systems, supporting three architectures: amd64 (i.e., x86_64), arm64, and riscv64. It does not rely on the system’s Python environment, making it broadly compatible across setups.

They are simultaneously published on both GitHub Releases and the ISCAS mirror site:

This guide uses the ISCAS mirror as an example. First, run uname -m to check your system architecture, then download the corresponding binary.

Select Architecture:
$ wget
After downloading, please execute the following commands based on the actual filename in the link above (commands will be automatically updated with architecture):
$ chmod +x ./ruyi
$ sudo cp -v ruyi /usr/local/bin/ruyi

Install the RuyiSDK Package Manager

The command above has been auto-generated based on your system architecture. Make sure the binary is named ruyi and placed in a directory included in your PATH.

To verify the installation, run:

>_Terminal
$ ruyi version

If the command executes and prints the copyright information, the installation was successful. If unexpected output appears, please check your installation steps and system environment.

Troubleshooting
  • The installed file must be named ruyi (do not include architecture suffixes).
  • Ensure the ruyi binary has executable permissions.
  • se echo $PATH to confirm that the directory containing ruyi is included in your PATH environment variable.
Custom Installation Path
  • If you prefer a custom installation directory, modify the /usr/local/bin path in the command accordingly, and ensure your PATH includes that directory.
  • Installing ruyi to ~/.local/bin/ruyi is often recommended, as it allows installation and removal without superuser privileges. In this case, make sure ~/.local/bin/ is part of your PATH.

Getting Started

Ruyi has now been successfully installed on your system. You can explore its usage via the built-in help command or continue reading this documentation.

To display help information:

>_Terminal
$ ruyi --help