Metadata-Version: 2.4
Name: gukhanmun-cli
Version: 0.4.0.dev365
Summary: The standalone Gukhanmun commands with bundled dictionaries
Requires-Python: >=3.11
Author-email: Hong Minhee <hong@minhee.org>
Project-URL: Homepage, https://gukhanmun.org/
Project-URL: Issues, https://github.com/dahlia/gukhanmun/issues
Project-URL: Repository, https://github.com/dahlia/gukhanmun
License-Expression: GPL-3.0-only AND LicenseRef-CC-BY-SA-2.0-KR AND LicenseRef-NIKL-Free-Use
License-File: LICENSE
License-File: NOTICE.md
License-File: gukhanmun-loanwords-cdb/ATTRIBUTION.md
License-File: gukhanmun-loanwords-cdb/LICENSE
License-File: gukhanmun-loanwords-fst/ATTRIBUTION.md
License-File: gukhanmun-loanwords-fst/LICENSE
License-File: gukhanmun-opendict-cdb/ATTRIBUTION.md
License-File: gukhanmun-opendict-cdb/LICENSE
License-File: gukhanmun-opendict-fst/ATTRIBUTION.md
License-File: gukhanmun-opendict-fst/LICENSE
License-File: gukhanmun-stdict-cdb/ATTRIBUTION.md
License-File: gukhanmun-stdict-cdb/LICENSE
License-File: gukhanmun-stdict-fst/ATTRIBUTION.md
License-File: gukhanmun-stdict-fst/LICENSE
Description-Content-Type: text/markdown

Gukhanmun commands
==================

`gukhanmun-cli` installs the standalone `gukhanmun` converter, its built-in
Korean dictionaries and the `gukhanmun-mkdict` custom dictionary builder.
It needs Python 3.11 or newer, but does not depend on the
`gukhanmun` Python library or its optional data distributions.

Install a prebuilt wheel with `pip install gukhanmun-cli`, or use an isolated
tool environment with `pipx install gukhanmun-cli` or
`uv tool install gukhanmun-cli`. Installation and execution do not download
native payloads. Source and editable builds are deliberately unavailable.

Run `gukhanmun --help` for conversion options. The command accepts files or
standard input. `gukhanmun --generate-completion bash` emits a completion
script; `zsh`, `fish`, `powershell`, and `nushell` are also supported.
Identical completion scripts and their manifest are installed in the
`gukhanmun_cli/completions` package resource directory. Installing the wheel
does not edit shell startup files or global completion directories.

Run `gukhanmun-mkdict --help` for dictionary build options. For example,
`gukhanmun-mkdict --validate --output custom.gukfst custom.tsv` compiles a
tab-separated table with `hanja` and `hangul` columns. Load the result with
`gukhanmun --dictionary custom.gukfst`. Both commands are installed and removed
together. The bundled completion scripts are for `gukhanmun` only.

The package contains GPL-licensed software and separately licensed dictionary
data. The installed *licenses* directory retains the software license,
dictionary licenses, attribution, and *NOTICE.md*.
