文档 CLI 参考

CLI 参考

i1n CLI 命令、标志和选项的完整参考。

概述

i1n CLI是管理本地化的主要界面。使用 npm i -g i1n 全局安装它。

所有命令都在当前项目目录的上下文中运行,并使用 i1n.config.json 中的配置。

i1n 初始化

在项目中初始化 i1n。运行交互式设置,该设置可检测您的项目框架、设置地区文件格式和目录、配置源语言,并创建 i1n.config.json。

此命令每个项目只需运行一次。重新运行它以重新配置设置。

i1n 推送

将本地翻译文件推送到 i1n。CLI 会扫描您的语言环境文件(例如 locales/**/*.json)并将所有键同步到项目中。

推送后使用 --translate [langs] 来触发 AI 翻译。示例:i1n push --translate es,fr,de,ja 会翻译成西班牙语、法语、德语和日语。

如果自上次同步以来,某个键和语言在双方都被编辑过(即真正的冲突),CLI 会进行交互式提示:保留本地值、接受服务器值或中止推送。仅在服务器端进行的更改(即在您工作期间由其他用户或在仪表板中进行的编辑)会在推送时自动写入您的本地文件,并在需要时重新生成 i1n.d.ts。

可用标志:--translate [langs] 在推送后触发 AI 翻译(示例:i1n push --translate es,fr,de,ja);--strategy <mode> 用于设置冲突策略,可选值包括 interactive(终端默认值)、ours(保留本地版本)、theirs(保留服务器版本)或 abort(遇到任何冲突即终止)。--force 是 --strategy ours 的简写,它会覆盖服务器上的值,此操作具有破坏性,会丢弃其他作者在服务器端所做的任何编辑。

i1n pull

从 i1n 拉取翻译并写入本地文件。获取所有翻译,以您配置的格式写入语言环境文件,并生成 i1n.d.ts TypeScript 类型定义。

在翻译完成后运行此命令,或将其作为 CI/CD 管道的一部分,以确保文件始终保持同步。

i1n 添加语言

在项目中交互式地添加新的目标语言。该命令会检查您套餐中可用的语言槽位,并允许重新激活之前使用的语言,而无需消耗新的槽位。

语言可用性取决于您的套餐:Starter 支持 2 种语言,Pro 支持 5 种语言,Business 支持 12 种语言,Enterprise 支持所有 182 种语言。

i1n 限制

显示项目限制和当前使用情况。显示已用密钥数与限制、已用 AI 翻译积分数与限制、已用语言槽数与可用数,以及活动语言列表。

使用此命令可监控消耗量并确定何时可能需要升级套餐。

i1n 设置-ai

为项目生成 AI 代理上下文规则。为 Cursor (.cursor/rules/i1n.mdc)、Claude Code (CLAUDE.md)、Windsurf (.windsurfrules)、GitHub Copilot (.github/copilot-instructions.md)、Codex (AGENTS.md) 和 Antigravity (.antigravity/rules.md) 创建规则文件。

这些文件教AI代理使用翻译键而不是硬编码字符串,将键放在正确的命名空间文件中,保留插值变量,并在修改后运行i1n push。

i1n mcp

启动一个模型上下文协议 (MCP) 服务器,该服务器将 i1n 工具暴露给 AI 编码助手。这允许 Cursor、Claude Code、Windsurf 和其他兼容 MCP 的代理直接在 IDE 中执行 i1n 命令 — 推送、拉取、翻译、添加语言等 — 而无需离开 IDE。

MCP服务器公开7个工具:i1n_status、i1n_push、i1n_pull、i1n_translate、i1n_add_language、i1n_extract_and_translate和i1n_search。最突出的功能是i1n_extract_and_translate — 您的AI代理从组件中提取硬编码的字符串,将它们传递给i1n,然后它们会被即时推送、翻译成所有活动语言,并重新生成类型定义。使用以下命令进行配置:claude mcp add i1n -- npx i1n mcp。

terminal
i1n init
i1n push
i1n push --translate es,fr,ja
i1n pull
i1n add-language
i1n limits
i1n setup-ai
i1n mcp

相关