CLI 選項參考
yaku [flags] [text]文字可以透過位置參數、-f(檔案)或 pipe 從 stdin 提供。詳見輸入與輸出。
| 選項 | 類型 | 預設值 | 說明 |
|---|---|---|---|
--to | string | 設定中的 default-target | 必填。 目標語言代碼(例如 zh-TW、ja、en)。 |
--from | string | 自動偵測 | 來源語言代碼。省略可讓 LLM 自動偵測。 |
--mode | string | translate | translate — 翻譯成目標語言。polish — 潤飾已經是目標語言的文字。詳見潤飾模式。 |
--context | string | 給 LLM 的領域提示(例如 "Kubernetes 文件"、"正式信件")。幫助解決模糊的用詞。 |
輸入/輸出選項
Section titled “輸入/輸出選項”| 選項 | 簡寫 | 類型 | 預設值 | 說明 |
|---|---|---|---|---|
--file | -f | string[] | 輸入檔案路徑。重複指定可處理多個檔案:-f a.md -f b.md。 | |
--output | -o | string | stdout | 將翻譯結果寫入檔案而非 stdout。 |
--format | string | 自動偵測 | 強制指定輸入格式:text、md、json、yaml。省略時根據 -f 的副檔名自動偵測。 |
| 選項 | 類型 | 預設值 | 說明 |
|---|---|---|---|
--backend | string | hosted | LLM 後端:hosted、gemini、openai、anthropic。詳見後端。 |
--model | string | backend 預設值 | 覆蓋模型名稱(例如 gemini-2.5-flash、gpt-4o、claude-sonnet-4-5-20250514)。 |
--api-base | string | 任何自備 API 後端的 API base URL 覆寫(例如 https://api.groq.com/openai/v1)。常用於 OpenAI 相容供應商。 |
| 選項 | 類型 | 預設值 | 說明 |
|---|---|---|---|
--glossary | string | 自動偵測 | 術語表 YAML 檔案路徑。覆蓋自動偵測。詳見術語表。 |
--no-glossary | bool | false | 完全跳過術語表載入,即使預設位置存在術語表檔案。 |
| 選項 | 類型 | 預設值 | 說明 |
|---|---|---|---|
--prompt | string | 內建 | 自訂系統提示詞檔案路徑。完全取代內建提示詞。詳見自訂提示詞。 |
| 選項 | 類型 | 預設值 | 說明 |
|---|---|---|---|
--verbose | bool | false | 翻譯完成後在 stderr 印出模型名稱、token 數和耗時。 |
--verbose 輸出範例(顯示在 stderr):
Model: gemini-2.5-flash | Tokens: 42 in / 38 out | Time: 1.2syaku config
Section titled “yaku config”管理位於 ~/.config/yaku/config.yaml 的設定檔。
| 指令 | 說明 |
|---|---|
yaku config set <key> <value> | 設定一個設定值。 |
yaku config get <key> | 讀取一個設定值(僅從檔案讀取,不包含環境變數覆蓋)。 |
yaku config path | 印出設定檔路徑。 |
詳見設定了解所有可用的鍵。
yaku login
Section titled “yaku login”透過瀏覽器裝置授權流程與託管服務認證。會開啟瀏覽器並預填授權碼——只需登入並點擊核准。憑證儲存在 ~/.config/yaku/.credentials。
yaku login# 開啟瀏覽器完成認證yaku logout
Section titled “yaku logout”撤銷伺服器上的工作階段並刪除本機憑證。如果伺服器無法連線,憑證會保留以便重試。
yaku logout
# 即使伺服器撤銷失敗也強制刪除本機憑證yaku logout --force| 選項 | 說明 |
|---|---|
--force | 無論伺服器是否確認撤銷,都刪除本機憑證。工作階段可能在伺服器上保持有效,直到過期。 |
yaku whoami
Section titled “yaku whoami”向託管服務查詢目前的認證狀態。
yaku whoami# 以 Jane Doe([email protected], github)的身分登入如果未登入:
Not logged in (using anonymous quota)如果工作階段已過期或無效:
Session expired or invalid. Run yaku login to re-authenticate.如果伺服器無法連線:
hosted service unreachable. Check your network connectionyaku quota
Section titled “yaku quota”顯示你目前的託管服務使用配額。顯示方案等級、每日與每月請求次數,以及每次請求的字元上限。使用自備 API 後端時,會回報無配額限制。
詳見託管服務與方案了解方案等級和限制。
yaku version
Section titled “yaku version”印出 CLI 版本。
yaku version# yaku v0.1.0