Repolode
Submit
TSalmon3

TSalmon3/rime.vim

Rime Chinese input method integration for Vim and Neovim, using a rime-query backend built on librime.

View on GitHub
Stars
80
Forks
3
Open issues
0
Last commit
5 hours ago

What is it?

rime.vim brings the Rime input method engine into Vim and Neovim. Typing in insert mode shows a candidate popup for pinyin input, and users select candidates with number keys, arrow keys, or Enter and Space. A separate rime-query backend, compiled against librime, runs as a shared daemon so multiple editor instances can use the same input state and user dictionary.

The plugin supports full pinyin, double pinyin, and nine-key schemes, along with simplified/traditional switching, Chinese and English punctuation, and emoji toggles. It includes a statusline helper, underline rendering, auto-pairing of brackets and quotes, and automatic switching between Chinese and English. Commands such as :IMDeploy, :IMSync and :IMSchemeDownload manage deployment, dictionary sync, and scheme installation.

The backend builds on macOS, Linux and Windows, using a Unix socket on Unix-like systems and a TCP loopback on Windows. Build commands and an in-editor :IMBuild workflow are documented in the project.

Key features

  • 01Pinyin input with candidate popup in Vim and Neovim insert mode.
  • 02Supports full pinyin, double pinyin and nine-key input schemes.
  • 03Shared backend daemon lets multiple editor instances share input state and user dictionaries.
  • 04Commands for redeploying Rime, syncing user dictionaries and downloading schemes.
  • 05Statusline helper showing input mode, punctuation and connection state.
  • 06Auto-pairing of brackets and quotes, plus automatic Chinese/English switching.

Use cases

  • Typing Chinese directly inside Vim or Neovim without switching to a system input method.
  • Writing Chinese notes or code comments in a terminal-based editor workflow.
  • Sharing a Rime configuration and user dictionary between Vim and Neovim sessions.

Quick start

  1. 1

    Install the plugin with vim-plug (add to vimrc)

    Plug 'TSalmon3/rime.vim'
  2. 2

    On macOS, install librime with Homebrew

    brew install librime
  3. 3

    From the cpp directory of the repo, compile the rime-query backend (create build first)

    clang++ -std=c++17 -I./3rd -I/opt/homebrew/include -L/opt/homebrew/lib -lstdc++ -lrime -o build/rime-query rime-query.cc

Things to know

  • You must install librime and compile the rime-query backend yourself before the plugin works.
  • Version 2.0.0 includes breaking API and backend protocol changes; v1.24.0 is the stable fallback.
  • The repository metadata shows an unclear license (NOASSERTION), although the README badge says MIT.

Topics

#vim#neovim#rime#chinese-input#input-method#pinyin#librime#chinese

FAQ

What is rime.vim?
Rime Chinese input method integration for Vim and Neovim, using a rime-query backend built on librime. rime.vim brings the Rime input method engine into Vim and Neovim. Typing in insert mode shows a candidate popup for pinyin input, and users select candidates with number keys, arrow keys, or Enter and Space. A separate rime-query backend, compiled against librime, runs as a shared daemon so multiple editor instances can use the same input state and user dictionary.
Is rime.vim free to use? What license does it have?
rime.vim is open source under the Other license. Check the license terms before using it in commercial products.
Is rime.vim still maintained?
Actively maintained. The last commit to rime.vim was on Oct 19, 2026.
What can I use rime.vim for?
Typing Chinese directly inside Vim or Neovim without switching to a system input method. Writing Chinese notes or code comments in a terminal-based editor workflow. Sharing a Rime configuration and user dictionary between Vim and Neovim sessions.
How do I install rime.vim?
Install the plugin with vim-plug (add to vimrc): Plug 'TSalmon3/rime.vim' On macOS, install librime with Homebrew: brew install librime From the cpp directory of the repo, compile the rime-query backend (create build first): clang++ -std=c++17 -I./3rd -I/opt/homebrew/include -L/opt/homebrew/lib -lstdc++ -lrime -o build/rime-query rime-query.cc
Where can I get rime.vim?
The source code and installation instructions are on GitHub: https://github.com/TSalmon3/rime.vim

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects