@intlayer/docs 5.5.12 → 5.7.0

package/docs/en/configuration.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2024-08-13
-updatedAt: 2025-06-29
+updatedAt: 2025-07-25
 title: Configuration
 description: Learn how to configure Intlayer for your application. Understand the various settings and options available to customize Intlayer to your needs.
 keywords:
@@ -59,7 +59,7 @@ const config: IntlayerConfig = {
     applicationContext: "This is a test application",
   },
   build: {
-    activateDynamicImport: true,
+    importMode: "dynamic",
   },
 };
 
@@ -88,7 +88,7 @@ const config = {
     applicationContext: "This is a test application",
   },
   build: {
-    activateDynamicImport: true,
+    importMode: "dynamic",
   },
 };
 
@@ -101,11 +101,21 @@ module.exports = config;
     "locales": ["en"],
   },
   "content": {
-    "typesDir": "content/types",
+    "contentDir": ["src", "../ui-library"],
   },
   "middleware": {
     "noPrefix": false,
   },
+  "editor": {
+    "applicationURL": "https://example.com",
+  },
+  "ai": {
+    "apiKey": "XXXX",
+    "applicationContext": "This is a test application",
+  },
+  "build": {
+    "importMode": "dynamic",
+  },
 }
 ```
 
@@ -336,7 +346,7 @@ Settings related to content handling within the application, including directory
 - **contentDir**:
 
   - _Type_: `string[]`
-  - _Default_: `['src']`
+  - _Default_: `['.']`
   - _Example_: `['src', '../../ui-library', require.resolve("@my-package/content")]`
   - _Description_: The directory path where content is stored.
 
@@ -483,11 +493,9 @@ Settings that control how Intlayer optimizes and builds your application's inter
 
 Build options apply to the `@intlayer/babel` and `@intlayer/swc` plugins.
 
-> In development mode, Intlayer use a centralized static import for dictionaries to simplify the development experience.
+> In development mode, Intlayer uses static imports for dictionaries to simplify the development experience.
 
-> By optimizing the build, Intlayer will replace all calls of dictionaries to optimize chunking. That way the final bundle will import only the dictionaries that are used.
-
-- **Note**: `@intlayer/babel` is available by default on `vite-intlayer` package, but `@intlayer/swc` is not installed by default on `next-intlayer` package as SWC plugins are still experimental on Next.js.
+> When optimized, Intlayer will replace dictionary calls to optimize chunking, so the final bundle only imports dictionaries that are actually used.
 
 #### Properties
 
@@ -497,21 +505,28 @@ Build options apply to the `@intlayer/babel` and `@intlayer/swc` plugins.
   - _Default_: `process.env.NODE_ENV === 'production'`
   - _Description_: Controls whether the build should be optimized.
   - _Example_: `true`
-  - _Note_: It will allows to import only the dictionaries that are used into the bundle. But all imports will stay as static import to avoid async processing when loading the dictionaries.
-  - _Note_: When enabled, Intlayer will optimize dictionary chunking by replacing all calls of `useIntlayer` with `useDictionary` and `getIntlayer` with `getDictionary`.
+  - _Note_: When enabled, Intlayer will replace all calls of dictionaries to optimize chunking. That way the final bundle will import only the dictionaries that are used. All imports will stay as static import to avoid async processing when loading the dictionaries.
+  - _Note_: Intlayer will replace all calls of `useIntlayer` with the defined mode by the `importMode` option and `getIntlayer` with `getDictionary`.
+  - _Note_: This option relies on the `@intlayer/babel` and `@intlayer/swc` plugins.
   - _Note_: Ensure all keys are declared statically in the `useIntlayer` calls. e.g. `useIntlayer('navbar')`.
 
-- **activateDynamicImport**:
-
-  - _Type_: `boolean`
-  - _Default_: `false`
-  - _Description_: Controls whether dictionary content should be dynamically imported per locale.
-  - _Example_: `true`
-  - _Note_: It will allows to import dynamically the dictionary content for the current locale only.
-  - _Note_: Dynamic imports rely on React Suspense and may slightly impact rendering performance. But if desabled all locales will be loaded at once, even if they are not used.
-  - _Note_: When enabled, Intlayer will optimize dictionary chunking by replacing all calls of `useIntlayer` calls with `useDynamicDictionary`.
-  - _Note_: This option will be ignored if `optimize` is disabled.
+- **importMode**:
+
+  - _Type_: `'static' | 'dynamic' | 'async'`
+  - _Default_: `'static'`
+  - _Description_: Controls how dictionaries are imported.
+  - _Example_: `'dynamic'`
+  - _Note_: Available modes:
+    - "static": Dictionaries are imported statically. Replaces `useIntlayer` with `useDictionary`.
+    - "dynamic": Dictionaries are imported dynamically using Suspense. Replaces `useIntlayer` with `useDictionaryDynamic`.
+    - "async": Dictionaries are imported dynamically asynchronously. Replaces `useIntlayer` with `await useDictionaryAsync`.
+  - _Note_: Dynamic imports rely on Suspense and may slightly impact rendering performance.
+  - _Note_: If disabled all locales will be loaded at once, even if they are not used.
+  - _Note_: This option relies on the `@intlayer/babel` and `@intlayer/swc` plugins.
   - _Note_: Ensure all keys are declared statically in the `useIntlayer` calls. e.g. `useIntlayer('navbar')`.
+  - _Note_: This option will be ignored if `optimize` is disabled.
+  - _Note_: In most cases, `"dynamic"` will be used for React applications, `"async"` for Vue.js applications.
+  - _Note_: This option will not impact the `getIntlayer`, `getDictionary`, `useDictionary`, `useDictionaryAsync` and `useDictionaryDynamic` functions.
 
 - **traversePattern**:
   - _Type_: `string[]`
@@ -524,7 +539,8 @@ Build options apply to the `@intlayer/babel` and `@intlayer/swc` plugins.
 
 ## Doc History
 
-| Version | Date       | Changes             |
-| ------- | ---------- | ------------------- |
-| 5.5.11  | 2025-06-29 | Add `docs` commands |
-| 5.5.10  | 2025-06-29 | Init history        |
+| Version | Date       | Changes                                                  |
+| ------- | ---------- | -------------------------------------------------------- |
+| 5.6.1   | 2025-07-25 | Replace `activateDynamicImport` with `importMode` option |
+| 5.6.0   | 2025-07-13 | Change default contentDir from `['src']` to `['.']`      |
+| 5.5.11  | 2025-06-29 | Add `docs` commands                                      |

package/docs/en/how_works_intlayer.md

@@ -106,7 +106,7 @@ The Babel and SWC plugins work by analyzing your application's Abstract Syntax T
 
 In development mode, Intlayer uses a centralized static import for dictionaries to simplify the development experience.
 
-By activating the option `activateDynamicImport` in the [configuration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md), Intlayer will use the dynamic import to load the dictionaries. This option is disabled by default to avoid async processing when rendering the application.
+By activating the option `importMode = "dynamic"` in the [configuration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md), Intlayer will use the dynamic import to load the dictionaries. This option is disabled by default to avoid async processing when rendering the application.
 
 > `@intlayer/babel` is available by default on `vite-intlayer` package,
 

package/docs/en/intlayer_CMS.md

@@ -16,6 +16,7 @@ slugs:
   - doc
   - concept
   - cms
+youtubeVideo: https://www.youtube.com/watch?v=UDDTnirwi_4
 ---
 
 # Intlayer Content Management System (CMS) Documentation

package/docs/en/intlayer_cli.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2024-08-11
-updatedAt: 2025-06-29
+updatedAt: 2025-07-11
 title: CLI
 description: Discover how to use the Intlayer CLI to manage your multilingual website. Follow the steps in this online documentation to set up your project in a few minutes.
 keywords:
@@ -59,48 +59,6 @@ Intlayer accepts multiple configuration file formats:
 
 To see how to configure available locales, or other parameters, refer to the [configuration documentation here](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md).
 
-## CLI SDK
-
-The CLI SDK is a library that allows you to use the Intlayer CLI in your own code.
-
-```bash packageManager="npm"
-npm install @intlayer/cli -D
-```
-
-```bash packageManager="yarn"
-yarn add @intlayer/cli -D
-```
-
-```bash packageManager="pnpm"
-pnpm add @intlayer/cli -D
-```
-
-Example of usage:
-
-```ts
-import {
-  push,
-  pull,
-  fill,
-  build,
-  docTranslate,
-  docReview,
-} from "@intlayer/cli";
-
-push();
-// ...
-pull();
-// ...
-fill();
-// ...
-build();
-// ...
-docTranslate();
-// ...
-docReview();
-// ...
-```
-
 ## Run intlayer commands
 
 ### Build dictionaries
@@ -141,22 +99,57 @@ If [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/
 
 ##### Arguments:
 
-- `-d`, `--dictionaries`: ids of the dictionaries to pull. If not specified, all dictionaries will be pushed.
+**Dictionary options:**
+
+- **`-d`, `--dictionaries`**: ids of the dictionaries to pull. If not specified, all dictionaries will be pushed.
+
   > Example: `npx intlayer dictionary push -d my-dictionary-id my-other-dictionary-id`
-- `-r`, `--deleteLocaleDictionary`: Skip the question that asking to delete the locales directories once the dictionaries are pushed, and remove them. By default, is the dictionary is defined locally, it will overwrite distant dictionaries content.
+
+**Configuration options:**
+
+- **`--base-dir`**: Specify the base directory for the project. To retrieve the intlayer configuration, the command will look for the `intlayer.config.{ts,js,json,cjs,mjs}` file in the base directory.
+
+  > Example: `npx intlayer dictionary push --env-file .env.production.local`
+
+**Environment variables options:**
+
+- **`--env`**: Specify the environment (e.g., `development`, `production`). Useful in the case you use environment variables in your intlayer configuration file.
+- **`--env-file`**: Provide a custom environment file to load variables from. Useful in the case you use environment variables in your intlayer configuration file.
+
+  > Example: `npx intlayer dictionary push --env-file .env.production.local`
+
+  > Example: `npx intlayer dictionary push --env production`
+
+**Output options:**
+
+- **`-r`, `--delete-locale-dictionary`**: Skip the question that asking to delete the locales directories once the dictionaries are pushed, and remove them. By default, if the dictionary is defined locally, it will overwrite distant dictionaries content.
+
   > Example: `npx intlayer dictionary push -r`
-- `-k`, `--keepLocaleDictionary`: Skip the question that asking to delete the locales directories once the dictionaries are pushed, and keep them. By default, is the dictionary is defined locally, it will overwrite distant dictionaries content.
+
+  > Example: `npx intlayer dictionary push --delete-locale-dictionary`
+
+- **`-k`, `--keep-locale-dictionary`**: Skip the question that asking to delete the locales directories once the dictionaries are pushed, and keep them. By default, is the dictionary is defined locally, it will overwrite distant dictionaries content.
+
   > Example: `npx intlayer dictionary push -k`
-- `--env`: Specify the environment (e.g., `development`, `production`).
-- `--env-file`: Provide a custom environment file to load variables from.
-- `--base-dir`: Specify the base directory for the project.
-- `--verbose`: Enable verbose logging for debugging.
-- `--git-diff`: Only run on dictionaries that includes changes from base (default `origin/main`) to current branch (default: `HEAD`).
-- `--git-diff-base`: Specify the base reference for git diff (default `origin/main`).
-- `--git-diff-current`: Specify the current reference for git diff (default: `HEAD`).
-- `--uncommitted`: Include uncommitted changes.
-- `--unpushed`: Include unpushed changes.
-- `--untracked`: Include untracked files.
+
+  > Example: `npx intlayer dictionary push --keep-locale-dictionary`
+
+**Log options:**
+
+- **`--verbose`**: Enable verbose logging for debugging.
+
+**Git options:**
+
+- **`--git-diff`**: Only run on dictionaries that includes changes from base (default `origin/main`) to current branch (default: `HEAD`).
+- **`--git-diff-base`**: Specify the base reference for git diff (default `origin/main`).
+- **`--git-diff-current`**: Specify the current reference for git diff (default: `HEAD`).
+- **`--uncommitted`**: Include uncommitted changes.
+- **`--unpushed`**: Include unpushed changes.
+- **`--untracked`**: Include untracked files.
+
+  > Example: `npx intlayer dictionary push --git-diff --git-diff-base origin/main --git-diff-current HEAD`
+
+  > Example: `npx intlayer dictionary push --uncommitted --unpushed --untracked`
 
 ### Pull distant dictionaries
 
@@ -174,13 +167,35 @@ If [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/
 
 ##### Arguments:
 
-- `-d, --dictionaries`: Ids of the dictionaries to pull. If not specified, all dictionaries will be pulled.
+**Dictionary options:**
+
+- **`-d, --dictionaries`**: Ids of the dictionaries to pull. If not specified, all dictionaries will be pulled.
+
   > Example: `npx intlayer dictionary pull -d my-dictionary-id my-other-dictionary-id`
-- `--newDictionariesPath` : Path to the directory where the new dictionaries will be saved. If not specified, the news dictionaries will be saved in the `./intlayer-dictionaries` directory of the project. If a `filePath` fields is specified in your dictionary content, the dictionaries will not consider this argument and will be saved in the specified `filePath` directory.
-- `--env`: Specify the environment (e.g., `development`, `production`).
-- `--env-file`: Provide a custom environment file to load variables from.
-- `--base-dir`: Specify the base directory for the project.
-- `--verbose`: Enable verbose logging for debugging.
+
+**Configuration options:**
+
+- **`--base-dir`**: Specify the base directory for the project. To retrieve the intlayer configuration, the command will look for the `intlayer.config.{ts,js,json,cjs,mjs}` file in the base directory.
+
+  > Example: `npx intlayer dictionary push --env-file .env.production.local`
+
+**Environment variables options:**
+
+- **`--env`**: Specify the environment (e.g., `development`, `production`).
+- **`--env-file`**: Provide a custom environment file to load variables from.
+- **`--base-dir`**: Specify the base directory for the project. To retrieve the intlayer configuration, the command will look for the `intlayer.config.{ts,js,json,cjs,mjs}` file in the base directory.
+
+  > Example: `npx intlayer dictionary push --env-file .env.production.local`
+
+  > Example: `npx intlayer dictionary push --env production`
+
+**Output options:**
+
+- \*\*`--new-dictionaries-path` : Path to the directory where the new dictionaries will be saved. If not specified, the news dictionaries will be saved in the `./intlayer-dictionaries` directory of the project. If a `filePath` fields is specified in your dictionary content, the dictionaries will not consider this argument and will be saved in the specified `filePath` directory.
+
+**Log options:**
+
+- **`--verbose`**: Enable verbose logging for debugging.
 
 ##### Example:
 
@@ -204,77 +219,74 @@ This command analyzes your content declaration files for potential issues such a
 
 ##### Arguments:
 
-- `-f, --file [files...]`
-  A list of specific content declaration files to audit. If not provided, all discovered `*.content.{ts,js,mjs,cjs,tsx,jsx,json}` files will be audited.
+**Files list options:**
+
+- **`-f, --file [files...]`**: A list of specific content declaration files to audit. If not provided, all discovered `*.content.{ts,js,mjs,cjs,tsx,jsx,json}` based on your configuration file setup will be audited.
 
-- `--exclude [excludedGlobs...]`
-  Globs pattern to exclude from the audit (e.g. `--exclude "src/test/**"`).
+  > Example: `npx intlayer dictionary fill -f src/home/app.content.ts`
 
-- `--source-locale [sourceLocale]`
-  The source locale to translate from. If not specified, the default locale from your configuration will be used.
+- **`-k, --keys [keys...]`**: Filter dictionaries based on keys. If not provided, all dictionaries will be audited.
 
-- `--output-locales [outputLocales...]`
-  Target locales to translate to. If not specified, all locales from your configuration will be used except the source locale.
+  > Example: `npx intlayer dictionary fill -k key1 key2`
 
-- `--mode [mode]`
-  Translation mode: 'complete', 'review', or 'missing-only'. Default is 'missing-only'.
+- **`--excluded-keys [excludedKeys...]`**: Filter out dictionaries based on keys. If not provided, all dictionaries will be audited.
 
-- `--git-diff`
-  Filters dictionaries that includes changes from base (default `origin/main`) to current branch (default: `HEAD`).
+  > Example: `npx intlayer dictionary fill --excluded-keys key1 key2`
 
-- `--git-diff-base`
-  Specify the base reference for git diff (default `origin/main`).
+- **`--path-filter [pathFilters...]`**: Filter dictionaries based on glob pattern for file paths.
 
-- `--git-diff-current`
-  Specify the current reference for git diff (default: `HEAD`).
+  > Example: `npx intlayer dictionary fill --path-filter "src/home/**"`
 
-- `--uncommitted`
-  Filters dictionaries that includes uncommitted changes.
+**Entry output options:**
 
-- `--unpushed`
-  Filters dictionaries that includes unpushed changes.
+- **`--source-locale [sourceLocale]`**: The source locale to translate from. If not specified, the default locale from your configuration will be used.
 
-- `--untracked`
-  Filters dictionaries that includes untracked files.
+- **`--output-locales [outputLocales...]`**: Target locales to translate to. If not specified, all locales from your configuration will be used except the source locale.
 
-- `--keys [keys...]`
-  Filter dictionaries based on specified keys.
+- **`--mode [mode]`**: Translation mode: 'complete', 'review', or 'missing-only'. Default is 'missing-only'.
 
-- `--excluded-keys [excludedKeys...]`
-  Filter out dictionaries based on specified keys.
+**Git options:**
 
-- `--path-filter [pathFilters...]`
-  Filter dictionaries based on glob pattern for file paths.
+- **`--git-diff`**: Only run on dictionaries that includes changes from base (default `origin/main`) to current branch (default: `HEAD`).
+- **`--git-diff-base`**: Specify the base reference for git diff (default `origin/main`).
+- **`--git-diff-current`**: Specify the current reference for git diff (default: `HEAD`).
+- **`--uncommitted`**: Include uncommitted changes.
+- **`--unpushed`**: Include unpushed changes.
+- **`--untracked`**: Include untracked files.
+
+  > Example: `npx intlayer doc translate --git-diff --git-diff-base origin/main --git-diff-current HEAD`
+
+  > Example: `npx intlayer doc translate --uncommitted --unpushed --untracked`
+
+**AI options:**
+
+- **`--model [model]`**: The AI model to use for the translation (e.g., `gpt-3.5-turbo`).
+- **`--provider [provider]`**: The AI provider to use for the translation.
+- **`--temperature [temperature]`**: Temperature setting for the AI model.
+- **`--api-key [apiKey]`**: Provide your own API key for the AI service.
+- **`--custom-prompt [prompt]`**: Provide a custom prompt for your translation instructions.
+- **`--application-context [applicationContext]`**: Provide additional context for the AI translation.
 
-- `--model [model]`
-  The AI model to use for the translation (e.g., `gpt-3.5-turbo`).
+  > Example: `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"`
 
