@intlayer/docs 5.5.12 → 5.7.0

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 (241) hide show
  1. package/dist/cjs/common.cjs.map +1 -1
  2. package/dist/esm/common.mjs.map +1 -1
  3. package/dist/types/common.d.ts +2 -0
  4. package/dist/types/common.d.ts.map +1 -1
  5. package/docs/ar/configuration.md +23 -18
  6. package/docs/ar/how_works_intlayer.md +1 -1
  7. package/docs/ar/intlayer_CMS.md +1 -0
  8. package/docs/ar/intlayer_cli.md +292 -177
  9. package/docs/ar/intlayer_visual_editor.md +1 -0
  10. package/docs/ar/intlayer_with_angular.md +1 -0
  11. package/docs/ar/intlayer_with_create_react_app.md +1 -0
  12. package/docs/ar/intlayer_with_lynx+react.md +1 -0
  13. package/docs/ar/intlayer_with_nextjs_14.md +1 -0
  14. package/docs/ar/intlayer_with_nextjs_15.md +3 -1
  15. package/docs/ar/intlayer_with_nuxt.md +1 -0
  16. package/docs/ar/intlayer_with_react_native+expo.md +1 -0
  17. package/docs/ar/intlayer_with_vite+preact.md +4 -3
  18. package/docs/ar/intlayer_with_vite+react.md +8 -4
  19. package/docs/ar/intlayer_with_vite+solid.md +4 -3
  20. package/docs/ar/intlayer_with_vite+svelte.md +4 -3
  21. package/docs/ar/intlayer_with_vite+vue.md +5 -4
  22. package/docs/ar/mcp_server.md +126 -92
  23. package/docs/de/configuration.md +23 -18
  24. package/docs/de/how_works_intlayer.md +1 -1
  25. package/docs/de/intlayer_CMS.md +1 -0
  26. package/docs/de/intlayer_cli.md +291 -171
  27. package/docs/de/intlayer_visual_editor.md +1 -0
  28. package/docs/de/intlayer_with_angular.md +1 -0
  29. package/docs/de/intlayer_with_create_react_app.md +1 -0
  30. package/docs/de/intlayer_with_lynx+react.md +1 -0
  31. package/docs/de/intlayer_with_nextjs_14.md +1 -0
  32. package/docs/de/intlayer_with_nextjs_15.md +3 -1
  33. package/docs/de/intlayer_with_nuxt.md +1 -0
  34. package/docs/de/intlayer_with_react_native+expo.md +1 -0
  35. package/docs/de/intlayer_with_vite+preact.md +4 -3
  36. package/docs/de/intlayer_with_vite+react.md +7 -4
  37. package/docs/de/intlayer_with_vite+solid.md +4 -3
  38. package/docs/de/intlayer_with_vite+svelte.md +4 -3
  39. package/docs/de/intlayer_with_vite+vue.md +5 -4
  40. package/docs/de/mcp_server.md +116 -112
  41. package/docs/en/configuration.md +41 -25
  42. package/docs/en/how_works_intlayer.md +1 -1
  43. package/docs/en/intlayer_CMS.md +1 -0
  44. package/docs/en/intlayer_cli.md +246 -138
  45. package/docs/en/intlayer_visual_editor.md +1 -0
  46. package/docs/en/intlayer_with_angular.md +1 -0
  47. package/docs/en/intlayer_with_create_react_app.md +1 -0
  48. package/docs/en/intlayer_with_lynx+react.md +1 -0
  49. package/docs/en/intlayer_with_nextjs_14.md +1 -0
  50. package/docs/en/intlayer_with_nextjs_15.md +3 -1
  51. package/docs/en/intlayer_with_nuxt.md +1 -0
  52. package/docs/en/intlayer_with_react_native+expo.md +1 -0
  53. package/docs/en/intlayer_with_vite+preact.md +6 -3
  54. package/docs/en/intlayer_with_vite+react.md +9 -3
  55. package/docs/en/intlayer_with_vite+solid.md +4 -3
  56. package/docs/en/intlayer_with_vite+svelte.md +4 -3
  57. package/docs/en/intlayer_with_vite+vue.md +7 -4
  58. package/docs/en/mcp_server.md +100 -107
  59. package/docs/en-GB/configuration.md +23 -18
  60. package/docs/en-GB/how_works_intlayer.md +1 -1
  61. package/docs/en-GB/intlayer_CMS.md +1 -0
  62. package/docs/en-GB/intlayer_cli.md +257 -138
  63. package/docs/en-GB/intlayer_visual_editor.md +1 -0
  64. package/docs/en-GB/intlayer_with_angular.md +1 -0
  65. package/docs/en-GB/intlayer_with_create_react_app.md +1 -0
  66. package/docs/en-GB/intlayer_with_lynx+react.md +1 -0
  67. package/docs/en-GB/intlayer_with_nextjs_14.md +1 -0
  68. package/docs/en-GB/intlayer_with_nextjs_15.md +3 -1
  69. package/docs/en-GB/intlayer_with_nuxt.md +1 -0
  70. package/docs/en-GB/intlayer_with_react_native+expo.md +1 -0
  71. package/docs/en-GB/intlayer_with_vite+preact.md +4 -3
  72. package/docs/en-GB/intlayer_with_vite+react.md +7 -4
  73. package/docs/en-GB/intlayer_with_vite+solid.md +4 -3
  74. package/docs/en-GB/intlayer_with_vite+svelte.md +4 -3
  75. package/docs/en-GB/intlayer_with_vite+vue.md +5 -4
  76. package/docs/en-GB/mcp_server.md +116 -82
  77. package/docs/es/configuration.md +28 -19
  78. package/docs/es/how_works_intlayer.md +1 -1
  79. package/docs/es/intlayer_CMS.md +1 -0
  80. package/docs/es/intlayer_cli.md +283 -164
  81. package/docs/es/intlayer_visual_editor.md +1 -0
  82. package/docs/es/intlayer_with_angular.md +1 -0
  83. package/docs/es/intlayer_with_create_react_app.md +1 -0
  84. package/docs/es/intlayer_with_lynx+react.md +1 -0
  85. package/docs/es/intlayer_with_nextjs_14.md +1 -0
  86. package/docs/es/intlayer_with_nextjs_15.md +3 -1
  87. package/docs/es/intlayer_with_nuxt.md +1 -0
  88. package/docs/es/intlayer_with_react_native+expo.md +1 -0
  89. package/docs/es/intlayer_with_vite+preact.md +4 -3
  90. package/docs/es/intlayer_with_vite+react.md +7 -4
  91. package/docs/es/intlayer_with_vite+solid.md +4 -3
  92. package/docs/es/intlayer_with_vite+svelte.md +4 -3
  93. package/docs/es/intlayer_with_vite+vue.md +5 -4
  94. package/docs/es/mcp_server.md +120 -86
  95. package/docs/es/vs_code_extension.md +1 -0
  96. package/docs/fr/configuration.md +23 -13
  97. package/docs/fr/how_works_intlayer.md +1 -1
  98. package/docs/fr/intlayer_CMS.md +1 -0
  99. package/docs/fr/intlayer_cli.md +280 -184
  100. package/docs/fr/intlayer_visual_editor.md +1 -0
  101. package/docs/fr/intlayer_with_angular.md +1 -0
  102. package/docs/fr/intlayer_with_create_react_app.md +1 -0
  103. package/docs/fr/intlayer_with_lynx+react.md +1 -0
  104. package/docs/fr/intlayer_with_nextjs_14.md +1 -0
  105. package/docs/fr/intlayer_with_nextjs_15.md +3 -1
  106. package/docs/fr/intlayer_with_nuxt.md +1 -0
  107. package/docs/fr/intlayer_with_react_native+expo.md +1 -0
  108. package/docs/fr/intlayer_with_vite+preact.md +5 -4
  109. package/docs/fr/intlayer_with_vite+react.md +7 -4
  110. package/docs/fr/intlayer_with_vite+solid.md +4 -3
  111. package/docs/fr/intlayer_with_vite+svelte.md +4 -3
  112. package/docs/fr/intlayer_with_vite+vue.md +5 -4
  113. package/docs/fr/mcp_server.md +121 -87
  114. package/docs/hi/configuration.md +23 -18
  115. package/docs/hi/how_works_intlayer.md +1 -1
  116. package/docs/hi/intlayer_CMS.md +1 -0
  117. package/docs/hi/intlayer_cli.md +295 -174
  118. package/docs/hi/intlayer_visual_editor.md +1 -0
  119. package/docs/hi/intlayer_with_angular.md +1 -0
  120. package/docs/hi/intlayer_with_create_react_app.md +1 -0
  121. package/docs/hi/intlayer_with_lynx+react.md +1 -0
  122. package/docs/hi/intlayer_with_nextjs_14.md +1 -0
  123. package/docs/hi/intlayer_with_nextjs_15.md +3 -1
  124. package/docs/hi/intlayer_with_nuxt.md +1 -0
  125. package/docs/hi/intlayer_with_react_native+expo.md +1 -0
  126. package/docs/hi/intlayer_with_vite+preact.md +4 -3
  127. package/docs/hi/intlayer_with_vite+react.md +7 -4
  128. package/docs/hi/intlayer_with_vite+solid.md +4 -3
  129. package/docs/hi/intlayer_with_vite+svelte.md +4 -3
  130. package/docs/hi/intlayer_with_vite+vue.md +5 -4
  131. package/docs/hi/mcp_server.md +118 -84
  132. package/docs/it/configuration.md +23 -18
  133. package/docs/it/how_works_intlayer.md +1 -1
  134. package/docs/it/intlayer_CMS.md +1 -0
  135. package/docs/it/intlayer_cli.md +282 -167
  136. package/docs/it/intlayer_visual_editor.md +1 -0
  137. package/docs/it/intlayer_with_angular.md +1 -0
  138. package/docs/it/intlayer_with_create_react_app.md +1 -0
  139. package/docs/it/intlayer_with_lynx+react.md +1 -0
  140. package/docs/it/intlayer_with_nextjs_14.md +1 -0
  141. package/docs/it/intlayer_with_nextjs_15.md +3 -1
  142. package/docs/it/intlayer_with_nuxt.md +1 -0
  143. package/docs/it/intlayer_with_react_native+expo.md +1 -0
  144. package/docs/it/intlayer_with_vite+preact.md +4 -3
  145. package/docs/it/intlayer_with_vite+react.md +7 -4
  146. package/docs/it/intlayer_with_vite+solid.md +4 -3
  147. package/docs/it/intlayer_with_vite+svelte.md +4 -3
  148. package/docs/it/intlayer_with_vite+vue.md +4 -4
  149. package/docs/it/mcp_server.md +120 -86
  150. package/docs/ja/configuration.md +23 -18
  151. package/docs/ja/how_works_intlayer.md +1 -1
  152. package/docs/ja/intlayer_CMS.md +1 -0
  153. package/docs/ja/intlayer_cli.md +285 -168
  154. package/docs/ja/intlayer_visual_editor.md +1 -0
  155. package/docs/ja/intlayer_with_angular.md +1 -0
  156. package/docs/ja/intlayer_with_create_react_app.md +1 -0
  157. package/docs/ja/intlayer_with_lynx+react.md +1 -0
  158. package/docs/ja/intlayer_with_nextjs_14.md +1 -0
  159. package/docs/ja/intlayer_with_nextjs_15.md +3 -1
  160. package/docs/ja/intlayer_with_nuxt.md +1 -0
  161. package/docs/ja/intlayer_with_react_native+expo.md +1 -0
  162. package/docs/ja/intlayer_with_vite+preact.md +4 -3
  163. package/docs/ja/intlayer_with_vite+react.md +7 -4
  164. package/docs/ja/intlayer_with_vite+solid.md +4 -3
  165. package/docs/ja/intlayer_with_vite+svelte.md +4 -3
  166. package/docs/ja/intlayer_with_vite+vue.md +5 -4
  167. package/docs/ja/mcp_server.md +121 -85
  168. package/docs/ko/configuration.md +23 -18
  169. package/docs/ko/how_works_intlayer.md +1 -1
  170. package/docs/ko/intlayer_CMS.md +1 -0
  171. package/docs/ko/intlayer_cli.md +291 -175
  172. package/docs/ko/intlayer_visual_editor.md +1 -0
  173. package/docs/ko/intlayer_with_angular.md +1 -0
  174. package/docs/ko/intlayer_with_create_react_app.md +1 -0
  175. package/docs/ko/intlayer_with_lynx+react.md +1 -0
  176. package/docs/ko/intlayer_with_nextjs_14.md +1 -0
  177. package/docs/ko/intlayer_with_nextjs_15.md +3 -1
  178. package/docs/ko/intlayer_with_nuxt.md +1 -0
  179. package/docs/ko/intlayer_with_react_native+expo.md +1 -0
  180. package/docs/ko/intlayer_with_vite+preact.md +4 -3
  181. package/docs/ko/intlayer_with_vite+react.md +7 -4
  182. package/docs/ko/intlayer_with_vite+solid.md +4 -3
  183. package/docs/ko/intlayer_with_vite+svelte.md +4 -3
  184. package/docs/ko/intlayer_with_vite+vue.md +5 -4
  185. package/docs/ko/mcp_server.md +117 -83
  186. package/docs/pt/configuration.md +23 -18
  187. package/docs/pt/how_works_intlayer.md +1 -1
  188. package/docs/pt/intlayer_CMS.md +1 -0
  189. package/docs/pt/intlayer_cli.md +274 -154
  190. package/docs/pt/intlayer_visual_editor.md +1 -0
  191. package/docs/pt/intlayer_with_angular.md +1 -0
  192. package/docs/pt/intlayer_with_create_react_app.md +1 -0
  193. package/docs/pt/intlayer_with_lynx+react.md +1 -0
  194. package/docs/pt/intlayer_with_nextjs_14.md +1 -0
  195. package/docs/pt/intlayer_with_nextjs_15.md +3 -1
  196. package/docs/pt/intlayer_with_nuxt.md +1 -0
  197. package/docs/pt/intlayer_with_react_native+expo.md +1 -0
  198. package/docs/pt/intlayer_with_vite+preact.md +4 -3
  199. package/docs/pt/intlayer_with_vite+react.md +7 -4
  200. package/docs/pt/intlayer_with_vite+solid.md +4 -3
  201. package/docs/pt/intlayer_with_vite+svelte.md +4 -3
  202. package/docs/pt/intlayer_with_vite+vue.md +4 -4
  203. package/docs/pt/mcp_server.md +121 -87
  204. package/docs/ru/configuration.md +23 -18
  205. package/docs/ru/how_works_intlayer.md +1 -1
  206. package/docs/ru/intlayer_CMS.md +1 -0
  207. package/docs/ru/intlayer_cli.md +287 -170
  208. package/docs/ru/intlayer_visual_editor.md +1 -0
  209. package/docs/ru/intlayer_with_angular.md +1 -0
  210. package/docs/ru/intlayer_with_create_react_app.md +1 -0
  211. package/docs/ru/intlayer_with_lynx+react.md +1 -0
  212. package/docs/ru/intlayer_with_nextjs_14.md +1 -0
  213. package/docs/ru/intlayer_with_nextjs_15.md +3 -1
  214. package/docs/ru/intlayer_with_nuxt.md +1 -0
  215. package/docs/ru/intlayer_with_react_native+expo.md +1 -0
  216. package/docs/ru/intlayer_with_vite+preact.md +4 -3
  217. package/docs/ru/intlayer_with_vite+react.md +7 -4
  218. package/docs/ru/intlayer_with_vite+solid.md +4 -3
  219. package/docs/ru/intlayer_with_vite+svelte.md +4 -3
  220. package/docs/ru/intlayer_with_vite+vue.md +5 -4
  221. package/docs/ru/mcp_server.md +119 -85
  222. package/docs/zh/configuration.md +23 -18
  223. package/docs/zh/how_works_intlayer.md +1 -1
  224. package/docs/zh/intlayer_CMS.md +1 -0
  225. package/docs/zh/intlayer_cli.md +275 -155
  226. package/docs/zh/intlayer_visual_editor.md +1 -0
  227. package/docs/zh/intlayer_with_angular.md +1 -0
  228. package/docs/zh/intlayer_with_create_react_app.md +1 -0
  229. package/docs/zh/intlayer_with_lynx+react.md +1 -0
  230. package/docs/zh/intlayer_with_nextjs_14.md +1 -0
  231. package/docs/zh/intlayer_with_nextjs_15.md +3 -1
  232. package/docs/zh/intlayer_with_nuxt.md +1 -0
  233. package/docs/zh/intlayer_with_react_native+expo.md +1 -0
  234. package/docs/zh/intlayer_with_vite+preact.md +4 -3
  235. package/docs/zh/intlayer_with_vite+react.md +7 -4
  236. package/docs/zh/intlayer_with_vite+solid.md +4 -3
  237. package/docs/zh/intlayer_with_vite+svelte.md +4 -3
  238. package/docs/zh/intlayer_with_vite+vue.md +5 -4
  239. package/docs/zh/mcp_server.md +119 -86
  240. package/package.json +10 -10
  241. package/src/common.ts +2 -0
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  createdAt: 2024-08-11
3
- updatedAt: 2025-06-29
3
+ updatedAt: 2025-07-11
4
4
  title: CLI
