Usage

cihai is designed to work out-of-the-box without configuration.

Installation

$ pip install --user cihai-cli

Or manage it inside an existing project with uv:

$ uv add cihai-cli

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

New versions of cihai CLI are published to PyPI as alpha, beta, or release candidates. In their versions you will see notification like a1, b1, and rc1, respectively. 1.10.0b4 would mean the 4th beta release of 1.10.0 before general availability.

  • pip:

    $ pip install --user --upgrade --pre cihai-cli
    
  • pipx:

    $ pipx install --suffix=@next 'cihai-cli' --pip-args '\--pre' --force
    // Usage: cihai@next info 好
    
  • uv tool install:

    $ uv tool install --prerelease=allow cihai-cli
    
  • uv:

    $ uv add cihai-cli --prerelease allow
    
  • uvx:

    $ uvx --from 'cihai-cli' --prerelease allow cihai
    

via trunk (can break easily):

  • pip:

    $ pip install --user -e git+https://github.com/cihai/cihai-cli.git#egg=cihai-cli
    
  • uv:

    $ uv add git+https://github.com/cihai/cihai-cli.git#egg=cihai-cli
    
  • pipx:

    $ pipx install --suffix=@master 'cihai-cli @ git+https://github.com/cihai/cihai.git@master' --include-deps --force
    

Configuration

See cihai’s configuration documentation.