https://github.com/rimeinn/rl_custom_rime

ㄓ Rime for readline. For all programs depending on readline
https://github.com/rimeinn/rl_custom_rime

readline rime

Last synced: 10 months ago
JSON representation

ㄓ Rime for readline. For all programs depending on readline

• Host: GitHub
• URL: https://github.com/rimeinn/rl_custom_rime
• Owner: rimeinn
• License: gpl-3.0
• Created: 2023-02-06T09:42:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-08-12T07:20:08.000Z (10 months ago)
• Last Synced: 2025-08-12T09:17:17.077Z (10 months ago)
• Topics: readline, rime
• Language: C
• Homepage:
• Size: 32.2 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# rl_custom_rime

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/rimeinn/rl_custom_rime/main.svg)](https://results.pre-commit.ci/latest/github/rimeinn/rl_custom_rime/main)

[![github/workflow](https://github.com/rimeinn/rl_custom_rime/actions/workflows/main.yml/badge.svg)](https://github.com/rimeinn/rl_custom_rime/actions)

[![github/downloads](https://shields.io/github/downloads/rimeinn/rl_custom_rime/total)](https://github.com/rimeinn/rl_custom_rime/releases)

[![github/downloads/latest](https://shields.io/github/downloads/rimeinn/rl_custom_rime/latest/total)](https://github.com/rimeinn/rl_custom_rime/releases/latest)

[![github/issues](https://shields.io/github/issues/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/issues)

[![github/issues-closed](https://shields.io/github/issues-closed/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/issues?q=is%3Aissue+is%3Aclosed)

[![github/issues-pr](https://shields.io/github/issues-pr/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/pulls)

[![github/issues-pr-closed](https://shields.io/github/issues-pr-closed/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/pulls?q=is%3Apr+is%3Aclosed)

[![github/discussions](https://shields.io/github/discussions/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/discussions)

[![github/milestones](https://shields.io/github/milestones/all/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/milestones)

[![github/forks](https://shields.io/github/forks/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/network/members)

[![github/stars](https://shields.io/github/stars/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/stargazers)

[![github/watchers](https://shields.io/github/watchers/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/watchers)

[![github/contributors](https://shields.io/github/contributors/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/graphs/contributors)

[![github/commit-activity](https://shields.io/github/commit-activity/w/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/graphs/commit-activity)

[![github/last-commit](https://shields.io/github/last-commit/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/commits)

[![github/release-date](https://shields.io/github/release-date/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/releases/latest)

[![github/license](https://shields.io/github/license/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime/blob/main/LICENSE)

[![github/languages](https://shields.io/github/languages/count/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime)

[![github/languages/top](https://shields.io/github/languages/top/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime)

[![github/directory-file-count](https://shields.io/github/directory-file-count/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime)

[![github/code-size](https://shields.io/github/languages/code-size/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime)

[![github/repo-size](https://shields.io/github/repo-size/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime)

[![github/v](https://shields.io/github/v/release/rimeinn/rl_custom_rime)](https://github.com/rimeinn/rl_custom_rime)

Rime for readline. For all programs depending on readline:

- bash without [ble.sh](https://github.com/akinomyoga/ble.sh)

- python without ptpython, ipython, ...

- tclsh/wish with [tclreadline](https://github.com/flightaware/tclreadline)

- lua with [luaprompt](https://github.com/dpapavas/luaprompt)

- perl with [reply](https://github.com/doy/reply)

- [sdcv](https://github.com/Dushistov/sdcv)

- ...

## Install

### AUR

```sh

paru -S rl_custom_rime

```

## Build

```sh

xmake

```

## Dependence

- [rl_custom_function](https://github.com/lincheney/rl_custom_function)

`/etc/ld.so.preload`:

```sh

/usr/$LIB/librl_custom_function.so

```

See [shell.nix](shell.nix).

## Configure

```readline

$include function rl_custom_rime /the/path/of/librl_custom_rime.so

"\C-^": rl_custom_rime

```

## Todo

- Support more special keys: Up, Del, F1, ...

- Pass hotkeys to readline directly when menu is empty

## Related Projects

- [Rime Frontends](https://github.com/rime/librime#frontends)

### Readline Plugins

- [rl_custom_isearch](https://github.com/lincheney/rl_custom_isearch)

- [fzf-tab-completion](https://github.com/lincheney/fzf-tab-completion)