@intlayer/docs 7.5.0-canary.0 → 7.5.0-canary.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/dist/cjs/generated/docs.entry.cjs +19 -0
  2. package/dist/cjs/generated/docs.entry.cjs.map +1 -1
  3. package/dist/esm/generated/docs.entry.mjs +19 -0
  4. package/dist/esm/generated/docs.entry.mjs.map +1 -1
  5. package/dist/types/generated/docs.entry.d.ts +1 -0
  6. package/dist/types/generated/docs.entry.d.ts.map +1 -1
  7. package/docs/ar/cli/index.md +5 -0
  8. package/docs/ar/cli/login.md +157 -0
  9. package/docs/ar/configuration.md +12 -0
  10. package/docs/de/cli/index.md +5 -0
  11. package/docs/de/cli/login.md +160 -0
  12. package/docs/de/configuration.md +12 -0
  13. package/docs/en/cli/index.md +5 -0
  14. package/docs/en/cli/login.md +157 -0
  15. package/docs/en/configuration.md +13 -0
  16. package/docs/en/index.md +1 -0
  17. package/docs/en/intlayer_with_tanstack.md +7 -6
  18. package/docs/en-GB/cli/index.md +5 -0
  19. package/docs/en-GB/cli/login.md +181 -0
  20. package/docs/en-GB/configuration.md +12 -0
  21. package/docs/es/cli/index.md +5 -0
  22. package/docs/es/cli/login.md +182 -0
  23. package/docs/es/configuration.md +12 -0
  24. package/docs/fr/cli/index.md +5 -0
  25. package/docs/fr/cli/login.md +185 -0
  26. package/docs/fr/configuration.md +12 -0
  27. package/docs/hi/cli/index.md +5 -0
  28. package/docs/hi/cli/login.md +181 -0
  29. package/docs/hi/configuration.md +12 -0
  30. package/docs/id/cli/index.md +5 -0
  31. package/docs/id/cli/login.md +157 -0
  32. package/docs/id/configuration.md +12 -0
  33. package/docs/it/cli/index.md +5 -0
  34. package/docs/it/cli/login.md +157 -0
  35. package/docs/it/configuration.md +12 -0
  36. package/docs/ja/cli/index.md +5 -0
  37. package/docs/ja/cli/login.md +159 -0
  38. package/docs/ja/configuration.md +12 -0
  39. package/docs/ko/cli/index.md +5 -0
  40. package/docs/ko/cli/login.md +188 -0
  41. package/docs/ko/configuration.md +12 -0
  42. package/docs/pl/cli/index.md +5 -0
  43. package/docs/pl/cli/login.md +187 -0
  44. package/docs/pl/configuration.md +12 -0
  45. package/docs/pt/cli/index.md +5 -0
  46. package/docs/pt/cli/login.md +186 -0
  47. package/docs/pt/configuration.md +12 -0
  48. package/docs/pt/intlayer_with_react_router_v7_fs_routes.md +570 -0
  49. package/docs/ru/cli/index.md +5 -0
  50. package/docs/ru/cli/login.md +181 -0
  51. package/docs/ru/configuration.md +12 -0
  52. package/docs/tr/cli/index.md +5 -0
  53. package/docs/tr/cli/login.md +171 -0
  54. package/docs/tr/configuration.md +12 -0
  55. package/docs/vi/cli/index.md +5 -0
  56. package/docs/vi/cli/login.md +186 -0
  57. package/docs/vi/configuration.md +12 -0
  58. package/docs/zh/cli/index.md +5 -0
  59. package/docs/zh/cli/login.md +182 -0
  60. package/docs/zh/configuration.md +12 -0
  61. package/package.json +9 -9
  62. package/src/generated/docs.entry.ts +19 -0