-- `--provider [provider]`
-  The AI provider to use for the translation.
+**Environment variables options:**
 
-- `--temperature [temperature]`
-  Temperature setting for the AI model.
+- **`--env`**: Specify the environment (e.g., `development`, `production`).
+- **`--env-file [envFile]`**: Provide a custom environment file to load variables from.
 
-- `--api-key [apiKey]`
-  Provide your own API key for the AI service.
+  > Example: `npx intlayer fill --env-file .env.production.local`
 
-- `--custom-prompt [prompt]`
-  Provide a custom prompt for your translation instructions.
+  > Example: `npx intlayer fill --env production`
 
-- `--application-context [applicationContext]`
-  Provide additional context for the AI translation.
+**Configuration options:**
 
-- `--env`
-  Specify the environment (e.g., `development`, `production`).
+- **`--base-dir`**: Specify the base directory for the project.
 
-- `--env-file [envFile]`
-  Provide a custom environment file to load variables from.
+  > Example: `npx intlayer fill --base-dir ./src`
 
-- `--base-dir`
-  Specify the base directory for the project.
+**Log options:**
 
-- `--verbose`
-  Enable verbose logging for debugging.
+- **`--verbose`**: Enable verbose logging for debugging.
 
 ##### Example:
 
@@ -342,45 +354,97 @@ npx intlayer doc translate
 
 ##### Arguments:
 