5
- description: Intlayer CLIを使用して多言語ウェブサイトを管理する方法を紹介します。このオンラインドキュメントの手順に従い、数分でプロジェクトをセットアップしましょう。
5
+ description: Intlayer CLIを使用して多言語ウェブサイトを管理する方法をご紹介します。このオンラインドキュメントの手順に従って、数分でプロジェクトをセットアップしましょう。
6
6
  keywords:
7
7
  - CLI
8
8
  - コマンドラインインターフェース
9
9
  - 国際化
10
- - ドキュメント
10
+ - ドキュメンテーション
11
11
  - Intlayer
12
12
  - Next.js
13
13
  - JavaScript
@@ -22,7 +22,7 @@ slugs:
22
22
 
23
23
  ## パッケージのインストール
24
24
 
25
- npmを使用して必要なパッケージをインストールします:
25
+ npmを使って必要なパッケージをインストールします:
26
26
 
27
27
  ```bash packageManager="npm"
28
28
  npm install intlayer-cli -g
@@ -36,19 +36,19 @@ yarn add intlayer-cli -g
36
36
  pnpm add intlayer-cli -g
37
37
  ```
38
38
 
39
- > `intlayer`パッケージがすでにインストールされている場合、CLIは自動的にインストールされます。このステップはスキップできます。
39
+ > すでに`intlayer`パッケージがインストールされている場合、CLIは自動的にインストールされます。このステップはスキップできます。
40
40
 
