@intlayer/docs 7.2.3 → 7.3.0-canary.0

package/docs/zh/cli/doc-translate.md

@@ -0,0 +1,132 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: 翻译文档
+description: 学习如何使用 AI 翻译服务自动翻译文档文件。
+keywords:
+  - 翻译
+  - 文档
+  - 文档管理
+  - AI
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - doc-translate
+---
+
+# 翻译文档
+
+`doc translate` 命令使用 AI 翻译服务，自动将文档文件从基础语言环境翻译到目标语言环境。
+
+```bash
+npx intlayer doc translate
+```
+
+## 参数：
+
+**文件列表选项：**
+
+- **`--doc-pattern [docPattern...]`**：匹配要翻译的文档文件的全局模式。
+
+  > 示例：`npx intlayer doc translate --doc-pattern "docs/**/*.md" "src/**/*.mdx"`
+
+- **`--excluded-glob-pattern [excludedGlobPattern...]`**：排除不翻译的文件的全局匹配模式。
+
+  > 示例：`npx intlayer doc translate --excluded-glob-pattern "docs/internal/**"`
+
+- **`--skip-if-modified-before [skipIfModifiedBefore]`**：如果文件在指定时间之前被修改，则跳过该文件。
+  - 可以是绝对时间，如 "2025-12-05"（字符串或 Date 类型）
+  - 可以是相对时间，单位为毫秒，如 `1 * 60 * 60 * 1000`（1 小时）
+  - 此选项通过 `fs.stat` 方法检查文件的更新时间，因此可能会受到 Git 或其他修改文件工具的影响。
+
+  > 示例：`npx intlayer doc translate --skip-if-modified-before "2025-12-05"`
+
+- **`--skip-if-modified-after [skipIfModifiedAfter]`**：如果文件在指定时间内被修改，则跳过该文件。
+  - 可以是绝对时间，如 "2025-12-05"（字符串或 Date 类型）
+  - 可以是相对时间，单位为毫秒，如 `1 * 60 * 60 * 1000`（1 小时）
+  - 此选项通过 `fs.stat` 方法检查文件的更新时间，因此可能会受到 Git 或其他修改文件工具的影响。
+
+  > 示例：`npx intlayer doc translate --skip-if-modified-after "2025-12-05"`
+
+- **`--skip-if-exists`**：如果文件已存在，则跳过该文件。
+
+  > 示例：`npx intlayer doc translate --skip-if-exists`
+
+**入口输出选项：**
+
+- **`--locales [locales...]`**：目标语言，用于翻译文档。
+
+  > 示例：`npx intlayer doc translate --locales fr es de`
+
+- **`--base-locale [baseLocale]`**：源语言，用于翻译的起始语言。
+
+  > 示例：`npx intlayer doc translate --base-locale en`
+
+**文件处理选项：**
+
+- **`--nb-simultaneous-file-processed [nbSimultaneousFileProcessed]`**：同时处理翻译的文件数量。
+
+  > 示例：`npx intlayer doc translate --nb-simultaneous-file-processed 5`
+
+**AI 选项：**
+
+- **`--model [model]`**：用于翻译的 AI 模型（例如，`gpt-3.5-turbo`）。
+- **`--provider [provider]`**：用于翻译的 AI 提供商。
+- **`--temperature [temperature]`**：AI 模型的温度设置。
+- **`--api-key [apiKey]`**：为 AI 服务提供您自己的 API 密钥。
+- **`--application-context [applicationContext]`**：为 AI 翻译提供额外的上下文信息。
+- **`--custom-prompt [prompt]`**：自定义用于翻译的基础提示。（注意：对于大多数用例，建议使用 `--custom-instructions` 选项，因为它能更好地控制翻译行为。）
+
+  > 示例：`npx intlayer doc translate --model deepseek-chat --provider deepseek --temperature 0.5 --api-key sk-1234567890 --application-context "My application is a cat store"`
+
+**环境变量选项：**
+
+- **`--env`**：指定环境（例如，`development`，`production`）。
+- **`--env-file [envFile]`**：提供自定义环境文件以加载变量。
+- **`--base-dir`**：指定项目的基础目录。
+- **`--no-cache`**：禁用缓存。
+
+  > 示例: `npx intlayer doc translate --base-dir ./docs --env-file .env.production.local`
+
+**日志选项:**
+
+- **`--verbose`**: 启用详细日志以便调试。（CLI 默认启用）
+
+  > 示例: `npx intlayer doc translate --verbose`
+
+**自定义指令选项:**
+
+- **`--custom-instructions [customInstructions]`**: 添加到提示中的自定义指令。用于应用关于格式、URL 翻译等的特定规则。
+  - 可以是绝对时间，如 "2025-12-05"（字符串或 Date 类型）
+  - 可以是以毫秒为单位的相对时间，如 `1 * 60 * 60 * 1000`（1 小时）
+  - 该选项通过 `fs.stat` 方法检查文件的更新时间，因此可能会受到 Git 或其他修改文件工具的影响。
+
+  > 示例: `npx intlayer doc translate --custom-instructions "避免翻译网址，并保持 markdown 格式"`
+
+  > 示例: `npx intlayer doc translate --custom-instructions "$(cat ./instructions.md)"`
+
+**Git 选项:**
+
+- **`--git-diff`**: 仅针对包含从基础分支（默认 `origin/main`）到当前分支（默认 `HEAD`）的更改的字典运行。
+- **`--git-diff-base`**: 指定 git diff 的基础参考（默认 `origin/main`）。
+- **`--git-diff-current`**: 指定 git diff 的当前参考（默认 `HEAD`）。
+- **`--uncommitted`**: 包含未提交的更改。
+- **`--unpushed`**: 包含未推送的更改。
+- **`--untracked`**: 包含未跟踪的文件。
+
+  > 示例: `npx intlayer doc translate --git-diff --git-diff-base origin/main --git-diff-current HEAD`
+
+> 示例: `npx intlayer doc translate --uncommitted --unpushed --untracked`
+
+> 请注意，输出文件路径将通过替换以下模式来确定
+>
+> - `/{{baseLocale}}/` 替换为 `/{{locale}}/`（Unix）
+> - `\{{baseLocale}}\` 替换为 `\{{locale}}\`（Windows）
+> - `_{{baseLocale}}.` 替换为 `_{{locale}}.`
+> - `{{baseLocale}}_` 替换为 `{{locale}}_`
+> - `.{{baseLocaleName}}.` 替换为 `.{{localeName}}.`
+>
+> 如果未找到上述模式，输出文件将在文件扩展名后添加 `.{{locale}}`。例如，`./my/file.md` 将被翻译为法语版本 `./my/file.fr.md`。

package/docs/zh/cli/editor.md

@@ -0,0 +1,28 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: 编辑器命令
+description: 了解如何使用 Intlayer 编辑器命令。
+keywords:
+  - 编辑器
+  - 可视化编辑器
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - editor
+---
+
+# 编辑器命令
+
+`editor` 命令是对 `intlayer-editor` 命令的封装。
+
+> 要能够使用 `editor` 命令，必须安装 `intlayer-editor` 包。（参见 [Intlayer 可视化编辑器](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_visual_editor.md)）
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:editor:start": "npx intlayer editor start --with 'next dev --turbopack'"
+}
+```

