Skip to main content

Feature Overview

The ruyi package manager primarily provides the following functionalities.

Command Reference

CommandDescriptionNotes
ruyi updateUpdate package cache using default mirror.Package cache will be stored in user directory, typically ~/.cache/ruyi.
ruyi news list -hDisplay help information for news command.
ruyi news listList all news items.
ruyi news list --newList only unread news items.
ruyi news read -hDisplay help information for news reading command.
ruyi news read 1Read specific news item by index.1 represents the index or ID of the news entry.
ruyi news readRead next news item.
ruyi news read --quietMark news as read without output.No output, only marks as read.
ruyi listList all available packages.
ruyi list -vList detailed information of all packages.
ruyi list profilesView predefined virtual environment configurations.
ruyi install gnu-upstreamInstall latest GNU upstream toolchain.Installs latest version of gnu-upstream by default.
ruyi install 'gnu-upstream(0.20231118.0)'Install specified version of GNU upstream toolchain.Install historical versions by specifying version number.
ruyi install 'gnu-upstream(==0.20231118.0)'Install specific version of GNU upstream toolchain.Version matching format should be <op><ver>.
ruyi install --reinstall gnu-upstreamReinstall GNU upstream toolchain.
ruyi extract ruyisdk-demoDownload and unpack ruyisdk-demo source package.Unpacks to current directory.
ruyi venv --toolchain gnu-upstream --emulator qemu-user-riscv-upstream generic ./ruyi_venvCreate virtual environment with toolchain and emulator in specified directory.Uses predefined generic configuration.
ruyi versionDisplay version of ruyi package manager.
ruyi self uninstallUninstall ruyi package manager.Command will prompt for confirmation.
ruyi self uninstall -yUninstall ruyi package manager without confirmation.Executes directly without confirmation.
ruyi self uninstall --purgeCompletely uninstall ruyi package manager, including cache and installed packages.Includes cache and installed packages.
ruyi self uninstall --purge -yCompletely uninstall ruyi package manager without confirmation.Executes directly without confirmation.
ruyi self cleanClean data directories.Can specify which directories to clean via parameters
ruyi device provisionDownload required system image and provision device.Follows guided system installation process.

Data Directories

  • ruyi executable /usr/local/bin/ruyi or other directories in PATH
  • User configuration file ~/.config/ruyi/config.toml
  • User cache ~/.cache/ruyi
  • User base data, including downloaded and unpacked ruyi packages ~/.local/share/ruyi
  • User state data ~/.local/state/ruyi

Ruyi supports configuring these directories using XDG environment variables.

More Information

Refer to ruyi package manager repository documentation (currently English only).