@@ -0,0 +1,182 @@
1
+ ---
2
+ createdAt: 2025-12-16
3
+ updatedAt: 2025-12-16
4
+ title: CLI - 登录
5
+ description: 了解如何使用 Intlayer CLI 的 login 命令与 Intlayer CMS 进行身份验证并获取访问凭证。
6
+ keywords:
7
+ - CLI
8
+ - 登录
9
+ - 认证
10
+ - CMS
11
+ - Intlayer
12
+ - 凭证
13
+ slugs:
14
+ - doc
15
+ - concept
16
+ - cli
17
+ - login
18
+ ---
19
+
20
+ # Intlayer CLI 登录命令
21
+
22
+ ---
23
+
24
+ ## 描述
25
+
26
+ Intlayer CLI 的 `login` 命令允许您对 Intlayer CMS 进行身份验证。该命令会自动打开您的默认浏览器以完成身份验证流程,并接收使用 Intlayer 服务所需的凭证(Client ID 和 Client Secret)。
27
+
28
+ ## 用法
29
+
30
+ ```bash
31
+ npx intlayer login [options]
32
+ ```
33
+
34
+
35
+
36
+ ```bash
37
+ intlayer login [options]
38
+ ```
39
+
40
+ ## 选项
41
+
42
+ ### `--cms-url <url>`
43
+
44
+ 指定用于身份验证的 Intlayer CMS 的 URL。
45
+
46
+ - **类型**: `string`
47
+ - **默认**: 在 `intlayer.config.*` 中配置的值,或 `https://intlayer.org`
48
+ - **示例**:
49
+
50
+ ```bash
51
+ npx intlayer login --cms-url https://intlayer.org
52
+ ```
53
+
54
+ ### 配置选项
55
+
56
+ 您还可以使用常见的配置选项:
57
+
58
+ - `--env-file <path>`:环境文件的路径
59
+ - `-e, --env <env>`:执行环境
60
+ - `--base-dir <dir>`:项目的基目录
61
+ - `--verbose`:启用详细输出(默认:true)
62
+ - `--prefix <prefix>`:日志前缀
63
+
64
+ ## 工作原理
65
+
66
+ 1. **启动本地服务器**:该命令在一个随机端口上启动本地 HTTP 服务器,以从 CMS 接收凭证
67
+
68
+ 指定要用于身份验证的 Intlayer CMS 的 URL。
69
+
70
+ - **类型**: `string`
71
+ - **默认**: 在 `intlayer.config.*` 中配置的值,或 `https://intlayer.org`
72
+ - **示例**:
73
+
74
+ ```bash
75
+ npx intlayer login --cms-url https://intlayer.org
76
+ ```
77
+
78
+ ### 配置选项
79
+
80
+ 您还可以使用常用的配置选项:
81
+
82
+ - `--env-file <path>`: 环境文件的路径
83
+ - `-e, --env <env>`: 执行环境
84
+ - `--base-dir <dir>`: 项目的基目录
85
+ - `--verbose`: 启用详细输出(默认:true)
86
+ - `--prefix <prefix>`: 日志前缀
87
+
88
+ ## 工作原理
89
+
90
+ 1. **启动本地服务器**:该命令在随机端口启动一个本地 HTTP 服务器以接收来自 CMS 的凭证
91
+ 2. **Browser Opening**:该命令会自动在你的默认浏览器中打开 CMS 的登录 URL
92
+ 3. **Authentication**:在浏览器中使用你的 Intlayer 帐户完成身份验证
93
+ 4. **Credentials Reception**:本地服务器从 CMS 接收 Client ID 和 Client Secret
94
+ 5. **Instructions**:该命令显示在项目中配置凭证的说明
95
+
96
+ ## 输出
97
+
98
+ 登录成功后,命令将显示:
99
+
100
+ 1. **接收到的凭证**(Client ID 和 Client Secret)
101
+ 2. **`.env` 文件的说明**:
102
+
103
+ ```bash
104
+ INTLAYER_CLIENT_ID=your_client_id
105
+ INTLAYER_CLIENT_SECRET=your_client_secret
106
+ ```
107
+
108
+ 3. **Intlayer 配置文件的说明**:
109
+
110
+ ```typescript
111
+ {
112
+ editor: {
113
+ cmsURL: 'https://intlayer.org',
114
+ clientId: process.env.INTLAYER_CLIENT_ID,
115
+ clientSecret: process.env.INTLAYER_CLIENT_SECRET,
116
+ },
117
+ }
118
+ ```
119
+
120
+ ## 手动配置
121
+
122
+ 如果浏览器没有自动打开,您可以手动访问终端中显示的 URL。
123
+
124
+ ## 示例
125
+
126
+ ### 使用自定义 CMS URL 登录
127
+
128
+ ```bash
129
+ npx intlayer login --cms-url https://custom-cms.example.com
130
+ ```
131
+
132
+ ### 使用特定环境文件登录
133
+
134
+ ```bash
135
+ npx intlayer login --env-file .env.production
136
+ ```
137
+
138
+ ### 以详细模式登录
139
+
140
+ ```bash
141
+ npx intlayer login --verbose
142
+ ```
143
+
144
+ ## 故障排除
145
+
146
+ ### 浏览器未打开
147
+
148
+ 如果浏览器没有自动打开,请复制终端中显示的 URL 并在浏览器中手动打开。
149
+
150
+ ### 连接问题
151
+
152
+ 如果遇到连接问题,请验证:
153
+
154
+ 1. 确认 CMS URL 是否正确
155
+ 2. 确认您的网络连接正常工作
156
+ 3. 确认没有防火墙阻止连接
157
+
158
+ ### 未收到凭证
159
+
160
+ 如果未收到凭证:
161
+
162
+ 1. 确保在浏览器中完成了身份验证流程
163
+ 2. 验证本地端口未被阻塞
164
+ 3. 重新尝试该命令
165
+
166
+ ## 后续步骤
167
+
168
+ 完成登录后:
169
+
170
+ 1. 将凭证添加到您的 `.env` 文件中
171
+ 2. 在 `intlayer.config.*` 文件中配置这些凭证
172
+ 3. 使用 CLI 命令管理您的词典:
173
+ - [`npx intlayer push`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/push.md) - 将词典推送到 CMS
174
+ - [`npx intlayer pull`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/pull.md) - 从 CMS 拉取词典
175
+ - [`npx intlayer fill`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/fill.md) - 填充缺失的翻译
176
+ - [`npx intlayer fill`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/fill.md) - 填充缺失的翻译
177
+
178
+ ## 另请参阅
179
+
180
+ - [CLI 文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/index.md)
181
+ - [Intlayer 配置](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md)
182
+ - [Intlayer CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_CMS.md)
@@ -14,6 +14,9 @@ slugs:
14
14
  - concept