package/docs/zh/cli/fill.md

@@ -0,0 +1,130 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: 填充字典
+description: 学习如何使用 AI 填充、审核和翻译您的字典。
+keywords:
+  - 填充
+  - 审核
+  - 翻译
+  - 字典
+  - CLI
+  - Intlayer
+  - AI
+slugs:
+  - doc
+  - concept
+  - cli
+  - fill
+---
+
+# 填充 / 审核 / 翻译字典
+
+```bash
+npx intlayer fill
+```
+
+此命令会分析您的内容声明文件，查找潜在问题，例如缺失的翻译、结构不一致或类型不匹配。如果发现任何问题，**intlayer fill** 将建议或应用更新，以保持您的字典一致且完整。
+
+## 别名：
+
+- `npx intlayer dictionaries fill`
+- `npx intlayer dictionary fill`
+- `npx intlayer dic fill`
+
+## 参数：
+
+**文件列表选项：**
+
+- **`-f, --file [files...]`**：要审核的特定内容声明文件列表。如果未提供，将审核根据您的配置文件设置发现的所有 `*.content.{ts,js,mjs,cjs,tsx,jsx,json}` 文件。
+
+  > 示例：`npx intlayer dictionary fill -f src/home/app.content.ts`
+
+- **`-k, --keys [keys...]`**：基于键过滤字典。如果未提供，将审核所有字典。
+
+  > 示例：`npx intlayer dictionary fill -k key1 key2`
+
+- **`--key [keys...]`**：基于键过滤字典（--keys 的别名）。
+
+  > 示例：`npx intlayer dictionary fill --key key1 key2`
+
+- **`--excluded-keys [excludedKeys...]`**：基于键过滤排除字典。如果未提供，将审核所有字典。
+
+  > 示例：`npx intlayer dictionary fill --excluded-keys key1 key2`
+
+- **`--excluded-key [excludedKeys...]`**：基于键过滤排除字典（--excluded-keys 的别名）。
+
+  > 示例：`npx intlayer dictionary fill --excluded-key key1 key2`
+
+- **`--path-filter [pathFilters...]`**：基于文件路径的 glob 模式过滤字典。
+
+  > 示例：`npx intlayer dictionary fill --path-filter "src/home/**"`
+
+**条目输出选项：**
+
+- **`--source-locale [sourceLocale]`**：要翻译的源语言区域。如果未指定，将使用配置中的默认语言区域。
+
+- **`--output-locales [outputLocales...]`**：目标翻译语言区域。如果未指定，将使用配置中的所有语言区域，除了源语言区域。
+
+- **`--mode [mode]`**：翻译模式：`complete`（完整）、`review`（审核）。默认是 `complete`。`complete` 会填充所有缺失内容，`review` 会填充缺失内容并审核已有的键。
+
+**Git 选项：**
+
+- **`--git-diff`**：仅对包含从基准（默认 `origin/main`）到当前分支（默认 `HEAD`）的变更的字典执行操作。
+- **`--git-diff-base`**：指定 git diff 的基准引用（默认 `origin/main`）。
+- **`--git-diff-current`**：指定 git diff 的当前引用（默认 `HEAD`）。
+- **`--uncommitted`**：包含未提交的更改。
+- **`--unpushed`**：包含未推送的更改。
+- **`--untracked`**：包含未跟踪的文件。
+
+  > 示例：`npx intlayer doc translate --git-diff --git-diff-base origin/main --git-diff-current HEAD`
+
+  > 示例：`npx intlayer doc translate --uncommitted --unpushed --untracked`
+
+**AI 选项：**
+
+- **`--model [model]`**：用于翻译的 AI 模型（例如，`gpt-3.5-turbo`）。
+- **`--provider [provider]`**：用于翻译的 AI 提供商。
+- **`--temperature [temperature]`**：AI 模型的温度设置。
+- **`--api-key [apiKey]`**：为 AI 服务提供您自己的 API 密钥。
+- **`--custom-prompt [prompt]`**：为您的翻译指令提供自定义提示。
+- **`--application-context [applicationContext]`**：为 AI 翻译提供额外的上下文。
+
+  > 示例：`npx intlayer fill --model gpt-3.5-turbo --provider openai --temperature 0.5 --api-key sk-1234567890 --application-context "我的应用是一个猫咪商店"`
+
+**环境变量选项：**
+
+- **`--env`**：指定环境（例如，`development`，`production`）。
+- **`--env-file [envFile]`**：提供自定义环境文件以加载变量。
+
+  > 示例：`npx intlayer fill --env-file .env.production.local`
+
+  > 示例：`npx intlayer fill --env production`
+
+**配置选项：**
+
+- **`--base-dir`**：指定项目的基础目录。
+
+  > 示例：`npx intlayer fill --base-dir ./src`
+
+- **`--no-cache`**：禁用缓存。
+
+  > 示例：`npx intlayer build --no-cache`
+
+**准备选项：**
+
+- **`--build`**：在推送之前构建字典以确保内容是最新的。设置为 true 将强制构建，false 将跳过构建，undefined 将允许使用构建缓存。
+
+- **`--skip-metadata`**：跳过为字典填写缺失的元数据（描述、标题、标签）。
+
+**日志选项：**
+
+- **`--verbose`**：启用详细日志以便调试。（CLI 默认启用）
+
+## 示例：
+
+```bash
+npx intlayer fill --file src/home/*.content.ts --source-locale en --output-locales fr es --model gpt-3.5-turbo
+```
+
+该命令将使用 GPT-3.5 Turbo 模型，将 `src/home/` 目录下所有内容声明文件的内容从英语翻译为法语和西班牙语。

