Rime Plum
How To Use This Skill
Use this skill when the task is about plum installation, update, packaging, or recipe behavior. Load full-reference only for exact recipe syntax, package-list examples, environment variable tables, or recipe.yaml details.
| User Need |
Focus |
| Install a schema package |
target syntax and rime_dir |
| Install many packages |
.conf package list |
| Package a schema for reuse |
recipe.yaml, install_files, patch_files |
| Windows setup |
Weasel bootstrap, Git for Windows, rime-install.bat |
| Offline/CI/system install |
no_update, ZIP cache, Makefile |
If the user wants to edit the schema itself, use rime-schema. If the user wants Weasel UI configuration, use rime-weasel.
First Checks
Before giving commands, identify:
- OS and frontend: Weasel, Squirrel, iBus Rime, fcitx, or fcitx5.
- Target user data directory (
rime_dir).
- Whether Git and network access are available.
- Whether the target is a package,
:preset group, .conf file, or local recipe.
- Whether repeated installs should skip updates with
no_update=1.
Common Commands
# install official preset group
bash rime-install :preset
# install one package
bash rime-install luna-pinyin
# install a third-party package
bash rime-install lotem/rime-zhung
# install with explicit frontend
rime_frontend=fcitx5-rime bash rime-install luna-pinyin
# skip updating existing package clones
no_update=1 bash rime-install :preset
Target Syntax
Recipe target shape:
<user>/<repo>@<branch>:<recipe>:<key>=<value>,...
Parts may be omitted. Official short names such as luna-pinyin expand to rime/rime-luna-pinyin.
Packaging Checklist
For a reusable plum package:
- Include schema, dictionary, Lua, OpenCC, and other required files.
- Use
install_files when the default copy rules are insufficient.
- Use
download_files only for generated or external data that should be fetched at install time.
- Use
patch_files to add schemas to default.yaml or patch installed files idempotently.
- Test from a clean
rime_dir, then redeploy Rime.
1---2name: rime-plum3description: Router and checklist for installing, updating, packaging, or troubleshooting Rime schemas with plum (東風破). Use for rime-install usage, recipe target syntax, preset package groups, packages.conf files, environment variables, frontend data directories, interactive selection, recipe.yaml install/download/patch behavior, package cache layout, Windows bootstrap, and Makefile/system installs. Load references/full-reference.md for syntax tables and examples.4---56# Rime Plum78## How To Use This Skill910Use this skill when the task is about plum installation, update, packaging, or recipe behavior. Load [full-reference](references/full-reference.md) only for exact recipe syntax, package-list examples, environment variable tables, or `recipe.yaml` details.1112| User Need | Focus |13|-----------|-------|14| Install a schema package | target syntax and `rime_dir` |15| Install many packages | `.conf` package list |16| Package a schema for reuse | `recipe.yaml`, `install_files`, `patch_files` |17| Windows setup | Weasel bootstrap, Git for Windows, `rime-install.bat` |18| Offline/CI/system install | `no_update`, ZIP cache, Makefile |1920If the user wants to edit the schema itself, use `rime-schema`. If the user wants Weasel UI configuration, use `rime-weasel`.2122## First Checks2324Before giving commands, identify:25261. OS and frontend: Weasel, Squirrel, iBus Rime, fcitx, or fcitx5.272. Target user data directory (`rime_dir`).283. Whether Git and network access are available.294. Whether the target is a package, `:preset` group, `.conf` file, or local recipe.305. Whether repeated installs should skip updates with `no_update=1`.3132## Common Commands3334```sh35# install official preset group36bash rime-install :preset3738# install one package39bash rime-install luna-pinyin4041# install a third-party package42bash rime-install lotem/rime-zhung4344# install with explicit frontend45rime_frontend=fcitx5-rime bash rime-install luna-pinyin4647# skip updating existing package clones48no_update=1 bash rime-install :preset49```5051## Target Syntax5253Recipe target shape:5455```text56<user>/<repo>@<branch>:<recipe>:<key>=<value>,...57```5859Parts may be omitted. Official short names such as `luna-pinyin` expand to `rime/rime-luna-pinyin`.6061## Packaging Checklist6263For a reusable plum package:64651. Include schema, dictionary, Lua, OpenCC, and other required files.662. Use `install_files` when the default copy rules are insufficient.673. Use `download_files` only for generated or external data that should be fetched at install time.684. Use `patch_files` to add schemas to `default.yaml` or patch installed files idempotently.695. Test from a clean `rime_dir`, then redeploy Rime.