+**File list options:**
+
 - **`--doc-pattern [docPattern...]`**: Glob patterns to match documentation files to translate.
+
   > Example: `npx intlayer doc translate --doc-pattern "docs/**/*.md" "src/**/*.mdx"`
+
 - **`--excluded-glob-pattern [excludedGlobPattern...]`**: Glob patterns to exclude from translation.
+
   > Example: `npx intlayer doc translate --excluded-glob-pattern "docs/internal/**"`
-- **`--nb-simultaneous-file-processed [nbSimultaneousFileProcessed]`**: Number of files to process simultaneously for translation.
-  > Example: `npx intlayer doc translate --nb-simultaneous-file-processed 5`
+
+- **`--skip-if-modified-before [skipIfModifiedBefore]`**: Skip the file if it has been modified before the given time.
+
+  - Can be an absolute time as "2025-12-05" (string or Date)
+  - Can be a relative time in ms `1 * 60 * 60 * 1000` (1 hour)
+  - This option check update time of the file using the `fs.stat` method. So it could be impacted by Git or other tools that modify the file.
+
+  > Example: `npx intlayer doc translate --skip-if-modified-before "2025-12-05"`
+
+- **`--skip-if-modified-after [skipIfModifiedAfter]`**: Skip the file if it has been modified within the given time.
+
+  - Can be an absolute time as "2025-12-05" (string or Date)
+  - Can be a relative time in ms `1 * 60 * 60 * 1000` (1 hour)
+  - This option check update time of the file using the `fs.stat` method. So it could be impacted by Git or other tools that modify the file.
+
+  > Example: `npx intlayer doc translate --skip-if-modified-after "2025-12-05"`
+
+**Entry output options:**
+
 - **`--locales [locales...]`**: Target locales to translate documentation to.