package/docs/zh/cli/index.md

@@ -0,0 +1,168 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: CLI
+description: 了解如何使用 Intlayer CLI 来管理您的多语言网站。按照本在线文档中的步骤，几分钟内即可设置您的项目。
+keywords:
+  - CLI
+  - 命令行界面
+  - 国际化
+  - 文档
+  - Intlayer
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - concept
+  - cli
+history:
+  - version: 7.2.3
+    date: 2025-11-22
+    changes: 添加 transform 命令
+  - version: 7.1.0
+    date: 2025-11-05
+    changes: 为 translate 命令添加 skipIfExists 选项
+  - version: 6.1.4
+    date: 2025-01-27
+    changes: 为 CLI 参数和命令添加别名
+  - version: 6.1.3
+    date: 2025-10-05
+    changes: 为命令添加 build 选项
+  - version: 6.1.2
+    date: 2025-09-26
+    changes: 添加 version 命令
+  - version: 6.1.0
+    date: 2025-09-26
+    changes: 使用 CLI 将 verbose 选项默认设置为 true
+  - version: 6.1.0
+    date: 2025-09-23
+    changes: 添加 watch 命令和 with 选项
+  - version: 6.0.1
+    date: 2025-09-23
+    changes: 添加 editor 命令
+  - version: 6.0.0
+    date: 2025-09-17
+    changes: 添加 content test 和 list 命令
+  - version: 5.5.11
+    date: 2025-07-11
+    changes: 更新 CLI 命令参数文档
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: 初始化历史记录
+---
+
+# Intlayer CLI
+
+---
+
+## 目录
+
+<TOC/>
+
+---
+
+## 安装包
+
+使用 npm 安装必要的包：
+
+```bash packageManager="npm"
+npm install intlayer-cli -g
+```
+
+```bash packageManager="yarn"
+yarn add intlayer-cli -g
+```
+
+```bash packageManager="pnpm"
+pnpm add intlayer-cli -g
+```
+
+> 如果已经安装了 `intlayer` 包，CLI 会自动安装。你可以跳过这一步。
+
+## intlayer-cli 包
+
+`intlayer-cli` 包旨在将你的 [intlayer 声明](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/content_file.md) 转换成字典。
+
+该包会转换所有 intlayer 文件，例如 `src/**/*.content.{ts|js|mjs|cjs|json}`。[查看如何声明你的 Intlayer 声明文件](https://github.com/aymericzip/intlayer/blob/main/packages/intlayer/README.md)。
+
+要解释 intlayer 字典，你可以使用解释器，例如 [react-intlayer](https://www.npmjs.com/package/react-intlayer) 或 [next-intlayer](https://www.npmjs.com/package/next-intlayer)。
+
+## 配置文件支持
+
+Intlayer 支持多种配置文件格式：
+
+- `intlayer.config.ts`
+- `intlayer.config.js`
+- `intlayer.config.json`
+- `intlayer.config.cjs`
+- `intlayer.config.mjs`
+- `.intlayerrc`
+
+有关如何配置可用语言环境或其他参数，请参阅[此处的配置文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md)。
+
+## 运行 intlayer 命令
+
+### 核心命令
+
+- **[构建字典](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/build.md)** - 从内容声明文件构建字典
+- **[监视字典](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/watch.md)** - 监视更改并自动构建字典
+- **[检查 CLI 版本](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/version.md)** - 检查已安装的 Intlayer CLI 版本
+
+### 字典管理
+
+- **[推送字典](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/push.md)** - 将字典推送到 Intlayer 编辑器和 CMS
+- **[拉取词典](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/pull.md)** - 从 Intlayer 编辑器和 CMS 拉取词典
+- **[填充词典](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/fill.md)** - 使用 AI 填充、审核和翻译词典
+- **[测试缺失翻译](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/test.md)** - 测试并识别缺失的翻译
+- **[列出内容声明文件](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/list.md)** - 列出项目中所有内容声明文件
+
+### 组件管理
+
+- **[转换组件](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/transform.md)** - 转换现有组件以使用 Intlayer
+
+### 配置
+
+- **[管理配置](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/configuration.md)** - 获取并推送您的 Intlayer 配置到 CMS
+
+### 文档管理
+
+- **[翻译文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/doc-translate.md)** - 使用 AI 自动翻译文档文件
+- **[审查文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/doc-review.md)** - 审查文档文件的质量和一致性
+
+### 编辑器与实时同步
+
+- **[编辑器命令](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/editor.md)** - 使用 Intlayer 编辑器命令
+- **[实时同步命令](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/live.md)** - 使用实时同步在运行时反映 CMS 内容更改
+
+### 开发工具
+
+- **[CLI SDK](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/sdk.md)** - 在您自己的代码中使用 Intlayer CLI SDK
+- **[调试 Intlayer 命令](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/debug.md)** - 调试和排查 Intlayer CLI 问题
+
+## 在您的 `package.json` 中使用 intlayer 命令
+
+- **[编辑器命令](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/editor.md)** - 使用 Intlayer 编辑器命令
+- **[实时同步命令](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/live.md)** - 使用实时同步在运行时反映 CMS 内容更改
+
+## 在您的 `package.json` 中使用 intlayer 命令
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:build": "npx intlayer build",
+  "intlayer:watch": "npx intlayer build --watch",
+  "intlayer:push": "npx intlayer push",
+  "intlayer:pull": "npx intlayer pull",
+  "intlayer:fill": "npx intlayer fill",
+  "intlayer:list": "npx intlayer content list",
+  "intlayer:test": "npx intlayer content test",
+  "intlayer:transform": "npx intlayer transform",
+  "intlayer:doc:translate": "npx intlayer doc translate",
+  "intlayer:doc:review": "npx intlayer doc review"
+}
+```
+
+> **注意**：您也可以使用更简短的别名：
+>
+> - 使用 `npx intlayer list` 替代 `npx intlayer content list`
+> - 使用 `npx intlayer test` 替代 `npx intlayer content test`

package/docs/zh/cli/list.md

@@ -0,0 +1,53 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: 列出内容声明文件
+description: 了解如何列出项目中的所有内容声明文件。
+keywords:
+  - 列表
+  - 内容声明
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - list
+---
+
+# 列出内容声明文件
+
+```bash
+npx intlayer content list
+```
+
+## 别名：
+
+- `npx intlayer list`
+
+此命令显示项目中所有内容声明文件，展示它们的字典键和文件路径。它有助于概览所有内容文件，并验证它们是否被 Intlayer 正确发现。
+
+## 示例：
+
+```bash
+npx intlayer content list
+```
+
+## 示例输出：
+
+```bash
+npx intlayer content list
+Content declaration files:
+ - home-page        - src/components/HomePage/homePage.content.ts
+ - server-component - src/components/ServerComponent/serverComponent.content.ts
+ - client-component - src/components/ClientComponent/clientComponent.content.ts
+
+内容声明文件总数：3
+```
+
+此命令将输出：
+
+- 所有内容声明文件的格式化列表，包含它们的键和相对文件路径
+- 发现的内容声明文件总数
+
+该输出帮助您验证所有内容文件是否已正确配置并能被 Intlayer 系统发现。

package/docs/zh/cli/live.md

@@ -0,0 +1,41 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: 实时同步命令
+description: 了解如何使用实时同步在运行时反映 CMS 内容更改。
+keywords:
+  - 实时同步
+  - CMS
+  - 运行时
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - live
+---
+
+# 实时同步命令
+
+实时同步让您的应用在运行时反映 CMS 内容的更改。无需重新构建或重新部署。启用后，更新会被流式传输到实时同步服务器，该服务器会刷新您的应用读取的字典。详情请参见 [Intlayer CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_CMS.md)。
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:live:start": "npx intlayer live start --with 'next dev --turbopack'"
+}
+```
+
+## 参数：
+
+**配置选项：**
+
+- **`--base-dir`**：指定项目的基础目录。命令将在该基础目录中查找 `intlayer.config.{ts,js,json,cjs,mjs}` 文件以获取 intlayer 配置。
+
+- **`--no-cache`**：禁用缓存。
+
+  > 示例：`npx intlayer dictionary push --env-file .env.production.local`
+
+**日志选项：**
+
+- **`--verbose`**：启用详细日志以便调试。（CLI 默认启用）

package/docs/zh/cli/pull.md

@@ -0,0 +1,78 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: 拉取词典
+description: 了解如何从 Intlayer 编辑器和 CMS 拉取词典。
+keywords:
+  - 拉取
+  - 词典
+  - CLI
+  - Intlayer
+  - 编辑器
+  - CMS
+slugs:
+  - doc
+  - concept
+  - cli
+  - pull
+---
+
+# 拉取远程词典
+
+```bash
+npx intlayer pull
+```
+
+如果已安装 [intlayer 编辑器](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_visual_editor.md)，你也可以从编辑器拉取词典。通过这种方式，你可以根据应用需求覆盖词典内容。
+
+## 别名：
+
+- `npx intlayer dictionaries pull`
+- `npx intlayer dictionary pull`
+- `npx intlayer dic pull`
+
+## 参数：
+
+**词典选项：**
+
+- **`-d, --dictionaries`**：要拉取的词典 ID。如果未指定，则会拉取所有词典。
+
+  > 示例：`npx intlayer dictionary pull -d my-dictionary-id my-other-dictionary-id`
+
+- **`--dictionary`**：要拉取的词典 ID（--dictionaries 的别名）。
+
+  > 示例：`npx intlayer dictionary pull --dictionary my-dictionary-id my-other-dictionary-id`
+
+**配置选项：**
+
+- **`--base-dir`**：指定项目的基础目录。命令会在该目录中查找 `intlayer.config.{ts,js,json,cjs,mjs}` 文件以获取 intlayer 配置。
+
+  > 示例：`npx intlayer dictionary push --env-file .env.production.local`
+
+- **`--no-cache`**：禁用缓存。
+
+  > 示例：`npx intlayer build --no-cache`
+
+**环境变量选项：**
+
+- **`--env`**：指定环境（例如，`development`，`production`）。
+- **`--env-file`**：提供自定义环境文件以加载变量。
+- **`--base-dir`**：指定项目的基础目录。命令会在该目录中查找 `intlayer.config.{ts,js,json,cjs,mjs}` 文件以获取 intlayer 配置。
+
+  > 示例：`npx intlayer dictionary push --env-file .env.production.local`
+
+  > 示例：`npx intlayer dictionary push --env production`
+
+**输出选项：**
+
+- **`--new-dictionaries-path`** ：新词典将被保存的目录路径。如果未指定，新词典将保存在项目的 `./intlayer-dictionaries` 目录中。如果在词典内容中指定了 `filePath` 字段，词典将忽略此参数，并保存在指定的 `filePath` 目录中。
+
+**日志选项：**
+
+- **`--verbose`**：启用详细日志以便调试。（CLI 默认启用）
+
+## 示例：
+
+```bash
+npx intlayer dictionary pull --newDictionariesPath ./my-dictionaries-dir/
+```