CLI

Utsuho には、対話的な利用やスクリプトからの呼び出しに加え、標準入力(stdin)を利用したパイプ処理にも適したコマンドラインインターフェースが用意されています。 変換結果は標準出力に出力されるため、シェルスクリプトからも扱いやすくなっています。

基本構文

--help オプションで CLI の構文を確認できます。

% utsuho --help
Usage: utsuho [OPTIONS] COMMAND [ARGS]...

  Utsuho provides deterministic normalization utilities for Japanese text,
  including width normalization and hiragana/katakana conversion.

Options:
  --version  Show the version.
  --help     Show this message and exit.

Commands:
  full-to-half          Convert from full-width to half-width characters.
  half-to-full          Convert from half-width to full-width characters.
  hiragana-to-katakana  Convert from hiragana to katakana.
  katakana-to-hiragana  Convert from katakana to hiragana.

--version オプションを指定すると、バージョンを表示して終了します。

% utsuho --version
Utsuho x.x.x

使用例

基本的な使用例を示します。

% utsuho full-to-half "キョウトシ サキョウク ギンカクジチョウ 2"
キョウトシ サキョウク ギンカクジチョウ 2

% utsuho half-to-full "キョウトシ サキョウク ギンカクジチョウ 2"
キョウトシ サキョウク ギンカクジチョウ 2

% utsuho hiragana-to-katakana "きょうとし さきょうく ぎんかくじちょう 2"
キョウトシ サキョウク ギンカクジチョウ 2

% utsuho katakana-to-hiragana "キョウトシ サキョウク ギンカクジチョウ 2"
きょうとし さきょうく ぎんかくじちょう 2

% echo "キョウトシ 2" | utsuho full-to-half
キョウトシ 2

各コマンド

full-to-half

全角文字を半角文字へ変換します。

% utsuho full-to-half --help
Usage: utsuho full-to-half [OPTIONS] [TEXT]

  Convert from full-width to half-width characters.

Options:
  -f, --file  Whether to use TEXT as a file path.
  --help      Show this message and exit.

half-to-full

半角文字を全角文字へ変換します。

% utsuho half-to-full --help
Usage: utsuho half-to-full [OPTIONS] [TEXT]

  Convert from half-width to full-width characters.

Options:
  -f, --file  Whether to use TEXT as a file path.
  --help      Show this message and exit.

hiragana-to-katakana

ひらがなをカタカナへ変換します。

% utsuho hiragana-to-katakana --help
Usage: utsuho hiragana-to-katakana [OPTIONS] [TEXT]

  Convert from hiragana to katakana.

Options:
  -f, --file  Whether to use TEXT as a file path.
  --help      Show this message and exit.

katakana-to-hiragana

カタカナをひらがなへ変換します。

% utsuho katakana-to-hiragana --help
Usage: utsuho katakana-to-hiragana [OPTIONS] [TEXT]

  Convert from katakana to hiragana.

Options:
  -f, --file  Whether to use TEXT as a file path.
  --help      Show this message and exit.

入力方法

各コマンドは、次のいずれかの方法で入力を受け取ります。

  • TEXT 引数

  • 標準入力(stdin)

TEXT を省略した場合、stdin から入力を読み取ります。

% echo "きょうとし 2" | utsuho hiragana-to-katakana
キョウトシ 2

--file オプション

--file(または -f)を指定した場合、TEXT は必須となり、UTF-8 テキストファイルのパスとして扱われます。

このモードでは標準入力は使用されません。

% utsuho full-to-half --file full.txt
キョウトシ サキョウク ギンカクジチョウ 2