15
15
  - configuration
16
16
  history:
17
+ - version: 7.5.0
18
+ date: 2025-12-17
19
+ changes: 添加 `buildMode` 选项
17
20
  - version: 6.0.0
18
21
  date: 2025-09-16
19
22
  changes: 添加 `live` 导入模式
@@ -528,6 +531,15 @@ Intlayer 支持多个 AI 提供商,以增强灵活性和选择。目前支持
528
531
 
529
532
  #### 属性
530
533
 
534
+ - **mode**:
535
+ - _类型_:`'auto' | 'manual'`
536
+ - _默认值_:`'auto'`
537
+ - _描述_:控制构建的模式。
538
+ - _示例_:`'manual'`
539
+ - _注意_:如果为 'auto',构建将在应用程序构建时自动启用。
540
+ - _注意_:如果为 'manual',构建仅在执行构建命令时设置。
541
+ - _注意_:可用于禁用字典构建,例如当应避免在 Node.js 环境中执行时。
542
+
531
543
  - **optimize**:
532
544
  - _类型_:`boolean`
533
545
  - _默认值_:`process.env.NODE_ENV === 'production'`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@intlayer/docs",
3
- "version": "7.5.0-canary.0",
3
+ "version": "7.5.0-canary.1",
4
4
  "private": false,
5
5
  "description": "Intlayer documentation",
6
6
  "keywords": [
@@ -73,23 +73,23 @@
73
73
  "watch": "webpack --config ./webpack.config.ts --watch"
74
74
  },
75
75
  "dependencies": {
76
- "@intlayer/config": "7.5.0-canary.0",
77
- "@intlayer/core": "7.5.0-canary.0",
78
- "@intlayer/types": "7.5.0-canary.0"
76
+ "@intlayer/config": "7.5.0-canary.1",
77
+ "@intlayer/core": "7.5.0-canary.1",
78
+ "@intlayer/types": "7.5.0-canary.1"
79
79
  },
80
80
  "devDependencies": {
81
- "@intlayer/api": "7.5.0-canary.0",
82
- "@intlayer/cli": "7.5.0-canary.0",
83
- "@types/node": "24.10.1",
81
+ "@intlayer/api": "7.5.0-canary.1",
82
+ "@intlayer/cli": "7.5.0-canary.1",
83
+ "@types/node": "25.0.2",
84
84
  "@utils/ts-config": "1.0.4",
85
85
  "@utils/ts-config-types": "1.0.4",
86
86
  "@utils/tsdown-config": "1.0.4",
87
87
  "fast-glob": "3.3.3",
88
88
  "rimraf": "6.1.2",
89
- "tsdown": "0.16.8",
89
+ "tsdown": "0.18.0",
90
90
  "tsx": "^4.20.6",
91
91
  "typescript": "5.9.3",
92
- "vitest": "4.0.15"
92
+ "vitest": "4.0.16"
93
93
  },
94
94
  "engines": {
95
95
  "node": ">=14.18"
@@ -300,6 +300,25 @@ export const docsEntry = {
300
300
  id: readLocale('cli/live.md', 'id'),
301
301
  vi: readLocale('cli/live.md', 'vi'),
302
302
  } as unknown as Record<LocalesValues, Promise<string>>,
303
+ './docs/en/cli/login.md': {
304
+ en: readLocale('cli/login.md', 'en'),
305
+ ru: readLocale('cli/login.md', 'ru'),
306
+ ja: readLocale('cli/login.md', 'ja'),
307
+ fr: readLocale('cli/login.md', 'fr'),
308
+ ko: readLocale('cli/login.md', 'ko'),
309
+ zh: readLocale('cli/login.md', 'zh'),
310
+ es: readLocale('cli/login.md', 'es'),
311
+ de: readLocale('cli/login.md', 'de'),
312
+ ar: readLocale('cli/login.md', 'ar'),
313
+ it: readLocale('cli/login.md', 'it'),
314
+ 'en-GB': readLocale('cli/login.md', 'en-GB'),
315
+ pt: readLocale('cli/login.md', 'pt'),
316
+ hi: readLocale('cli/login.md', 'hi'),
317
+ tr: readLocale('cli/login.md', 'tr'),
318
+ pl: readLocale('cli/login.md', 'pl'),
319
+ id: readLocale('cli/login.md', 'id'),
320
+ vi: readLocale('cli/login.md', 'vi'),
321
+ } as unknown as Record<LocalesValues, Promise<string>>,
303
322
  './docs/en/cli/pull.md': {
304
323
  en: readLocale('cli/pull.md', 'en'),
305
324
  ru: readLocale('cli/pull.md', 'ru'),