41
- ## intlayer-cliパッケージ
41
+ ## intlayer-cli パッケージ
42
42
 
43
- `intlayer-cli`パッケージは、あなたの[intlayer宣言](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/get_started.md)を辞書にトランスパイルすることを目的としています。
43
+ `intlayer-cli` パッケージは、あなたの [intlayer 宣言](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/get_started.md) を辞書にトランスパイルすることを目的としています。
44
44
 
45
- このパッケージは、`src/**/*.content.{ts|js|mjs|cjs|json}`のようなすべてのintlayerファイルをトランスパイルします。[Intlayer宣言ファイルの宣言方法はこちら](https://github.com/aymericzip/intlayer/blob/main/packages/intlayer/README.md)をご覧ください。
45
+ このパッケージは、`src/**/*.content.{ts|js|mjs|cjs|json}` のようなすべての intlayer ファイルをトランスパイルします。[Intlayer 宣言ファイルの宣言方法はこちらをご覧ください](https://github.com/aymericzip/intlayer/blob/main/packages/intlayer/README.md)
46
46
 
47
- intlayer辞書を解釈するには、[react-intlayer](https://www.npmjs.com/package/react-intlayer)や[next-intlayer](https://www.npmjs.com/package/next-intlayer)のようなインタープリターを使用できます。
47
+ intlayer 辞書を解釈するには、[react-intlayer](https://www.npmjs.com/package/react-intlayer) [next-intlayer](https://www.npmjs.com/package/next-intlayer) のようなインタープリターを使用できます。
48
48
 
49
49
  ## 設定ファイルのサポート
50
50
 
51
- Intlayerは複数の設定ファイル形式をサポートしています:
51
+ Intlayer は複数の設定ファイル形式を受け入れます:
52
52
 
53
53
  - `intlayer.config.ts`
54
54
  - `intlayer.config.js`
@@ -59,49 +59,7 @@ Intlayerは複数の設定ファイル形式をサポートしています:
59
59
 
60
60
  利用可能なロケールやその他のパラメータの設定方法については、[こちらの設定ドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/configuration.md)を参照してください。
61
61
 
62
- ## CLI SDK
63
-
64
- CLI SDKは、Intlayer CLIを自身のコード内で使用できるライブラリです。
65
-
66
- ```bash packageManager="npm"
67
- npm install @intlayer/cli -D
68
- ```
69
-
70
- ```bash packageManager="yarn"
71
- yarn add @intlayer/cli -D
72
- ```
73
-
74
- ```bash packageManager="pnpm"
75
- pnpm add @intlayer/cli -D
76
- ```
77
-
78
- 使用例:
79
-
80
- ```ts
81
- import {
82
- push,
83
- pull,
84
- fill,
85
- build,
86
- docTranslate,
87
- docReview,
88
- } from "@intlayer/cli";
89
-
90
- push();
91
- // ...
92
- pull();
93
- // ...
94
- fill();
95
- // ...
96
- build();
97
- // ...
98
- docTranslate();
99
- // ...
100
- docReview();
101
- // ...
102
- ```
103
-
104
- ## intlayerコマンドの実行
62
+ ## intlayer コマンドの実行
105
63
 
106
64
  ### 辞書のビルド
107
65
 
@@ -117,9 +75,9 @@ npx intlayer build
117
75
  npx intlayer build --watch
118
76
  ```
119
77
 
120
- このコマンドはデフォルトで `./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx}` の宣言コンテンツファイルを探し、`.intlayer` ディレクトリに辞書をビルドします。
78
+ このコマンドは、デフォルトで `./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx}` の宣言コンテンツファイルを検出し、`.intlayer` ディレクトリに辞書をビルドします。
121
79
 
122
- ##### エイリアス:
80
+ ##### エイリアス:
123
81
 
124
82
  - `npx intlayer dictionaries build`
125
83
  - `npx intlayer dictionary build`
@@ -128,35 +86,71 @@ npx intlayer build --watch
128
86
  ### 辞書のプッシュ
129
87
 
130
88
  ```bash
89
+ bash
131
90
  npx intlayer dictionary push
132
91
  ```
133
92
 
134
- [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/intlayer_visual_editor.md) がインストールされている場合、辞書をエディターにプッシュすることもできます。このコマンドにより、辞書を[エディター](https://intlayer.org/dashboard)で利用可能にできます。これにより、チームと辞書を共有し、アプリケーションのコードを編集することなくコンテンツを編集できます。
93
+ [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md) がインストールされている場合、辞書をエディターにプッシュすることもできます。このコマンドにより、辞書を[エディター](https://intlayer.org/dashboard)で利用可能にできます。これにより、チームと辞書を共有し、アプリケーションのコードを編集することなくコンテンツを編集できます。
135
94
 
136
- ##### エイリアス:
95
+ ##### エイリアス:
137
96
 
138
97
  - `npx intlayer dictionaries push`
139
98
  - `npx intlayer dictionary push`
140
99
  - `npx intlayer dic push`
141
100
 
142
- ##### 引数:
101
+ ##### 引数:
102
+
103
+ **辞書オプション:**
104
+
105
+ - **`-d`, `--dictionaries`**: プッシュする辞書のID。指定しない場合はすべての辞書がプッシュされます。
143
106
 
144
- - `-d`, `--dictionaries`: プルする辞書のID。指定しない場合はすべての辞書がプッシュされます。
145
107
  > 例: `npx intlayer dictionary push -d my-dictionary-id my-other-dictionary-id`
146
- - `-r`, `--deleteLocaleDictionary`: 辞書をプッシュした後にロケールディレクトリを削除するかどうか尋ねる質問をスキップし、それらを削除します。デフォルトでは、辞書がローカルで定義されている場合、遠隔の辞書内容を上書きします。
108
+
109
+ **構成オプション:**
110
+
111
+ - **`--base-dir`**: プロジェクトのベースディレクトリを指定します。intlayerの設定を取得するために、このコマンドはベースディレクトリ内の `intlayer.config.{ts,js,json,cjs,mjs}` ファイルを探します。
112
+
113
+ > 例: `npx intlayer dictionary push --env-file .env.production.local`
114
+
115
+ **環境変数オプション:**
116
+
117
+ - **`--env`**: 環境を指定します(例: `development`、`production`)。intlayerの設定ファイルで環境変数を使用している場合に便利です。
118
+ - **`--env-file`**: 変数を読み込むためのカスタム環境ファイルを指定します。intlayerの設定ファイルで環境変数を使用している場合に便利です。
119
+
120
+ > 例: `npx intlayer dictionary push --env-file .env.production.local`
121
+
122
+ > 例: `npx intlayer dictionary push --env production`
123
+
124
+ **出力オプション:**
125
+
126
+ - **`-r`, `--delete-locale-dictionary`**: 辞書がプッシュされた後にロケールディレクトリを削除するか尋ねる質問をスキップし、ディレクトリを削除します。デフォルトでは、辞書がローカルに定義されている場合、遠隔の辞書内容を上書きします。
127
+
147
128
  > 例: `npx intlayer dictionary push -r`
148
- - `-k`, `--keepLocaleDictionary`: 辞書をプッシュした後にロケールディレクトリを削除するかどうか尋ねる質問をスキップし、それらを保持します。デフォルトでは、辞書がローカルで定義されている場合、遠隔の辞書内容を上書きします。
129
+
130
+ > 例: `npx intlayer dictionary push --delete-locale-dictionary`
131
+
132
+ - **`-k`, `--keep-locale-dictionary`**: 辞書がプッシュされた後にロケールディレクトリを削除するか尋ねる質問をスキップし、ディレクトリを保持します。デフォルトでは、辞書がローカルに定義されている場合、遠隔の辞書内容を上書きします。
133
+
149
134
  > 例: `npx intlayer dictionary push -k`
150
- - `--env`: 環境を指定します(例:`development`、`production`)。
151
- - `--env-file`: 変数を読み込むためのカスタム環境ファイルを指定します。
152
- - `--base-dir`: プロジェクトのベースディレクトリを指定します。
153
- - `--verbose`: デバッグのために詳細なログ出力を有効にします。
154
- - `--git-diff`: ベース(デフォルトは `origin/main`)から現在のブランチ(デフォルトは `HEAD`)への変更を含む辞書のみを対象に実行します。
155
- - `--git-diff-base`: git diff のベース参照を指定します(デフォルトは `origin/main`)。
156
- - `--git-diff-current`: git diff の現在の参照を指定します(デフォルトは `HEAD`)。
157
- - `--uncommitted`: コミットされていない変更を含めます。
158
- - `--unpushed`: プッシュされていない変更を含めます。
159
- - `--untracked`: トラッキングされていないファイルを含めます。
135
+
136
+ > 例: `npx intlayer dictionary push --keep-locale-dictionary`
137
+
138
+ **ログオプション:**
139
+
140
+ - **`--verbose`**: デバッグのために詳細なログを有効にします。
141
+
142
+ **Gitオプション:**
143
+
144
+ - **`--git-diff`**: ベース(デフォルトは `origin/main`)から現在のブランチ(デフォルトは `HEAD`)への変更を含む辞書のみを対象に実行します。
145
+ - **`--git-diff-base`**: git diff のベース参照を指定します(デフォルトは `origin/main`)。
146
+ - **`--git-diff-current`**: git diff の現在の参照を指定します(デフォルトは `HEAD`)。
147
+ - **`--uncommitted`**: コミットされていない変更を含めます。
148
+ - **`--unpushed`**: プッシュされていない変更を含めます。
149
+ - **`--untracked`**: トラッキングされていないファイルを含めます。
150
+
151
+ > 例: `npx intlayer dictionary push --git-diff --git-diff-base origin/main --git-diff-current HEAD`
152
+
153
+ > 例: `npx intlayer dictionary push --uncommitted --unpushed --untracked`
160
154
 
161
155
  ### 遠隔辞書のプル
162
156
 
@@ -164,7 +158,7 @@ npx intlayer dictionary push
164
158
  npx intlayer pull
165
159
  ```
166
160
 
167
- [intlayerエディター](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/intlayer_visual_editor.md)がインストールされている場合、エディターから辞書をプルすることもできます。これにより、アプリケーションのニーズに合わせて辞書の内容を上書きすることが可能です。
161
+ [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/intlayer_visual_editor.md) がインストールされている場合、エディターから辞書をプルすることもできます。これにより、アプリケーションのニーズに合わせて辞書の内容を上書きできます。
168
162
 
169
163
  ##### エイリアス:
170
164
 
@@ -174,13 +168,35 @@ npx intlayer pull
174
168
 
175
169
  ##### 引数:
176
170
 
177
- - `-d, --dictionaries`: プルする辞書のID。指定しない場合はすべての辞書がプルされます。
171
+ **辞書オプション:**
172
+
173
+ - **`-d, --dictionaries`**: プルする辞書のID。指定しない場合はすべての辞書がプルされます。
174
+
178
175
  > 例: `npx intlayer dictionary pull -d my-dictionary-id my-other-dictionary-id`
179
- - `--newDictionariesPath` : 新しい辞書が保存されるディレクトリのパス。指定しない場合、新しい辞書はプロジェクトの `./intlayer-dictionaries` ディレクトリに保存されます。辞書の内容に `filePath` フィールドが指定されている場合、この引数は無視され、指定された `filePath` ディレクトリに保存されます。
180
- - `--env`: 環境を指定します(例:`development`、`production`)。
181
- - `--env-file`: 変数を読み込むためのカスタム環境ファイルを指定します。
182
- - `--base-dir`: プロジェクトのベースディレクトリを指定します。
183
- - `--verbose`: 詳細なログ出力を有効にしてデバッグを支援します。
176
+
177
+ **設定オプション:**
178
+
179
+ - **`--base-dir`**: プロジェクトのベースディレクトリを指定します。intlayerの設定を取得するために、コマンドはベースディレクトリ内の `intlayer.config.{ts,js,json,cjs,mjs}` ファイルを探します。
180
+
181
+ > 例: `npx intlayer dictionary push --env-file .env.production.local`
182
+
183
+ **環境変数オプション:**
184
+
185
+ - **`--env`**: 環境を指定します(例:`development`、`production`)。
186
+ - **`--env-file`**: 変数を読み込むためのカスタム環境ファイルを指定します。
187
+ - **`--base-dir`**: プロジェクトのベースディレクトリを指定します。intlayerの設定を取得するために、コマンドはベースディレクトリ内の `intlayer.config.{ts,js,json,cjs,mjs}` ファイルを探します。
188
+
189
+ > 例: `npx intlayer dictionary push --env-file .env.production.local`
190
+
191
+ > 例: `npx intlayer dictionary push --env production`
192
+
193
+ **出力オプション:**
194
+
195
+ - **`--new-dictionaries-path`** : 新しい辞書が保存されるディレクトリのパス。指定しない場合、新しい辞書はプロジェクトの `./intlayer-dictionaries` ディレクトリに保存されます。辞書コンテンツ内に `filePath` フィールドが指定されている場合、この引数は無視され、指定された `filePath` ディレクトリに保存されます。
196
+
197
+ **ログオプション:**
198
+
199
+ - **`--verbose`**: デバッグ用の詳細なログ出力を有効にします。
184
200
 
185
201
  ##### 例:
186
202
 
@@ -191,11 +207,10 @@ npx intlayer dictionary pull --newDictionariesPath ./my-dictionaries-dir/
191
207
  ### 辞書の補完 / 監査 / 翻訳
192
208
 
193
209
  ```bash
194
- bash
195
210
  npx intlayer fill
196
211
  ```
197
212
 
198
- このコマンドは、翻訳の欠落、構造の不整合、型の不一致などの潜在的な問題について、コンテンツ宣言ファイルを解析します。問題が見つかった場合、**intlayer fill** は辞書を一貫性があり完全な状態に保つために、更新の提案または適用を行います。
213
+ このコマンドは、翻訳の欠落、構造の不整合、型の不一致などの潜在的な問題について、コンテンツ宣言ファイルを解析します。問題が見つかった場合、**intlayer fill** は辞書を一貫性があり完全な状態に保つための更新を提案または適用します。
199
214
 
200
215
  ##### エイリアス:
201
216
 
@@ -205,92 +220,89 @@ npx intlayer fill
205
220
 
206
221
  ##### 引数:
207
222
 
208
- - `-f, --file [files...]`
209
- 監査する特定のコンテンツ宣言ファイルのリスト。指定しない場合は、発見されたすべての `*.content.{ts,js,mjs,cjs,tsx,jsx,json}` ファイルが監査されます。
223
+ **ファイルリストオプション:**
210
224
 
211
- - `--exclude [excludedGlobs...]`
212
- 監査から除外するグロブパターン(例: `--exclude "src/test/**"`)。
225
+ - **`-f, --file [files...]`**: 監査する特定のコンテンツ宣言ファイルのリスト。指定しない場合は、設定ファイルに基づいて検出されたすべての `*.content.{ts,js,mjs,cjs,tsx,jsx,json}` ファイルが監査されます。
213
226
 
214
- - `--source-locale [sourceLocale]`
215
- 翻訳元のソースロケール。指定しない場合は、設定のデフォルトロケールが使用されます。
227
+ > 例: `npx intlayer dictionary fill -f src/home/app.content.ts`
216
228
 
217
- - `--output-locales [outputLocales...]`
218
- 翻訳対象のロケール。指定しない場合は、設定のすべてのロケールがソースロケールを除いて使用されます。
229
+ - **`-k, --keys [keys...]`**: キーに基づいて辞書をフィルタリングします。指定しない場合は、すべての辞書が監査されます。
219
230
 
220
- - `--mode [mode]`
221
- 翻訳モード:'complete'(完全)、'review'(レビュー)、または 'missing-only'(不足分のみ)。デフォルトは 'missing-only' です。
231
+ > 例: `npx intlayer dictionary fill -k key1 key2`
222
232
 
223
- - `--git-diff`
224
- ベース(デフォルトは `origin/main`)から現在のブランチ(デフォルトは `HEAD`)までの変更を含む辞書をフィルタリングします。
233
+ - **`--excluded-keys [excludedKeys...]`**: キーに基づいて辞書を除外します。指定しない場合は、すべての辞書が監査されます。
225
234
 
226
- - `--git-diff-base`
227
- git diff のベース参照を指定します(デフォルトは `origin/main`)。
235
+ > 例: `npx intlayer dictionary fill --excluded-keys key1 key2`
228
236
 
229
- - `--git-diff-current`
230
- git diff の現在の参照を指定します(デフォルトは `HEAD`)。
237
+ - **`--path-filter [pathFilters...]`**: ファイルパスのグロブパターンに基づいて辞書をフィルタリングします。
231
238
 
232
- - `--uncommitted`
233
- コミットされていない変更を含む辞書をフィルタリングします。
239
+ > 例: `npx intlayer dictionary fill --path-filter "src/home/**"`
234
240
 
235
- - `--unpushed`
236
- - `--unpushed`
237
- プッシュされていない変更を含む辞書をフィルタリングします。
241
+ **エントリ出力オプション:**
238
242
 
239
- - `--untracked`
240
- トラッキングされていないファイルを含む辞書をフィルタリングします。
243
+ - **`--source-locale [sourceLocale]`**: 翻訳元のソースロケール。指定しない場合は、設定ファイルのデフォルトロケールが使用されます。
241
244
 
242
- - `--keys [keys...]`
243
- 指定されたキーに基づいて辞書をフィルタリングします。
245
+ - **`--output-locales [outputLocales...]`**: 翻訳対象のロケール。指定しない場合は、設定にあるすべてのロケールが使用され、ソースロケールは除外されます。
244
246
 
245
- - `--excluded-keys [excludedKeys...]`
246
- 指定されたキーに基づいて辞書を除外します。
247
+ - **`--mode [mode]`**: 翻訳モード:'complete'(完全)、'review'(レビュー)、または 'missing-only'(不足分のみ)。デフォルトは 'missing-only' です。
247
248
 
248
- - `--path-filter [pathFilters...]`
249
- ファイルパスのグロブパターンに基づいて辞書をフィルタリングします。
249
+ **Gitオプション:**
250
250
 
251
- - `--model [model]`
252
- 翻訳に使用するAIモデル(例:`gpt-3.5-turbo`)を指定します。
251
+ - **`--git-diff`**: ベース(デフォルトは `origin/main`)から現在のブランチ(デフォルトは `HEAD`)までの変更を含む辞書のみで実行します。
252
+ - **`--git-diff-base`**: git diff のベース参照を指定します(デフォルトは `origin/main`)。
253
+ - **`--git-diff-current`**: git diff の現在の参照を指定します(デフォルトは `HEAD`)。
254
+ - **`--uncommitted`**: コミットされていない変更を含めます。
255
+ - **`--unpushed`**: プッシュされていない変更を含めます。
256
+ - **`--untracked`**: トラッキングされていないファイルを含めます。
253
257
 
254
- - `--provider [provider]`
255
- 翻訳に使用するAIプロバイダーを指定します。
258
+ > 例: `npx intlayer doc translate --git-diff --git-diff-base origin/main --git-diff-current HEAD`
256
259
 
257
- - `--temperature [temperature]`
258
- AIモデルの温度設定を指定します。
260
+ > 例: `npx intlayer doc translate --uncommitted --unpushed --untracked`
259
261
 
260
- - `--api-key [apiKey]`
261
- AIサービス用の独自のAPIキーを提供します。
262
+ **AIオプション:**
262
263
 
263
- - `--custom-prompt [prompt]`
264
- 翻訳指示のためのカスタムプロンプトを提供します。
264
+ - **`--model [model]`**: 翻訳に使用するAIモデル(例: `gpt-3.5-turbo`)。
265
+ - **`--provider [provider]`**: 翻訳に使用するAIプロバイダー。
266
+ - **`--temperature [temperature]`**: AIモデルの温度設定。
267
+ - **`--api-key [apiKey]`**: AIサービス用の独自APIキーを提供。
268
+ - **`--custom-prompt [prompt]`**: 翻訳指示用のカスタムプロンプトを提供。
269
+ - **`--application-context [applicationContext]`**: AI翻訳に追加のコンテキストを提供。
270
+
271
+ > 例: `npx intlayer fill --model gpt-3.5-turbo --provider openai --temperature 0.5 --api-key sk-1234567890 --application-context "My application is a cat store"`
265
272
 
266
- - `--application-context [applicationContext]`
267
- AI翻訳のための追加コンテキストを提供します。
273
+ **環境変数オプション:**
268
274
 
269
- - `--env`
270
- 環境を指定します(例:`development`、`production`)。
275
+ - **`--env`**: 環境を指定します(例: `development`, `production`)。
276
+ - **`--env-file [envFile]`**: 変数を読み込むためのカスタム環境ファイルを指定します。
271
277
 
272
- - `--env-file [envFile]`
273
- 変数を読み込むためのカスタム環境ファイルを指定します。
278
+ > 例: `npx intlayer fill --env-file .env.production.local`
274
279
 
275
- - `--base-dir`
276
- プロジェクトのベースディレクトリを指定します。
280
+ > 例: `npx intlayer fill --env production`
277
281
 
278
- - `--verbose`
279
- 詳細なログ出力を有効にしてデバッグを行います。
282
+ **設定オプション:**
283
+
284
+ - **`--base-dir`**: プロジェクトのベースディレクトリを指定します。
285
+
286
+ > 例: `npx intlayer fill --base-dir ./src`
287
+
288
+ **ログオプション:**
289
+
290
+ - **`--verbose`**: デバッグ用の詳細ログを有効にします。
280
291
 
281
292
  ##### 例:
282
293
 
283
294
  ```bash
295
+ bash
284
296
  npx intlayer fill --file src/home/*.content.ts --source-locale en --output-locales fr es --model gpt-3.5-turbo
285
297
  ```
286
298
 
287
- このコマンドは、`src/home/`ディレクトリ内のすべてのコンテンツ宣言ファイルの内容を英語からフランス語とスペイン語に、GPT-3.5 Turboモデルを使用して翻訳します。
299
+ このコマンドは、`src/home/` ディレクトリ内のすべてのコンテンツ宣言ファイルに対して、GPT-3.5 Turboモデルを使用して英語からフランス語およびスペイン語への翻訳を行います。
288
300
 
289
301
  ### 設定の管理
290
302
 
291
303
  #### 設定の取得
292
304
 
293
- `configuration get` コマンドは、Intlayer の現在の設定、特にロケール設定を取得します。これはセットアップの確認に役立ちます。
305
+ `configuration get` コマンドは、Intlayerの現在の設定、特にロケール設定を取得します。セットアップの確認に便利です。
294
306
 
295
307
  ```bash
296
308
  npx intlayer configuration get
@@ -306,14 +318,13 @@ npx intlayer configuration get
306
318
  - **`--env`**: 環境を指定します(例:`development`、`production`)。
307
319
  - **`--env-file`**: 変数を読み込むためのカスタム環境ファイルを指定します。
308
320
  - **`--base-dir`**: プロジェクトのベースディレクトリを指定します。
309
- - **`--verbose`**: 詳細なログ出力を有効にしてデバッグを行います。
321
+ - **`--verbose`**: デバッグ用に詳細なログ出力を有効にします。
310
322
 
311
323
  #### 設定のプッシュ
312
324
 
313
- `configuration push` コマンドは、設定を Intlayer CMS とエディターにアップロードします。このステップは、Intlayer ビジュアルエディターで遠隔辞書を使用可能にするために必要です。
325
+ `configuration push` コマンドは、設定を Intlayer CMS とエディターにアップロードします。このステップは、Intlayer ビジュアルエディターでリモート辞書を使用可能にするために必要です。
314
326
 
315
327
  ```bash
316
- bash
317
328
  npx intlayer configuration push
318
329
  ```
319
330
 
@@ -324,10 +335,10 @@ npx intlayer configuration push
324
335
 
325
336
  ##### 引数:
326
337
 
327
- - **`--env`**: 環境を指定します(例: `development`, `production`)。
338
+ - **`--env`**: 環境を指定します(例:`development`、`production`)。
328
339
  - **`--env-file`**: 変数を読み込むためのカスタム環境ファイルを指定します。
329
340
  - **`--base-dir`**: プロジェクトのベースディレクトリを指定します。
330
- - **`--verbose`**: 詳細なログ出力を有効にしてデバッグします。
341
+ - **`--verbose`**: デバッグ用に詳細なログ出力を有効にします。
331
342
 
332
343
  設定をプッシュすることで、プロジェクトはIntlayer CMSと完全に統合され、チーム間での辞書管理がシームレスに行えるようになります。
333
344
 
@@ -345,69 +356,130 @@ npx intlayer doc translate
345
356
 
346
357
  ##### 引数:
347
358
 
348
- - **`--doc-pattern [docPattern...]`**: 翻訳するドキュメントファイルをマッチさせるグロブパターン。
359
+ **ファイルリストオプション:**
360
+
361
+ - **`--doc-pattern [docPattern...]`**: 翻訳対象のドキュメントファイルにマッチするグロブパターン。
362
+
349
363
  > 例: `npx intlayer doc translate --doc-pattern "docs/**/*.md" "src/**/*.mdx"`
350
- - **`--excluded-glob-pattern [excludedGlobPattern...]`**: 翻訳から除外するグロブパターン。
364
+
365
+ - **`--excluded-glob-pattern [excludedGlobPattern...]`**: 翻訳から除外するためのグロブパターン。
366
+
351
367
  > 例: `npx intlayer doc translate --excluded-glob-pattern "docs/internal/**"`
352
- - **`--nb-simultaneous-file-processed [nbSimultaneousFileProcessed]`**: 同時に翻訳処理するファイル数。
353
- > 例: `npx intlayer doc translate --nb-simultaneous-file-processed 5`
368
+
369
+ - **`--skip-if-modified-before [skipIfModifiedBefore]`**: 指定した日時より前に変更されたファイルをスキップします。
370
+
371
+ - "2025-12-05" のような絶対日時(文字列またはDateオブジェクト)を指定可能
372
+ - `1 * 60 * 60 * 1000`(1時間)のような相対時間(ミリ秒)も指定可能
373
+ - このオプションは `fs.stat` メソッドを使用してファイルの更新日時をチェックします。そのため、Gitやその他のツールによるファイルの変更に影響を受ける可能性があります。
374
+
375
+ > 例: `npx intlayer doc translate --skip-if-modified-before "2025-12-05"`
376
+
377
+ - **`--skip-if-modified-after [skipIfModifiedAfter]`**: 指定した日時以降に変更されたファイルをスキップします。
378
+
379
+ - 絶対時間として "2025-12-05"(文字列またはDateオブジェクト)を指定可能
380
+ - ミリ秒単位の相対時間として `1 * 60 * 60 * 1000`(1時間)を指定可能
381
+ - このオプションは `fs.stat` メソッドを使ってファイルの更新時間をチェックします。そのため、Gitやその他のファイルを変更するツールの影響を受ける可能性があります。
382
+
383
+ > 例: `npx intlayer doc translate --skip-if-modified-after "2025-12-05"`
384
+
385
+ **出力オプション:**
386
+
354
387
  - **`--locales [locales...]`**: ドキュメントを翻訳する対象のロケール。
388
+
355
389
  > 例: `npx intlayer doc translate --locales fr es de`
390
+
356
391
  - **`--base-locale [baseLocale]`**: 翻訳元のソースロケール。
392
+
357
393
  > 例: `npx intlayer doc translate --base-locale en`
394
+
395
+ **ファイル処理オプション:**
396
+
397
+ - **`--nb-simultaneous-file-processed [nbSimultaneousFileProcessed]`**: 同時に翻訳処理するファイル数。
398
+
399
+ > 例: `npx intlayer doc translate --nb-simultaneous-file-processed 5`
400
+
401
+ **AIオプション:**
402
+
358
403
  - **`--model [model]`**: 翻訳に使用するAIモデル(例: `gpt-3.5-turbo`)。
359
404
  - **`--provider [provider]`**: 翻訳に使用するAIプロバイダー。
360
405
  - **`--temperature [temperature]`**: AIモデルの温度設定。
361
406
  - **`--api-key [apiKey]`**: AIサービス用のAPIキーを提供。
362
- - **`--custom-prompt [prompt]`**: 翻訳指示用のカスタムプロンプトを提供。
363
407
  - **`--application-context [applicationContext]`**: AI翻訳に追加のコンテキストを提供。
408
+ - **`--custom-prompt [prompt]`**: 翻訳に使用する基本プロンプトをカスタマイズします。(注:ほとんどのユースケースでは、翻訳の挙動をより良く制御できるため、`--custom-instructions` オプションの使用が推奨されます。)
409
+
410
+ > 例: `npx intlayer doc translate --model deepseek-chat --provider deepseek --temperature 0.5 --api-key sk-1234567890 --application-context "My application is a cat store"`
411
+
412
+ **環境変数オプション:**
413
+
364
414
  - **`--env`**: 環境を指定します(例:`development`、`production`)。
365
415
  - **`--env-file [envFile]`**: 変数を読み込むためのカスタム環境ファイルを指定します。
366
416
  - **`--base-dir`**: プロジェクトのベースディレクトリを指定します。
367
- - **`--verbose`**: デバッグのために詳細なログ出力を有効にします。
368
- - **`--custom-instructions [customInstructions]`**: プロンプトに追加するカスタム指示。フォーマットやURL翻訳など特定のルールを適用する際に便利です。
369
417
 
370
- ##### 例:
418
+ > 例: `npx intlayer doc translate --base-dir ./docs --env-file .env.production.local`
371
419
 
372
- ```bash
373
- npx intlayer doc translate
374
- --doc-pattern "docs/en/**/*.md"
375
- --base-locale en --locales fr es
376
- --model chatgpt-4o-latest
377
- --custom-instructions "$(cat ./instructions.md)"
378
- ```
420
+ **ログオプション:**
421
+
422
+ - **`--verbose`**: デバッグのために詳細なログを有効にします。
423
+
424
+ > 例: `npx intlayer doc translate --verbose`
425
+
426
+ **カスタム指示オプション:**
427
+
428
+ - **`--custom-instructions [customInstructions]`**: プロンプトに追加されるカスタム指示。フォーマットやURLの翻訳など、特定のルールを適用するのに便利です。
429
+
430
+ - 絶対時間として "2025-12-05"(文字列またはDate型)を指定可能
431
+ - ミリ秒単位の相対時間として `1 * 60 * 60 * 1000`(1時間)を指定可能
432
+ - このオプションは `fs.stat` メソッドを使ってファイルの更新時間をチェックします。そのため、Gitやその他のツールによるファイルの変更に影響を受ける可能性があります。
433
+
434
+ > 例: `npx intlayer doc translate --custom-instructions "Avoid translating urls, and keep the markdown format"`
435
+
436
+ > 例: `npx intlayer doc translate --custom-instructions "$(cat ./instructions.md)"`
437
+
438
+ **Gitオプション:**
439
+
440
+ - **`--git-diff`**: ベース(デフォルトは `origin/main`)から現在のブランチ(デフォルトは `HEAD`)への変更を含む辞書のみで実行します。
441
+ - **`--git-diff-base`**: git diffのベース参照を指定します(デフォルトは `origin/main`)。
442
+ - **`--git-diff-current`**: git diffの現在の参照を指定します(デフォルトは `HEAD`)。
443
+ - **`--uncommitted`**: コミットされていない変更を含めます。
444
+ - **`--unpushed`**: プッシュされていない変更を含めます。
445
+ - **`--untracked`**: トラッキングされていないファイルを含めます。
446
+
447
+ > 例: `npx intlayer doc translate --git-diff --git-diff-base origin/main --git-diff-current HEAD`
448
+
449
+ > 例: `npx intlayer doc translate --uncommitted --unpushed --untracked`
379
450
 
380
- > 出力ファイルのパスは以下のパターンを置換して決定されます
451
+ > 出力ファイルのパスは以下のパターンを置換することで決定されることに注意してください
381
452
  >
382
- > - `/{{baseLocale}}/` を `/{{locale}}/` に置換(Unix)
453
+ > - `/{{baseLocale}}/` を `/{{locale}}/` に置き換えます(Unix)
383
454
  > - `\{{baseLocale}}\` を `\{{locale}}\` に置き換えます(Windows)
384
455
  > - `_{{baseLocale}}.` を `_{{locale}}.` に置き換えます
385
456
  > - `{{baseLocale}}_` を `{{locale}}_` に置き換えます
386
457
  > - `.{{baseLocaleName}}.` を `.{{localeName}}.` に置き換えます
387
458
  >
388
- > パターンが見つからない場合、出力ファイルの拡張子に `.{{locale}}` が追加されます。例えば、`./my/file.md` はフランス語ロケールの場合 `./my/file.fr.md` に翻訳されます。
459
+ > パターンが見つからない場合、出力ファイルの拡張子に `.{{locale}}` が追加されます。例えば `./my/file.md` はフランス語ロケールの場合 `./my/file.fr.md` に翻訳されます。
389
460
 
390
461
  #### ドキュメントのレビュー
391
462
 
392
- `doc review` コマンドは、異なるロケール間でのドキュメントファイルの品質、一貫性、完全性を分析します。
463
+ `doc review` コマンドは、異なるロケール間でドキュメントファイルの品質、一貫性、完全性を分析します。
393
464
 
394
465
  ```bash
395
466
  npx intlayer doc review
396
467
  ```
397
468
 
398
- ##### 引数:
469
+ このコマンドは、すでに翻訳されたファイルをレビューしたり、翻訳が正しいかどうかを確認するために使用できます。
399
470
 
400
- `doc review` コマンドは `doc translate` と同じ引数を受け付け、特定のドキュメントファイルをレビューし、品質チェックを適用できます。
471
+ ほとんどのユースケースでは、
401
472
 
402
- ##### 例:
473
+ - このファイルの翻訳版がまだ存在しない場合は、`doc translate` の使用を推奨します。
474
+ - このファイルの翻訳版が既に存在する場合は、`doc review` の使用を推奨します。
403
475
 
404
- ```bash
405
- npx intlayer doc review
406
- --doc-pattern "docs/ja/**/*.md"
407
- --locales fr es de
408
- --model chatgpt-4o-latest
409
- --custom-instructions "$(cat ./instructions.md)"
410
- ```
476
+ > レビュープロセスは、同じファイルを完全にレビューする際に翻訳プロセスよりも多くのエントリトークンを消費します。ただし、レビュープロセスはレビューするチャンクを最適化し、変更されていない部分はスキップします。
477
+
478
+ ##### 引数:
479
+
480
+ `doc review` コマンドは `doc translate` と同じ引数を受け付け、特定のドキュメントファイルをレビューし品質チェックを適用することができます。
481
+
482
+ Gitオプションのいずれかを有効にした場合、コマンドは変更されたファイルの部分のみをレビューします。スクリプトはファイルをチャンクに分割して各チャンクをレビューします。チャンクに変更がない場合、スクリプトはそれをスキップしてレビュー処理を高速化し、AIプロバイダーのAPIコストを抑制します。
411
483
 
412
484
  ## `package.json`でintlayerコマンドを使用する
413
485
 
@@ -423,15 +495,57 @@ npx intlayer doc review
423
495
  }
424
496
  ```
425
497
 
498
+ ## CLI SDK
499
+
500
+ CLI SDKは、Intlayer CLIを自分のコード内で使用できるようにするライブラリです。
501
+
502
+ ```bash packageManager="npm"
503
+ npm install @intlayer/cli --save-dev
504
+ ```
505
+
506
+ ```bash packageManager="yarn"
507
+ yarn add @intlayer/cli --save-dev
508
+ ```
509
+
510
+ ```bash packageManager="pnpm"
511
+ pnpm add @intlayer/cli --save-dev
512
+ ```
513
+
514
+ 使用例:
515
+
516
+ ```ts
517
+ import {
518
+ push,
519
+ pull,
520
+ fill,
521
+ build,
522
+ docTranslate,
523
+ docReview,
524
+ } from "@intlayer/cli";
525
+
526
+ push();
527
+ // ...
528
+ pull();
529
+ // ...
530
+ fill();
531
+ // ...
532
+ build();
533
+ // ...
534
+ docTranslate();
535
+ // ...
536
+ docReview();
537
+ // ...
538
+ ```
539
+
426
540
  ## intlayerコマンドのデバッグ
427
541
 
428
542
  ### 1. **最新バージョンを使用していることを確認する**
429
543
 
430
- 以下を実行してください:
544
+ 以下を実行してください:
431
545
 
432
546
  ```bash
433
547
  npx intlayer --version # 現在のローカルのintlayerバージョン
434
- npx intlayer@latest --version # 最新のintlayerバージョン
548
+ npx intlayer@latest --version # 現在の最新intlayerバージョン
435
549
  ```
436
550
 
437
551
  ### 2. **コマンドが登録されているか確認する**
@@ -455,4 +569,7 @@ npx clear-npx-cache
455
569
 
456
570
  ## ドキュメント履歴
457
571
 
458
- - 5.5.10 - 2025-06-29: 履歴の初期化
572
+ | バージョン | 日付 | 変更内容 |
573
+ | ---------- | ---------- | ----------------------------------------- |
574
+ | 5.5.11 | 2025-07-11 | CLIコマンドパラメータのドキュメントを更新 |
575
+ | 5.5.10 | 2025-06-29 | 履歴を初期化 |