Installation and usage
You can get pre-built binaries of ruyi from GitHub Releases or
the RuyiSDK mirror for easier testing.
Rename the downloaded file to ruyi, make it executable,
put inside your $PATH and you're ready to go.
You can browse the documentation at the dedicated RuyiSDK docs site (only available in Chinese right now).
Configuration
Various aspects of ruyi can be configured with files or environment variables.
Config search path
ruyi respects $XDG_CONFIG_HOME and $XDG_CONFIG_DIRS settings, and will
look up its config accordingly. If these are not explicitly set though, as in
typical use cases, the default config directory is most likely ~/.config/ruyi.
Config file
Currently ruyi will look for an optional config.toml in its XDG config
directory. The file, if present, looks like this, with all values being default:
[packages]
# Consider pre-release versions when matching packages in repositories.
prereleases = false
[repo]
# Path to the local RuyiSDK metadata repository. Must be absolute or the setting
# will be ignored.
# If unset or empty, $XDG_CACHE_HOME/ruyi/packages-index is used.
local = ""
# Remote location of RuyiSDK metadata repository.
# If unset or empty, this default value is used.
remote = "https://github.com/ruyisdk/packages-index.git"
# Name of the branch to use.
# If unset or empty, this default value is used.
branch = "main"Environment variables
Currently the following environment variables are supported by ruyi:
RUYI_VENV-- explicitly specifies the Ruyi virtual environment to use.
License
Copyright © 2023-2024 Institute of Software, Chinese Academy of Sciences (ISCAS). All rights reserved.
ruyi is licensed under the Apache 2.0 license.
This version of ruyi makes use of code licensed under the
Mozilla Public License 2.0.
You can get the respective project's sources from the project's official
website:
certifi: used unmodified
All trademarks referenced herein are property of their respective holders.