跳转到内容

CLI 选项参考

Terminal window
yaku [flags] [text]

文字可以通过位置参数、-f(文件)或管道从 stdin 提供。详见输入与输出

选项类型默认值说明
--tostring配置中的 default-target必填。 目标语言代码(例如 zh-CNjaen)。
--fromstring自动检测源语言代码。省略可让 LLM 自动检测。
--modestringtranslatetranslate — 翻译成目标语言。polish — 润色已经是目标语言的文字。详见润色模式
--contextstring给 LLM 的领域提示(例如 "Kubernetes 文档""正式信件")。帮助解决模糊的用词。
选项简写类型默认值说明
--file-fstring[]输入文件路径。重复指定可处理多个文件:-f a.md -f b.md
--output-ostringstdout将翻译结果写入文件而非 stdout。
--formatstring自动检测强制指定输入格式:textmdjsonyaml。省略时根据 -f 的扩展名自动检测。
选项类型默认值说明
--backendstringhostedLLM 后端:hostedgeminiopenaianthropic。详见后端
--modelstringbackend 默认值覆盖模型名称(例如 gemini-2.5-flashgpt-4oclaude-sonnet-4-5-20250514)。
--api-basestring任何本地后端的 API base URL 覆盖。常用于 OpenAI 兼容提供商(例如 https://api.groq.com/openai/v1)。
选项类型默认值说明
--glossarystring自动检测术语表 YAML 文件路径。覆盖自动检测。详见术语表
--no-glossaryboolfalse完全跳过术语表加载,即使默认位置存在术语表文件。
选项类型默认值说明
--promptstring内置自定义系统提示词文件路径。完全替换内置提示词。详见自定义提示词
选项类型默认值说明
--verboseboolfalse翻译完成后在 stderr 打印模型名称、token 数和耗时。

--verbose 输出示例(显示在 stderr):

Model: gemini-2.5-flash | Tokens: 42 in / 38 out | Time: 1.2s

管理位于 ~/.config/yaku/config.yaml 的配置文件。

命令说明
yaku config set <key> <value>设置一个配置值。
yaku config get <key>读取一个配置值(仅从文件读取,不包含环境变量覆盖)。
yaku config path打印配置文件路径。

详见配置了解所有可用的键。

通过浏览器设备授权流程与托管服务认证。会打开浏览器并预填授权码——只需登录并点击批准。凭据存储在 ~/.config/yaku/.credentials

Terminal window
yaku login
# 打开浏览器完成认证

撤销服务器上的会话并删除本地凭据。如果服务器无法连接,凭据会保留以便重试。

Terminal window
yaku logout
# 即使服务器撤销失败也强制删除本地凭据
yaku logout --force
选项说明
--force无论服务器是否确认撤销,都删除本地凭据。会话可能在服务器上保持有效,直到过期。

向托管服务查询当前的认证状态。

Terminal window
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 connection

显示你当前的托管服务使用配额。显示方案等级、每日与每月请求次数,以及每次请求的字符上限。使用自备 API 后端时,会报告无配额限制。

详见托管服务与方案了解方案等级和限制。

打印 CLI 版本。

Terminal window
yaku version
# yaku v0.1.0