+
   > Example: `npx intlayer doc translate --locales fr es de`
+
 - **`--base-locale [baseLocale]`**: Source locale to translate from.
+
   > Example: `npx intlayer doc translate --base-locale en`
+
+**File processing options:**
+
+- **`--nb-simultaneous-file-processed [nbSimultaneousFileProcessed]`**: Number of files to process simultaneously for translation.
+
+  > Example: `npx intlayer doc translate --nb-simultaneous-file-processed 5`
+
+**AI options:**
+
 - **`--model [model]`**: The AI model to use for translation (e.g., `gpt-3.5-turbo`).
 - **`--provider [provider]`**: The AI provider to use for translation.
 - **`--temperature [temperature]`**: Temperature setting for the AI model.
 - **`--api-key [apiKey]`**: Provide your own API key for the AI service.
-- **`--custom-prompt [prompt]`**: Provide a custom prompt for translation instructions.
 - **`--application-context [applicationContext]`**: Provide additional context for the AI translation.
+- **`--custom-prompt [prompt]`**: Customize the base prompt used for translation. (Note: For most use cases, the `--custom-instructions` option is recommended instead as it provides better control over translation behavior.)
+
+  > Example: `npx intlayer doc translate --model deepseek-chat --provider deepseek --temperature 0.5 --api-key sk-1234567890 --application-context "My application is a cat store"`
+
+**Environment variables options:**
+
 - **`--env`**: Specify the environment (e.g., `development`, `production`).
 - **`--env-file [envFile]`**: Provide a custom environment file to load variables from.
 - **`--base-dir`**: Specify the base directory for the project.
