Command line interface to the cihai CJK-language library.
This project is under active development. Follow our progress and check back for updates!
Installation¶
$ pip install --user cihai-cli
Or manage it inside an existing project with uv:
Install the CLI as a user-wide tool with uv:
$ uv tool install cihai-cli
Run it on-demand without installing:
$ uvx --from cihai-cli cihai --version
Developmental releases¶
You can test the unpublished version of cihai-cli before its released.
pip:
$ pip install --user --upgrade --pre cihai-cli
uv:
$ uv tool install --prerelease=allow cihai-cli
$ uv add --prerelease=allow cihai-cli
pipx:
$ pipx install --suffix=@next cihai-cli --pip-args '\--pre' --include-deps --force
Then use
cihai@next info 好.
For more information see developmental releases
Character lookup¶
See CLI in the documentation for full usage information.
char: 好 kCantonese: hou2 hou3 kDefinition: good, excellent, fine; well kHangul: 호 kJapaneseOn: KOU kKorean: HO kMandarin: hǎo kTang: "*xɑ̀u *xɑ̌u" kTotalStrokes: "6" ucn: U+597D
Retrieve all character information (including book indices):
char: 好 kCangjie: VND kCantonese: hou2 hou3 kCihaiT: "378.103" kDefinition: good, excellent, fine; well kFenn: 552A kFourCornerCode: "4744.7" kFrequency: "1" kGradeLevel: "1" kHKGlyph: 0871 kHangul: 호 kHanyuPinlu: hǎo(6060) hāo(142) hào(115) kHanyuPinyin: 21028.010:hǎo,hào kJapaneseKun: KONOMU SUKU YOI kJapaneseOn: KOU kKorean: HO kMandarin: hǎo kPhonetic: "481" kRSAdobe_Japan1_6: C+1975+38.3.3 C+1975+39.3.3 kRSKangXi: "38.3" kTang: "*xɑ̀u *xɑ̌u" kTotalStrokes: "6" kVietnamese: háo kXHC1983: 0445.030:hǎo 0448.030:hào ucn: U+597D
Reverse lookup¶
char: 圕 kCantonese: syu1 kDefinition: library kJapaneseOn: TOSHOKAN SHO kMandarin: tú kTotalStrokes: '13' ucn: U+5715 -------- char: 嫏 kCantonese: long4 kDefinition: the place where the supreme stores his books; library kJapaneseOn: ROU kMandarin: láng kTotalStrokes: '11' ucn: U+5ACF --------
Developing¶
$ git clone https://github.com/cihai/cihai-cli.git
Bootstrap your environment and learn more about contributing. We use the same conventions / tools across all cihai projects: pytest, sphinx, mypy, ruff, tmuxp, and file watcher helpers (e.g. entr(1)).
Python versions¶
Final Python 3.7 version: 0.16.0
Quick links¶
Python API
Python support: >= 3.10, pypy
Changelog: https://cihai-cli.git-pull.com/history.html
Test coverage https://codecov.io/gh/cihai/cihai-cli
OpenHub: https://www.openhub.net/p/cihai-cli
License: MIT