跳到內容
yaku docs v0.2.0

快速開始

yaku 開箱即用，預設使用託管服務——不需要 API key。如果你想用自己的 LLM API key，請參閱下方的選項 B。

選項 A：使用託管服務（預設）

Section titled “選項 A：使用託管服務（預設）”

  1. 翻譯看看

    不需要任何設定，yaku 會將請求傳送到 api.yakulang.com 的託管服務：

    Terminal window
    yaku --to zh-TW "Hello, world"

    輸出：

    你好，世界

  2. 設定預設目標語言

    省去每次都要輸入 --to：

    Terminal window
    yaku config set default-target zh-TW

    現在你可以直接執行：

    Terminal window
    echo "The meeting is at 10 AM tomorrow." | yaku

  3. 翻譯檔案

    Terminal window
    yaku -f README.en.md -o README.md

    yaku 會偵測 .md 副檔名，自動保留 Markdown 結構（標題、程式碼區塊、連結）。

託管服務使用精調的語言專屬 prompt，翻譯品質更高。詳見託管服務與方案了解配額限制和升級方式。

選項 B：使用自己的 API key

Section titled “選項 B：使用自己的 API key”

  1. 設定你的 API key

    yaku 支援 Gemini、OpenAI 和 Anthropic。選擇一個：

    從 Google AI Studio 取得免費的 API key。

    Terminal window
    yaku config set backend gemini
    yaku config set api-key YOUR_GEMINI_API_KEY

    或使用環境變數：

    Terminal window
    export YAKU_BACKEND=gemini
    export GOOGLE_API_KEY=YOUR_GEMINI_API_KEY

  2. 設定預設目標語言

    Terminal window
    yaku config set default-target zh-TW

  3. 翻譯看看

    Terminal window
    echo "The meeting is scheduled for tomorrow at 10 o'clock." | yaku

    輸出：

    會議排在明天十點。

常用範例

Section titled “常用範例”
Terminal window
# 直接翻譯文字
yaku --to zh-TW "Good morning"


# 指定來源語言
yaku --from ja --to zh-TW "会議は明日の10時です。"


# 翻譯 JSON i18n 檔，保留 key
yaku --to zh-TW -f en.json -o zh-TW.json


# 潤飾你用其他語言寫的文字
yaku --mode polish --to en "I want to inform you that the deploy will be delay."


# 加上領域上下文以改善術語
yaku --to zh-TW --context "cooking recipe" -f recipe.en.md


# 使用專案術語表
yaku --to zh-TW --glossary terms.yaml -f docs.en.md


# 查看模型和 token 使用量
yaku --verbose --to zh-TW "Hello"

下一步

Section titled “下一步”