CLI Reference

unihan-etl download

Download and cache the UNIHAN database.

unihan-etl download
unihan-etl export

Export UNIHAN data to CSV, JSON, or YAML.

unihan-etl export
unihan-etl search

Look up character data by codepoint or field.

unihan-etl search
unihan-etl fields

List available UNIHAN fields.

unihan-etl fields
unihan-etl files

List available UNIHAN source files.

unihan-etl files

Main command

The unihan-etl command is the entry point for all UNIHAN ETL operations. Use subcommands to export data, download the database, or query fields and files.

Command

unihan-etl - Export UNIHAN data to CSV, JSON, or YAML.

Download and export Unicode Han character database.

download:

unihan-etl download

explore:

unihan-etl fields unihan-etl files unihan-etl search 好

Usage

usage: unihan-etl [-h] [-V] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
                  {export,download,fields,files,search} ...

Examples

$ unihan-etl export
$ unihan-etl export -F json -f kDefinition

Options

-V, --version

show program's version number and exit

-l, --log-level

Logging level. Default: INFO

Default
INFO
Choices
DEBUG, INFO, WARNING, ERROR, CRITICAL

Global Options

  • -l, --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}: Logging level (default: INFO)

  • -V, --version: Show version and exit

Output Formats

The fields, files, and search commands support different output formats:

  • Table (default): Human-readable formatted output

  • --json: Pretty-printed JSON (entire result as array/object)

  • --ndjson: Newline-delimited JSON (one record per line, ideal for LLM consumption)