跳转到内容
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-CN "Hello, world"

    输出：

    你好，世界

  2. 设置默认目标语言

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

    Terminal window
    yaku config set default-target zh-CN

    现在你可以直接执行：

    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-CN

  3. 翻译试试

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

    输出：

    会议安排在明天十点。

常用示例

Section titled “常用示例”
Terminal window
# 直接翻译文字
yaku --to zh-CN "Good morning"


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


# 翻译 JSON i18n 文件，保留 key
yaku --to zh-CN -f en.json -o zh-CN.json


# 润色你用其他语言写的文字
yaku --mode polish --to en "I want to inform you that the deploy will be delay."


# 添加领域上下文以改善术语
yaku --to zh-CN --context "cooking recipe" -f recipe.en.md


# 使用项目术语表
yaku --to zh-CN --glossary terms.yaml -f docs.en.md


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

下一步

Section titled “下一步”