# cihai-cli · [](https://pypi.org/project/cihai-cli/) [](https://github.com/cihai/cihai-cli/blob/master/LICENSE) [](https://codecov.io/gh/cihai/cihai-cli)
Command line interface to the [cihai](https://cihai.git-pull.com)
[CJK](https://cihai.git-pull.com/glossary.html#term-cjk)-language library.
This project is under active development. Follow our progress and check back for updates!
## Installation
```console
$ pip install --user cihai-cli
```
Or manage it inside an existing project with uv:
```console
$ uv add cihai-cli
```
Install the CLI as a user-wide tool with uv:
```console
$ uv tool install cihai-cli
```
Run it on-demand without installing:
```console
$ uvx --from cihai-cli cihai --version
```
### Developmental releases
You can test the unpublished version of cihai-cli before its released.
- [pip](https://pip.pypa.io/en/stable/):
```console
$ pip install --user --upgrade --pre cihai-cli
```
- [uv](https://docs.astral.sh/uv/):
```console
$ uv tool install --prerelease=allow cihai-cli
```
```console
$ uv add --prerelease=allow cihai-cli
```
- [pipx](https://pypa.github.io/pipx/docs/):
```console
$ pipx install --suffix=@next cihai-cli --pip-args '\--pre' --include-deps --force
```
Then use `cihai@next info 好`.
For more information see
[developmental releases](https://cihai-cli.git-pull.com/quickstart.html#developmental-releases)
## Character lookup
See [CLI](https://cihai-cli.git-pull.com/cli.html) in the documentation for full usage information.
```console
$ cihai info 好
```
```yaml
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):
```console
$ cihai info 好 -a
```
```yaml
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
```console
$ cihai reverse library
```
```yaml
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
```console
$ git clone https://github.com/cihai/cihai-cli.git
```
```console
$ cd cihai-cli
```
[Bootstrap your environment and learn more about contributing](https://cihai.git-pull.com/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
- [Quickstart](https://cihai-cli.git-pull.com/quickstart.html)
- Python [API](https://cihai-cli.git-pull.com/api.html)
- [2017 roadmap](https://cihai.git-pull.com/design-and-planning/2017/spec.html)
- Python support: >= 3.10, pypy
- Source: <https://github.com/cihai/cihai-cli>
- Docs: <https://cihai-cli.git-pull.com>
- Changelog: <https://cihai-cli.git-pull.com/history.html>
- API: <https://cihai-cli.git-pull.com/api.html>
- Issues: <https://github.com/cihai/cihai-cli/issues>
- Test coverage <https://codecov.io/gh/cihai/cihai-cli>
- pypi: <https://pypi.python.org/pypi/cihai-cli>
- OpenHub: <https://www.openhub.net/p/cihai-cli>
- License: MIT
[](https://cihai-cli.git-pull.com/)
[](https://github.com/cihai/cihai-cli/actions?query=workflow%3A%22tests%22)
Raw data
{
"_id": null,
"home_page": null,
"name": "cihai-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "chinese, cjk, cli, dataset, dictionary, encyclopedia, japanese, korean, languages, library, shell, sqlalchemy, study, terminal, unicode, unihan",
"author": null,
"author_email": "Tony Narlock <tony@git-pull.com>",
"download_url": "https://files.pythonhosted.org/packages/12/2b/97922f5f2296926258936c7bc3ed5ce0060afee22adfbff09316b480388f/cihai_cli-0.31.0.tar.gz",
"platform": null,
"description": "# cihai-cli · [](https://pypi.org/project/cihai-cli/) [](https://github.com/cihai/cihai-cli/blob/master/LICENSE) [](https://codecov.io/gh/cihai/cihai-cli)\n\nCommand line interface to the [cihai](https://cihai.git-pull.com)\n[CJK](https://cihai.git-pull.com/glossary.html#term-cjk)-language library.\n\nThis project is under active development. Follow our progress and check back for updates!\n\n## Installation\n\n```console\n$ pip install --user cihai-cli\n```\n\nOr manage it inside an existing project with uv:\n\n```console\n$ uv add cihai-cli\n```\n\nInstall the CLI as a user-wide tool with uv:\n\n```console\n$ uv tool install cihai-cli\n```\n\nRun it on-demand without installing:\n\n```console\n$ uvx --from cihai-cli cihai --version\n```\n\n### Developmental releases\n\nYou can test the unpublished version of cihai-cli before its released.\n\n- [pip](https://pip.pypa.io/en/stable/):\n\n ```console\n $ pip install --user --upgrade --pre cihai-cli\n ```\n\n- [uv](https://docs.astral.sh/uv/):\n\n ```console\n $ uv tool install --prerelease=allow cihai-cli\n ```\n\n ```console\n $ uv add --prerelease=allow cihai-cli\n ```\n\n- [pipx](https://pypa.github.io/pipx/docs/):\n\n ```console\n $ pipx install --suffix=@next cihai-cli --pip-args '\\--pre' --include-deps --force\n ```\n\n Then use `cihai@next info \u597d`.\n\nFor more information see\n[developmental releases](https://cihai-cli.git-pull.com/quickstart.html#developmental-releases)\n\n## Character lookup\n\nSee [CLI](https://cihai-cli.git-pull.com/cli.html) in the documentation for full usage information.\n\n```console\n$ cihai info \u597d\n```\n\n```yaml\nchar: \u597d\nkCantonese: hou2 hou3\nkDefinition: good, excellent, fine; well\nkHangul: \ud638\nkJapaneseOn: KOU\nkKorean: HO\nkMandarin: h\u01ceo\nkTang: \"*x\u0251\u0300u *x\u0251\u030cu\"\nkTotalStrokes: \"6\"\nucn: U+597D\n```\n\nRetrieve all character information (including book indices):\n\n```console\n$ cihai info \u597d -a\n```\n\n```yaml\nchar: \u597d\nkCangjie: VND\nkCantonese: hou2 hou3\nkCihaiT: \"378.103\"\nkDefinition: good, excellent, fine; well\nkFenn: 552A\nkFourCornerCode: \"4744.7\"\nkFrequency: \"1\"\nkGradeLevel: \"1\"\nkHKGlyph: 0871\nkHangul: \ud638\nkHanyuPinlu: h\u01ceo(6060) h\u0101o(142) h\u00e0o(115)\nkHanyuPinyin: 21028.010:h\u01ceo,h\u00e0o\nkJapaneseKun: KONOMU SUKU YOI\nkJapaneseOn: KOU\nkKorean: HO\nkMandarin: h\u01ceo\nkPhonetic: \"481\"\nkRSAdobe_Japan1_6: C+1975+38.3.3 C+1975+39.3.3\nkRSKangXi: \"38.3\"\nkTang: \"*x\u0251\u0300u *x\u0251\u030cu\"\nkTotalStrokes: \"6\"\nkVietnamese: h\u00e1o\nkXHC1983: 0445.030:h\u01ceo 0448.030:h\u00e0o\nucn: U+597D\n```\n\n## Reverse lookup\n\n```console\n$ cihai reverse library\n```\n\n```yaml\nchar: \u5715\nkCantonese: syu1\nkDefinition: library\nkJapaneseOn: TOSHOKAN SHO\nkMandarin: t\u00fa\nkTotalStrokes: '13'\nucn: U+5715\n--------\nchar: \u5acf\nkCantonese: long4\nkDefinition: the place where the supreme stores his books; library\nkJapaneseOn: ROU\nkMandarin: l\u00e1ng\nkTotalStrokes: '11'\nucn: U+5ACF\n--------\n```\n\n## Developing\n\n```console\n$ git clone https://github.com/cihai/cihai-cli.git\n```\n\n```console\n$ cd cihai-cli\n```\n\n[Bootstrap your environment and learn more about contributing](https://cihai.git-pull.com/contributing/). We use the same conventions / tools across all cihai projects: `pytest`, `sphinx`, `mypy`, `ruff`, `tmuxp`, and file watcher helpers (e.g. `entr(1)`).\n\n## Python versions\n\n- Final Python 3.7 version: 0.16.0\n\n## Quick links\n\n- [Quickstart](https://cihai-cli.git-pull.com/quickstart.html)\n- Python [API](https://cihai-cli.git-pull.com/api.html)\n- [2017 roadmap](https://cihai.git-pull.com/design-and-planning/2017/spec.html)\n- Python support: >= 3.10, pypy\n- Source: <https://github.com/cihai/cihai-cli>\n- Docs: <https://cihai-cli.git-pull.com>\n- Changelog: <https://cihai-cli.git-pull.com/history.html>\n- API: <https://cihai-cli.git-pull.com/api.html>\n- Issues: <https://github.com/cihai/cihai-cli/issues>\n- Test coverage <https://codecov.io/gh/cihai/cihai-cli>\n- pypi: <https://pypi.python.org/pypi/cihai-cli>\n- OpenHub: <https://www.openhub.net/p/cihai-cli>\n- License: MIT\n\n[](https://cihai-cli.git-pull.com/)\n[](https://github.com/cihai/cihai-cli/actions?query=workflow%3A%22tests%22)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command line frontend for the cihai CJK language library",
"version": "0.31.0",
"project_urls": {
"Bug Tracker": "https://github.com/cihai/cihai-cli/issues",
"Documentation": "https://cihai-cli.git-pull.com",
"Q & A": "https://github.com/cihai/cihai-cli/discussions",
"Release notes": "https://github.com/cihai/cihai-cli/blob/master/CHANGES",
"Repository": "https://github.com/cihai/cihai-cli"
},
"split_keywords": [
"chinese",
" cjk",
" cli",
" dataset",
" dictionary",
" encyclopedia",
" japanese",
" korean",
" languages",
" library",
" shell",
" sqlalchemy",
" study",
" terminal",
" unicode",
" unihan"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c7da2beaef341f5aff8dc395c3e610ad346ad7918c61a99956a94ba4f18245ad",
"md5": "0dc8e9336d6ad5d55efcf0c39a679a02",
"sha256": "9a33f3e4d0137ef2fc05269737f44ccb7621fac3e438727f1423c178df1307a4"
},
"downloads": -1,
"filename": "cihai_cli-0.31.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0dc8e9336d6ad5d55efcf0c39a679a02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 6745,
"upload_time": "2025-11-01T17:41:28",
"upload_time_iso_8601": "2025-11-01T17:41:28.721345Z",
"url": "https://files.pythonhosted.org/packages/c7/da/2beaef341f5aff8dc395c3e610ad346ad7918c61a99956a94ba4f18245ad/cihai_cli-0.31.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "122b97922f5f2296926258936c7bc3ed5ce0060afee22adfbff09316b480388f",
"md5": "efba2fb5aa0b77c8fd6efc5f7dfdadba",
"sha256": "f3747d1070f07783973f847a4cef7ced403c68dfbf387a48780e304f12e78c49"
},
"downloads": -1,
"filename": "cihai_cli-0.31.0.tar.gz",
"has_sig": false,
"md5_digest": "efba2fb5aa0b77c8fd6efc5f7dfdadba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 193974,
"upload_time": "2025-11-01T17:41:29",
"upload_time_iso_8601": "2025-11-01T17:41:29.857937Z",
"url": "https://files.pythonhosted.org/packages/12/2b/97922f5f2296926258936c7bc3ed5ce0060afee22adfbff09316b480388f/cihai_cli-0.31.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-01 17:41:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cihai",
"github_project": "cihai-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "cihai-cli"
}
JSON
