跳转到内容

云词命令行工具(CLI)

在命令行中使用云词进行导入、导出、同步等操作

云词提供一款强大的命令行工具(CLI),这款工具提供了一系列丰富的命令,帮助您更高效地管理翻译,使其与现有的工作流程无缝对接。

无论是日常的翻译任务,还是在 CI/CD 管道中的自动化流程,都能确保项目多语言文案的流畅和高效的同步。您可以轻松地将翻译文件导出到本地环境,或者将更新的文案重新导入云词,从而简化多语言文本资源的管理和更新过程。

安装

安装完成后,即可在命令行中使用 yundict 命令。

macOS:

通过 Homebrew 安装:

Terminal window
brew tap yundict/cli
brew install yundict

Linux:

前往 GitHub Release 页面下载对应版本的二进制文件,解压后即可使用。

使用

导出文案

通过 yundict export 命令,可以导出指定项目的文案,支持全量导出。

Terminal window
yundict export \
--token <token> \
--team <teamName> \
--project <projectName> \
--type key-value-json \
--languages en \
--out ./en.json
  • —token: 你生成的 API Token,用于认证。
  • —team: 团队标识,在团队设置页中查看。(即 团队 URL
  • —project: 项目标识,在项目设置页中查看。(即 项目 URL
  • —type: 导出的文件类型,支持 key-value-json, csv, android-xml, apple-strings
  • —languages: 导出的语言,多个语言用逗号分隔。例如:en,ja,zh-CN
  • —out: 导出的文件路径。

认证

首先你需要在云词控制台 「个人设置」->「API Token」 获取你的 API Token 用于 API 交互,并将此 Token 传入 --token 参数。

下载

您可以在 GitHub Release 页面下载最新版本的二进制文件,解压后即可使用。

源代码

yundict-cli 的源代码托管在 GitHub 上,您可以在此查看源代码、提交 Issue 或 Pull Request。

https://github.com/yundict/yundict-cli

反馈

如果您在使用过程中遇到问题,或者有任何建议,欢迎在 GitHub Issues 中反馈。