+
+  > Example: `npx intlayer doc translate --base-dir ./docs --env-file .env.production.local`
+
+**Log options:**
+
 - **`--verbose`**: Enable verbose logging for debugging.
+
+  > Example: `npx intlayer doc translate --verbose`
+
+**Custom instructions options:**
+
 - **`--custom-instructions [customInstructions]`**: Custom instructions added to the prompt. Usefull to apply specific rules regarding formatting, urls translation, etc.
-- **`--skip-if-modified-before [skipIfModifiedBefore]`**: Skip the file if it has been modified before the given time.
-  - Can be an absolute time as "2025-12-05" (string or Date)
-  - Can be a relative time in ms `1 * 60 * 60 * 1000` (1 hour)
-  - This option check update time of the file using the `fs.stat` method. So it could be impacted by Git or other tools that modify the file.
-- **`--skip-if-modified-after [skipIfModifiedAfter]`**: Skip the file if it has been modified within the given time.
+
   - Can be an absolute time as "2025-12-05" (string or Date)
   - Can be a relative time in ms `1 * 60 * 60 * 1000` (1 hour)
   - This option check update time of the file using the `fs.stat` method. So it could be impacted by Git or other tools that modify the file.
 
-##### Example:
+  > Example: `npx intlayer doc translate --custom-instructions "Avoid translating urls, and keep the markdown format"`
 
