快速开始

更新时间:上个月 · 预计阅读 1 分钟

已弃用

这些文档介绍的是旧版 CLI(v0)。当前 CLI 版本为 v1。 查看当前 CLI 文档

安装 Lingo.dev CLI,完成项目配置,并生成第一批译文。

准备工作

需要 Node.js 18 或更高版本。运行 node -v 检查当前版本。

第 1 步:初始化项目#

1

进入项目目录

bash
cd your-project-directory
2

运行 init 命令

bash
npx lingo.dev@latest init

**Windows 用户:**如果 npx lingo.dev 无法运行,请先用 npm install lingo.dev@latest 安装该软件包,再改用 npx lingo。

按提示操作即可。CLI 会在项目根目录下创建一个 i18n.json 配置文件。

第 2 步:配置 bucket#

在 i18n.json 中,至少配置一个 bucket——也就是文件格式与 include 模式的组合,用来告诉 CLI 哪些位置包含可翻译内容:

json
{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.15",
  "locale": {
    "source": "en",
    "targets": ["es", "fr", "de"]
  },
  "buckets": {
    "json": {
      "include": ["locales/[locale].json"]
    }
  }
}

[locale] 占位符会在运行时解析为你配置的 locale 代码——源语言对应 locales/en.json,西班牙语对应 locales/es.json,以此类推。

如需查看所有支持的文件格式及对应的 bucket 配置,请参阅 Supported Formats。

第 3 步:连接翻译后端#

CLI 需要连接翻译后端才能生成译文。你有两种选择:

在 Lingo.dev 上,本地化引擎会自动为每一次翻译请求应用 品牌语调、术语表、规则和 模型配置。

  1. 创建账户,然后在 API Keys 页面生成 API 密钥。

  2. 将 API 密钥设置为环境变量:

bash
export LINGO_API_KEY="your-api-key"

无需额外配置——CLI 会默认使用你所在组织的 localization engine。若要指定某个引擎,请在 engineId 中加入 i18n.json:

json
{
  "engineId": "eng_SxjMwMsfOIsvV1wh"
}

第 4 步:生成译文#

bash
npx lingo.dev@latest run

CLI 会自动发现源文件、提取可翻译内容、发送到你配置的翻译后端,并将结果写回磁盘。系统还会创建一个 i18n.lock 文件,用于跟踪已翻译内容——请将它与 locale 文件一并提交。

下一步#