explaingit

rime/plum

Analysis updated 2026-08-08 · repo last pushed 2026-05-08

1,893ShellAudience · generalComplexity · 2/5MaintainedLicenseSetup · easy

TLDR

Plum is a shell-script package manager for Rime, an open-source Chinese input method engine. It downloads and installs ready-made typing schemas and dictionaries so you can type Chinese without manual configuration.

Mindmap

mindmap
  root((repo))
    What it does
      Downloads input schemas
      Installs Rime dictionaries
      Fetches from GitHub
    Supported methods
      Pinyin variants
      Cantonese and Zhuyin
      Cangjie and Wubi
    Tech stack
      Shell script
      Batch files for Windows
      Rime engine
    Use cases
      Quick setup for Chinese typing
      Install third-party configs
      Compile schemas to binaries
    Audience
      Chinese language typists
      Power users
      Custom config sharers
    License
      LGPLv3

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Install a Pinyin or Cantonese input schema for Rime in one command.

USE CASE 2

Set up Double Pinyin or Zhuyin typing without manually editing config files.

USE CASE 3

Install a third-party developer's custom Rime configuration from their GitHub repo.

USE CASE 4

Pre-compile input schemas into binaries to speed up Rime's first startup.

What is it built with?

ShellBatchRime

How does it compare?

rime/plumruanyf/simple-bash-scriptsprismml-eng/bonsai-demo
Stars1,8931,9191,941
LanguageShellShellShell
Last pushed2026-05-082025-01-15
MaintenanceMaintainedStale
Setup difficultyeasyeasymoderate
Complexity2/51/53/5
Audiencegeneralvibe coderdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires Rime to already be installed and run from a terminal on Linux/macOS or batch file on Windows.

Free to use and modify, but modified versions must stay open under the same license.

In plain English

Plum is a configuration manager for Rime, an open-source input method engine that lets you type Chinese (and other languages) on your computer. Rime is highly customizable but can be tricky to set up from scratch. Plum solves this by giving you a simple way to download and install ready-made input schemas, the rule sets and dictionaries that define how your keystrokes turn into characters, so you don't have to build them yourself. At its core, Plum is a shell script that fetches packages from GitHub. Each package, called a "recipe," contains one or more input schemas along with their associated dictionaries. You run a single command in your terminal (on Linux or macOS) or a batch file (on Windows), and Plum downloads the files you need and places them in Rime's user directory. You can install a preset bundle of essentials, pick individual packages by name, or even pull in configurations from third-party developers by referencing their GitHub repositories. The catalog of available packages is extensive. It covers phonetic-based methods like Pinyin (in several variants), Zhuyin/Bopomofo, and Cantonese, as well as shape-based methods like Cangjie and Wubi. There are even packages for Middle Chinese, regional dialects like Shanghainese and Suzhounese, emoji input, and International Phonetic Alphabet symbols. This makes it a one-stop shop for virtually any Chinese typing method you might need, whether you're writing in Modern Standard Mandarin or reconstructing historical pronunciation. Anyone who uses Rime for Chinese input would benefit from Plum. For example, a Cantonese speaker who wants to type using Jyutping, or a Mandarin speaker who prefers Double Pinyin, can install the right package in seconds rather than manually configuring YAML files. It's also useful for power users who want to maintain a personal Rime configuration on GitHub and share it with others, Plum can install those custom setups just as easily as the official ones. One notable design choice is that Plum itself is lightweight: it's essentially a downloader and installer, not a runtime component. The actual input processing happens in Rime. Plum also supports an interactive selection mode and can build schema files into pre-compiled binaries, which saves time on first startup. The project is licensed under LGPLv3, though individual data packages may carry their own licenses.

Copy-paste prompts

Prompt 1
How do I use plum to install the Cantonese Jyutping input schema for Rime on macOS?
Prompt 2
Show me the plum command to install a preset bundle of essential Chinese input schemas.
Prompt 3
How can I use plum to install a third-party Rime configuration from a custom GitHub repository?
Prompt 4
How do I pre-compile Rime schema files into binaries using plum to reduce first startup time?

Frequently asked questions

What is plum?

Plum is a shell-script package manager for Rime, an open-source Chinese input method engine. It downloads and installs ready-made typing schemas and dictionaries so you can type Chinese without manual configuration.

What language is plum written in?

Mainly Shell. The stack also includes Shell, Batch, Rime.

Is plum actively maintained?

Maintained — commit in last 6 months (last push 2026-05-08).

What license does plum use?

Free to use and modify, but modified versions must stay open under the same license.

How hard is plum to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is plum for?

Mainly general.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.