-```bash
-npx intlayer doc translate
-  --doc-pattern "docs/en/**/*.md"
-  --base-locale en --locales fr es
-  --model chatgpt-4o-latest
-  --custom-instructions "$(cat ./instructions.md)"
-```
+  > Example: `npx intlayer doc translate --custom-instructions "$(cat ./instructions.md)"`
+
+**Git options:**
+
+- **`--git-diff`**: Only run on dictionaries that includes changes from base (default `origin/main`) to current branch (default: `HEAD`).
+- **`--git-diff-base`**: Specify the base reference for git diff (default `origin/main`).
+- **`--git-diff-current`**: Specify the current reference for git diff (default: `HEAD`).
+- **`--uncommitted`**: Include uncommitted changes.
+- **`--unpushed`**: Include unpushed changes.
+- **`--untracked`**: Include untracked files.
+
+  > Example: `npx intlayer doc translate --git-diff --git-diff-base origin/main --git-diff-current HEAD`
+
+  > Example: `npx intlayer doc translate --uncommitted --unpushed --untracked`
 
 > Note that the output file path will be determined by replacing the following patterns
 >
@@ -400,19 +464,20 @@ The `doc review` command analyzes documentation files for quality, consistency,
 npx intlayer doc review
 ```
 
+It can be used to review files that are already translated, and to check if the translation is correct.
+
+For most use cases,
+
+- prefer using the `doc translate` when the translated version of this file is not available.
+- prefer using the `doc review` when the translated version of this file already exists.
+
+> Note that the review process consumes more entry tokens than the translate process to review the same file entirely. However, the review process will optimize the chunks to review, and will skip the parts that are not changed.
+
 ##### Arguments:
 
 The `doc review` command accepts the same arguments as `doc translate`, allowing you to review specific documentation files and apply quality checks.
 
-##### Example:
-
-```bash
-npx intlayer doc review
- --doc-pattern "docs/en/**/*.md"
- --locales fr es de
- --model chatgpt-4o-latest
- --custom-instructions "$(cat ./instructions.md)"
-```
+If you activated one of the git options, the command will only review the part of the files that getting changed. The script will process by chunking the file and review each chunk. If there is no changes in the chunk, the script will skip it to speed up the review process and limit the AI Provider API cost.
 
 ## Use intlayer commands in your `package.json`
 
@@ -428,6 +493,48 @@ npx intlayer doc review
 }
 ```
 
