whatisgithub

What is squirrel?

rime/squirrel — explained in plain English

Analysis updated 2026-06-26

5,956SwiftAudience · generalComplexity · 2/5LicenseSetup · easy

In one sentence

Squirrel is the macOS app for the Rime Input Method Engine, letting you type Chinese characters phonetically on a standard keyboard. It supports multiple input styles like Pinyin and Zhuyin, is fully customizable, and runs on macOS 13 and newer.

Mindmap

mindmap
  root((repo))
    What it does
      Type Chinese characters
      Convert phonetic codes
      Switch input styles
    Tech Stack
      Swift
      librime engine
      LevelDB
      OpenCC
    Use Cases
      Pinyin input
      Zhuyin input
      Custom schemes
    Audience
      Mac users
      Chinese typists
      Language learners
Click or tap to explore — scroll the page freely

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

Type Chinese characters on a Mac using Pinyin romanization by installing Squirrel and selecting it from the input menu.

USE CASE 2

Switch between multiple input styles like Pinyin and Zhuyin using a keyboard shortcut inside any macOS app.

USE CASE 3

Customize your Chinese input method by editing user config files and redeploying without reinstalling.

USE CASE 4

Install additional input schemes such as regional dialects using the companion Plum tool.

What is it built with?

SwiftlibrimeBoostLevelDBOpenCCyaml-cpp

How does it compare?

rime/squirrelrileytestut/deltagluonfield/enchanted
Stars5,9565,9475,929
LanguageSwiftSwiftSwift
Setup difficultyeasymoderatemoderate
Complexity2/52/52/5
Audiencegeneralgeneralgeneral

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

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires macOS 13.0 or newer, a logout and login may be needed after installation for the input method to appear in all apps.

You can use, share, and modify this freely, but any modified version you distribute must also be open source under the same GPL v3 license.

So what is it?

Squirrel is the macOS version of the Rime Input Method Engine. An input method is software that lets users type characters from writing systems like Chinese by pressing keys on a standard keyboard. The user types phonetic or structural codes, and the input method converts them into the correct characters on screen. Squirrel supports macOS 13.0 and above. Rime is the underlying engine shared across platforms. Squirrel is its macOS front-end. The same engine powers two other official distributions: one for Linux available as ibus-rime or fcitx-rime (called Zhongzheyun), and one for Windows (called Weasel or Xiaolanghao). After installing, users switch to Squirrel from the macOS input method menu by selecting its icon. The keyboard shortcut Ctrl+backtick or F4 opens a scheme selector for switching between input styles, such as Pinyin romanization or the Zhuyin phonetic notation system. Customization is done by editing user configuration files, then choosing "Redeploy" from the menu for changes to take effect. If some applications cannot accept text immediately after a fresh install, logging out and back in resolves the issue. Additional input schemes beyond the defaults can be installed using a companion configuration tool called Plum. Full documentation is available on the project website at rime.im. Bugs and suggestions can be reported to the Rime community discussion board on GitHub. Squirrel is open source under the GPL v3 license. It is built on top of the librime engine along with several other open-source libraries including Boost, LevelDB, OpenCC, and yaml-cpp.

Copy-paste prompts

Prompt 1
Help me install Squirrel on my Mac and configure it so I can type Chinese using Pinyin.
Prompt 2
How do I switch between Pinyin and Zhuyin input modes in Squirrel on macOS using a keyboard shortcut?
Prompt 3
Show me how to edit Squirrel user configuration files to change the candidate word display and font size.
Prompt 4
How do I install additional Chinese input schemes in Squirrel using the Plum companion tool?
Prompt 5
Squirrel is not working in some apps after I installed it on macOS, how do I fix this?

Frequently asked questions

What is squirrel?

Squirrel is the macOS app for the Rime Input Method Engine, letting you type Chinese characters phonetically on a standard keyboard. It supports multiple input styles like Pinyin and Zhuyin, is fully customizable, and runs on macOS 13 and newer.

What language is squirrel written in?

Mainly Swift. The stack also includes Swift, librime, Boost.

What license does squirrel use?

You can use, share, and modify this freely, but any modified version you distribute must also be open source under the same GPL v3 license.

How hard is squirrel to set up?

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

Who is squirrel for?

Mainly general.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.