kotob

README

kotob

GeminiAPIを通して任意の言語・形式に変換するCLI翻訳ツール。
CLI translation tool that converts to any language and format through GeminiAPI.

---

目次 - Table of Contents

• インストール - Installation
• 準備 - Preparation
• 使い方 - Usage
• フラグ - Flags
• ライセンス - License

インストール - Installation

Goを使用する場合 (For Go Users)

go install github.com/kotob-project/kotob@latest

kotob コマンドが認識されない場合は、以下のディレクトリを環境変数 PATH に追加する必要があります。

・Windows: %USERPROFILE%\go\bin
・macOS / Linux: ~/go/bin

バイナリをダウンロードする場合 (Direct Download)

Releases ページから、ご自身の環境に合った最新の実行ファイルをダウンロードしてください。

1. 実行ファイルの配置: ダウンロードしたバイナリ（Windowsの場合は .exe）を任意の場所に配置してください。 例：
   ・Windows: %USERPROFILE%\kotob\
   ・macOS / Linux: ~\kotob\

環境変数 PATH に追加されたディレクトリである必要があります。
PATHの通し方が分からない場合は各自で調べるようお願いします。

1. リネーム ファイル名を kotob（Windowsなら kotob.exe）にリネームしてください。

2. 実行権限の付与 (macOS / Linux): ダウンロードしたファイルに実行権限がない場合は、以下のコマンドを実行してください。

chmod +x "kotob"

準備 - Preparation

kotob を使用するには、Gemini APIキーが必要です。 Google AI Studio でキーを取得し、環境変数 KOTOB_API_KEY に設定してください。
To use kotob, you need a Gemini API key. Obtain your key from Google AI Studio and set it as the environment variable KOTOB_API_KEY.

モデルの選択などの詳細な設定は以下を参照してください。
For detailed settings such as model selection, please refer to the following.

詳細設定について(Advanced settings)

・モデルについて

モデルは環境変数 KOTOB_MODELに利用可能なGeminiのモデル名を指定することで変更できます。
デフォルトはgemini-2.5-flash-liteです。

・設定ファイルについて

{
    "api-key" : "YOUR_API_KEY",
    "model" : "GEMINI_MODEL_NAME",
    "to" : "TARGET_LANGUAGE"
}

のような形式で記述し、各フラグのデフォルト値を指定できます。
kotobが参照するのは実行ディレクトリの kotob.json と ~/.config/kotob/kotob.json です。

また値は

1. コマンドライン引数(Flags)
2. 環境変数
3. 実行ディレクトリの設定ファイル
4. ~/.config/kotob/の設定ファイル

の順に優先されます。

使い方 - Usage

基本

kotob -t ja "Hello, world!"
# こんにちは、世界！

システムプロンプトの設定

kotob -t ja -s "カジュアルに翻訳" "Hello! How are you?"
# やあ！元気？

json出力

kotob -t ja --json "Hello! How are you?"

# {
#  "source": "auto",
#   "target": "ja",
#   "input": "Hello! How are you?",
#   "translated": "こんにちは！お元気ですか？",
#   "model": "gemini-2.5-flash-lite"
# }

その他の機能は フラグ - Flags を参照してください。

フラグ - Flags

kotobの動作を制御するためのフラグです。

短縮	フルパス	説明	デフォルト値
-k	--api-key	Gemini API key	-
-t	--to	翻訳先の言語 (Target language)	Japanese
-f	--from	翻訳元の言語 (Source language)	auto
-s	--system	AIへの指示/制約 (System Prompt)	-
-j	--json	出力結果を構造化データ(JSON)で取得	false
-m	--model	使用するAIモデルの指定	gemini-2.5-flash-lite
-S	--no-stream	ストリーミングを無効化し、一括出力する	false
-h	--help	ヘルプを表示	-

優先順位: コマンド実行時に指定したフラグは、設定ファイル (kotob.json) や環境変数よりも優先して適用されます。

ライセンス - License

Apache License, Version 2.0 の下でライセンスされています。
全文については LICENSE を参照してください。

Licensed under the Apache License, Version 2.0.
See LICENSE for the full license text.