+## CLI SDK
+
+The CLI SDK is a library that allows you to use the Intlayer CLI in your own code.
+
+```bash packageManager="npm"
+npm install @intlayer/cli --save-dev
+```
+
+```bash packageManager="yarn"
+yarn add @intlayer/cli --save-dev
+```
+
+```bash packageManager="pnpm"
+pnpm add @intlayer/cli --save-dev
+```
+
+Example of usage:
+
+```ts
+import {
+  push,
+  pull,
+  fill,
+  build,
+  docTranslate,
+  docReview,
+} from "@intlayer/cli";
+
+push();
+// ...
+pull();
+// ...
+fill();
+// ...
+build();
+// ...
+docTranslate();
+// ...
+docReview();
+// ...
+```
+
 ## Debug intlayer command
 
 ### 1. **Ensure you're using the latest version**
@@ -460,6 +567,7 @@ npx clear-npx-cache
 
 ## Doc History
 
-| Version | Date       | Changes      |
-| ------- | ---------- | ------------ |
-| 5.5.10  | 2025-06-29 | Init history |
+| Version | Date       | Changes                                     |
+| ------- | ---------- | ------------------------------------------- |
+| 5.5.11  | 2025-07-11 | Update CLI command parameters documentation |
+| 5.5.10  | 2025-06-29 | Init history                                |

package/docs/en/intlayer_visual_editor.md

@@ -15,6 +15,7 @@ slugs:
   - doc
   - concept
   - editor
+youtubeVideo: https://www.youtube.com/watch?v=UDDTnirwi_4
 ---
 
 # Intlayer Visual Editor Documentation

package/docs/en/intlayer_with_angular.md

@@ -13,6 +13,7 @@ slugs:
   - doc
   - environment
   - angular
+# applicationTemplate: https://github.com/aymericzip/intlayer-angular-template
 ---
 
 # Getting Started with Internationalization (i18n) in Angular using Intlayer