@intlayer/docs 7.2.3 → 7.3.0

package/docs/de/cli/test.md

@@ -0,0 +1,76 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Fehlende Übersetzungen testen
+description: Erfahren Sie, wie Sie fehlende Übersetzungen in Ihren Wörterbüchern testen und identifizieren.
+keywords:
+  - Test
+  - Fehlende Übersetzungen
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - test
+---
+
+# Fehlende Übersetzungen testen
+
+```bash
+npx intlayer content test
+```
+
+## Aliase:
+
+- `npx intlayer test`
+
+Dieser Befehl analysiert Ihre Content-Deklarationsdateien, um fehlende Übersetzungen in allen konfigurierten Sprachen zu identifizieren. Er liefert einen umfassenden Bericht, der zeigt, welche Übersetzungsschlüssel für welche Sprachen fehlen, und hilft Ihnen so, die Konsistenz Ihres mehrsprachigen Contents zu gewährleisten.
+
+## Beispielausgabe:
+
+```bash
+pnpm intlayer content test
+Missing translations:
+ - home-page                      - tr         - src/components/HomePage/homePage.content.ts
+ - server-component               - es, tr     - src/components/ServerComponent/serverComponent.content.ts
+ - client-component               - pl, tr     - src/components/ClientComponent/clientComponent.content.ts
+Locales: en, ru, ja, fr, ko, zh, es, de, ar, it, en-GB, pt, hi, tr, pl
+Erforderliche Sprachen: en
+Fehlende Sprachen: pl, tr, es
+Fehlende erforderliche Sprachen: -
+Insgesamt fehlende Sprachen: 3
+Insgesamt fehlende erforderliche Sprachen: 0
+```
+
+## Argumente:
+
+**Konfigurationsoptionen:**
+
+- **`--env`**: Geben Sie die Umgebung an (z. B. `development`, `production`).
+- **`--env-file [envFile]`**: Geben Sie eine benutzerdefinierte Umgebungsdatei an, aus der Variablen geladen werden.
+- **`--base-dir`**: Geben Sie das Basisverzeichnis für das Projekt an.
+
+> Beispiel: `npx intlayer content test --base-dir ./src --env-file .env.production.local`
+
+- **`--no-cache`**: Deaktiviert den Cache.
+
+  > Beispiel: `npx intlayer build --no-cache`
+
+**Vorbereitungsoptionen:**
+
+- **`--build`**: Baut die Wörterbücher vor dem Pushen, um sicherzustellen, dass der Inhalt aktuell ist. True erzwingt den Build, false überspringt den Build, undefined erlaubt die Verwendung des Build-Caches.
+
+**Protokolloptionen:**
+
+- **`--verbose`**: Aktiviert ausführliche Protokollierung zur Fehlerbehebung. (Standardmäßig true bei Verwendung der CLI)
+
+  > Beispiel: `npx intlayer content test --verbose`
+
+## Beispiel:
+
+```bash
+npx intlayer content test --verbose
+```
+
+Die Ausgabe hilft Ihnen schnell zu erkennen, welche Übersetzungen noch abgeschlossen werden müssen, damit Ihre Anwendung in allen konfigurierten Sprachen korrekt funktioniert.

package/docs/de/cli/transform.md

@@ -0,0 +1,65 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Komponenten transformieren
+description: Erfahren Sie, wie Sie bestehende Komponenten für die Nutzung von Intlayer transformieren.
+keywords:
+  - Transformieren
+  - Komponenten
+  - Migration
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - transform
+---
+
+# Komponenten transformieren
+
+```bash
+npx intlayer transform
+```
+
+Dieser Befehl analysiert Ihre Code-Dateien, um bei der Migration bestehender Komponenten zur Nutzung von Intlayer zu helfen. Er unterstützt eine interaktive Dateiauswahl oder die gezielte Auswahl bestimmter Dateien.
+
+## Aliase:
+
+- `npx intlayer trans`
+
+## Argumente:
+
+**Optionen zur Dateiauswahl:**
+
+- **`-f, --file [files...]`**: Liste spezifischer Dateien, die transformiert werden sollen. Wenn nicht angegeben, durchsucht die CLI passende Dateien (`**/*.{tsx,jsx,vue,svelte,ts,js}`) und fordert Sie auf, auszuwählen, welche transformiert werden sollen.
+
+  > Beispiel: `npx intlayer transform -f src/components/MyComponent.tsx`
+
+**Ausgabeoptionen:**
+
+- **`-o, --output-content-declarations [outputContentDeclarations]`**: Verzeichnis zum Speichern der generierten Content-Declaration-Dateien.
+
+  > Beispiel: `npx intlayer transform -o src/content`
+
+- **`--code-only`**: Nur den Komponenten-Code transformieren (keine Content-Declaration schreiben).
+
+  > Beispiel: `npx intlayer transform --code-only`
+
+- **`--declaration-only`**: Nur Content-Declaration generieren (Komponente nicht umschreiben).
+
+  > Beispiel: `npx intlayer transform --declaration-only`
+
+**Konfigurationsoptionen:**
+
+- **`--base-dir`**: Basisverzeichnis für das Projekt angeben.
+- **`--env`**: Umgebung angeben.
+- **`--env-file`**: Eine benutzerdefinierte Umgebungsdatei bereitstellen.
+- **`--verbose`**: Aktiviert ausführliche Protokollierung.
+
+**Erforderliche Plugins:**
+
+Der Transform-Befehl funktioniert ohne zusätzliche Plugins bei TypeScript- / JSX-Dateien. Für Vue- und Svelte-Projekte müssen jedoch die folgenden Plugins installiert sein:
+
+- **`@intlayer/vue-transformer`**: Für Vue-Dateien.
+- **`@intlayer/svelte-transformer`**: Für Svelte-Dateien.

package/docs/de/cli/version.md

@@ -0,0 +1,24 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: CLI-Version überprüfen
+description: Erfahren Sie, wie Sie die installierte Intlayer CLI-Version überprüfen.
+keywords:
+  - Version
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - version
+---
+
+# CLI-Version überprüfen
+
+```bash
+npx intlayer --version
+npx intlayer version
+```
+
+Beide Befehle geben die installierte Intlayer CLI-Version aus.

package/docs/de/cli/watch.md

@@ -0,0 +1,37 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Wörterbücher beobachten
+description: Erfahren Sie, wie Sie Änderungen in Ihren Inhaltsdeklarationsdateien überwachen und Wörterbücher automatisch erstellen.
+keywords:
+  - Beobachten
+  - Wörterbücher
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - watch
+---
+
+# Wörterbücher beobachten
+
+```bash
+npx intlayer watch
+```
+
+Dieser Befehl überwacht Änderungen in Ihren Inhaltsdeklarationsdateien und erstellt die Wörterbücher im Verzeichnis `.intlayer`.
+Dieser Befehl entspricht `npx intlayer build --watch --skip-prepare`.
+
+## Aliase:
+
+- `npx intlayer dictionaries watch`
+- `npx intlayer dictionary watch`
+- `npx intlayer dic watch`
+
+## Argumente:
+
+- **`--with`**: Startet einen Befehl parallel zum Watch-Modus.
+
+  > Beispiel: `npx intlayer watch --with "next dev --turbopack"`

package/docs/de/packages/intlayer/getPrefix.md

@@ -0,0 +1,213 @@
+---
+createdAt: 2025-11-16
+updatedAt: 2025-11-16
+title: getPrefix Funktionsdokumentation | intlayer
+description: Siehe, wie die Funktion getPrefix für das intlayer-Paket verwendet wird
+keywords:
+  - getPrefix
+  - prefix
+  - Intlayer
+  - intlayer
+  - Internationalisierung
+  - Dokumentation
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getPrefix
+history:
+  - version: 7.1.0
+    date: 2025-11-16
+    changes: Erste Dokumentation
+---
+
+# Dokumentation: `getPrefix` Funktion in `intlayer`
+
+## Beschreibung
+
+Die Funktion `getPrefix` bestimmt das URL-Präfix für eine gegebene Locale basierend auf der Routing-Modus-Konfiguration. Sie vergleicht die Locale mit der Standard-Locale und gibt ein Objekt zurück, das drei verschiedene Präfix-Formate für eine flexible URL-Konstruktion enthält.
+
+**Hauptmerkmale:**
+
+- Nimmt eine Locale als ersten Parameter (erforderlich)
+- Optionales `options`-Objekt mit `defaultLocale` und `mode`
+- Gibt ein Objekt mit den Eigenschaften `prefix` und `localePrefix` zurück
+- Unterstützt alle Routing-Modi: `prefix-no-default`, `prefix-all`, `no-prefix` und `search-params`
+- Leichtgewichtige Utility zur Bestimmung, wann Locale-Präfixe hinzugefügt werden sollen
+
+---
+
+## Funktionssignatur
+
+```typescript
+getPrefix(
+  locale: Locales,               // Erforderlich
+  options?: {                    // Optional
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): GetPrefixResult
+
+type GetPrefixResult = {
+  prefix: string;   // z.B. 'fr/' oder ''
+  localePrefix?: Locale; // z.B. 'fr' oder undefined
+}
+```
+
+---
+
+## Parameter
+
+- `locale: Locales`
+  - **Beschreibung**: Die Locale, für die das Präfix generiert werden soll. Wenn der Wert falsch ist (undefined, null, leerer String), gibt die Funktion einen leeren String zurück.
+  - **Typ**: `Locales`
+  - **Erforderlich**: Ja
+
+- `options?: object`
+  - **Beschreibung**: Konfigurationsobjekt zur Bestimmung des Präfixes.
+  - **Typ**: `object`
+  - **Erforderlich**: Nein (Optional)
+
+  - `options.defaultLocale?: Locales`
+    - **Beschreibung**: Die Standard-Locale für die Anwendung. Wenn nicht angegeben, wird die konfigurierte Standard-Locale aus der Projektkonfiguration verwendet.
+    - **Typ**: `Locales`
+    - **Standard**: [`Projektkonfiguration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/configuration.md#middleware)
+
+  - `options.mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Beschreibung**: Der URL-Routing-Modus für die Locale-Verarbeitung. Wenn nicht angegeben, wird der konfigurierte Modus aus Ihrer Projektkonfiguration verwendet.
+    - **Typ**: `'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Standard**: [`Projektkonfiguration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/configuration.md#middleware)
+    - **Modi**:
+      - `prefix-no-default`: Gibt leere Strings zurück, wenn die Locale der Standard-Locale entspricht
+      - `prefix-all`: Gibt für alle Locales, einschließlich der Standard-Locale, ein Präfix zurück
+      - `no-prefix`: Gibt leere Strings zurück (kein Präfix in URLs)
+      - `search-params`: Gibt leere Strings zurück (Locale in Abfrageparametern)
+
+### Rückgabe
+
+- **Typ**: `GetPrefixResult`
+- **Beschreibung**: Ein Objekt, das drei verschiedene Präfix-Formate enthält:
+  - `prefix`: Das Pfadpräfix mit abschließendem Schrägstrich (z.B. `'fr/'`, `''`)
+  - `localePrefix`: Der Locale-Bezeichner ohne Schrägstriche (z.B. `'fr'`, `undefined`)
+
+---
+
+## Beispielanwendung
+
+### Grundlegende Verwendung
+
+```typescript codeFormat="typescript"
+import { getPrefix, Locales } from "intlayer";
+
+// Präfix für die englische Locale prüfen
+getPrefix(Locales.ENGLISH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-all",
+});
+// Gibt zurück: { prefix: 'en/', localePrefix: 'en' }
+
+// Präfix für die französische Locale prüfen
+getPrefix(Locales.FRENCH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Gibt zurück: { prefix: 'fr/', localePrefix: 'fr' }
+```
+
+```javascript codeFormat="esm"
+import { getPrefix, Locales } from "intlayer";
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+// Gibt zurück: { prefix: '', localePrefix: undefined }
+```
+
+```javascript codeFormat="commonjs"
+const { getPrefix, Locales } = require("intlayer");
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+// Gibt zurück: { prefix: '', localePrefix: undefined }
+```
+
+### Verschiedene Routing-Modi
+
+```typescript
+import { getPrefix, Locales } from "intlayer";
+
+// prefix-all: Gibt immer ein Präfix zurück
+getPrefix(Locales.ENGLISH, {
+  mode: "prefix-all",
+  defaultLocale: Locales.ENGLISH,
+});
+// Gibt zurück: { prefix: '/en', localePrefix: 'en' }
+
+// prefix-no-default: Kein Präfix, wenn die Locale der Standard-Locale entspricht
+getPrefix(Locales.ENGLISH, {
+  mode: "prefix-no-default",
+  defaultLocale: Locales.ENGLISH,
+});
+// Gibt zurück: { prefix: '', localePrefix: undefined }
+
+// prefix-no-default: Gibt ein Präfix zurück, wenn die Locale von der Standard-Locale abweicht
+getPrefix(Locales.FRENCH, {
+  mode: "prefix-no-default",
+  defaultLocale: Locales.ENGLISH,
+});
+// Gibt zurück: { prefix: 'fr/', localePrefix: 'fr' }
+
+// no-prefix & search-params: Gibt niemals ein Präfix zurück
+getPrefix(Locales.ENGLISH, { mode: "no-prefix" });
+// Gibt zurück: { prefix: '', localePrefix: undefined }
+
+getPrefix(Locales.ENGLISH, { mode: "search-params" });
+// Gibt zurück: { prefix: '', localePrefix: undefined }
+```
+
+### Praktisches Beispiel
+
+```typescript
+import { getPrefix, Locales } from "intlayer";
+
+// URLs mit dem passenden Präfix für eine bestimmte Locale erstellen
+const locale = Locales.FRENCH;
+const { prefix, localePrefix } = getPrefix(locale, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+
+// Verwendung des Präfixes für die Pfadkonstruktion
+const url1 = `/${prefix}about`.replace(/\/+/g, "/");
+// Ergebnis: "/fr/about"
+
+// Verwendung von localePrefix zur Identifikation der Locale
+console.log(`Aktuelle Locale: ${localePrefix}`);
+// Ausgabe: "Aktuelle Locale: fr"
+```
+
+---
+
+## Verwandte Funktionen
+
+- [`getLocalizedUrl`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getLocalizedUrl.md): Generiert eine lokalisierte URL für eine bestimmte Locale
+- [`getMultilingualUrls`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/packages/intlayer/getMultilingualUrls.md): Generiert URLs für alle konfigurierten Locales
+
+---
+
+## TypeScript
+
+```typescript
+type GetPrefixResult = {
+  prefix: string; // Das Pfadpräfix mit abschließendem Schrägstrich (z.B. 'fr/' oder '')
+  localePrefix?: Locale; // Der Locale-Bezeichner ohne Schrägstriche (z.B. 'fr' oder undefined)
+};
+
+function getPrefix(
+  locale: Locales,
+  options?: {
+    defaultLocale?: Locales;
+    mode?: "prefix-no-default" | "prefix-all" | "no-prefix" | "search-params";
+  }
+): GetPrefixResult;
+```

package/docs/en/CI_CD.md

@@ -95,7 +95,7 @@ npx intlayer build                          # To ensure dictionaries are up to d
 npx intlayer fill --unpushed --mode fill    # Only fill missing content, does not update existing ones
 ```
 
-> For more information about Intlayer CLI commands and their usage, refer to the [CLI documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_cli.md).
+> For more information about Intlayer CLI commands and their usage, refer to the [CLI documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/index.md).
 
 > If you have multiple apps in your repo using separate intlayer instances, you can use the `--base-dir` argument like this:
 
@@ -195,4 +195,4 @@ To set up the environment variables, go to GitHub → Settings → Secrets and v
 
 > By default, the `--git-diff` argument filters dictionaries that include changes from base (default `origin/main`) to current branch (default: `HEAD`).
 
-> For more information about Intlayer CLI commands and their usage, refer to the [CLI documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_cli.md).
+> For more information about Intlayer CLI commands and their usage, refer to the [CLI documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/index.md).

package/docs/en/autoFill.md

@@ -34,6 +34,26 @@ history:
 
 **Autofill content declaration files** in your CI are a way to speed up your development workflow.
 
+## Understanding the behavior
+
+The `fill` command includes two modes:
+
+- **Complete**: Automatically fill all missing content for each locale and edit the current file, or another file if specified. That say, complete mode will skip the translation of existing content, if already translated.
+- **Review**: Automatically fill **all** content for each locale and generate for a specific file, or another file if specified.
+
+The will command will process all your locale content declaration files. That say, it will not process your remote content from the CMS. The CMS includes its own translations management.
+If you use plugins as `@intlayer/sync-json-plugin`, Intlayer will transform the JSON files into a locale content declaration files. That say, they will be processed by the `fill` command.
+
+The new generated files include a `filled` instruction as dictionary metadata. This instruction will be used by Intlayer to know if the file has been autofilled or not, and skip this file from being translated again if present.
+
+Intlayer will also consider the following instruction for autofill:
+
+- From your `.content.{ts|js|json}` → `fill` instruction
+- From your configuration file `.intlayer.config.ts` → `dictionary.fill` instruction
+- Will be set to `true` by default otherwise
+
+For per-locale content declaration files, the `true` instruction will be replaced by `./{{fileName}}.fill.content.json`. This is because the a per-locale content declaration file cannot receive additional localized content. So it will generate a new file to do not overwrite the existing file.
+
 ## Default Behavior
 
 By default, `fill` is set to `true` globally, which means Intlayer will automatically fill all content files and edit the file itself. This behavior can be customized in several ways:
@@ -42,8 +62,10 @@ By default, `fill` is set to `true` globally, which means Intlayer will automati
 
 1. **`fill: true` (default)** - Automatically fill all locales and edit the current file
 2. **`fill: false`** - Disable auto-fill for this content file
-3. **`fill: "path/to/file"`** - Create/update the specified file without editing the current one
-4. **`fill: { [key in Locales]?: string }`** - Create/update the specified file for each locale
+3. **`fill: "./relative/path/to/file"`** - Create/update the specified file without editing the current one by pointing to a relative path resolved based on the location of the current file
+4. **`fill: "/absolute/path/to/file"`** - Create/update the specified file without editing the current one by pointing to an relative path resolved based on the location of base directory (field `baseDir` in the configuration file `.intlayer.config.ts`)
+5. **`fill: "C:\\absolute\path\to\file"`** - Create/update the specified file without editing the current one by pointing to an absolute path resolved based on your operating system
+6. **`fill: { [key in Locales]?: string }`** - Create/update the specified file for each locale
 
 ### v7 Behavior Changes
 

package/docs/en/cli/build.md

@@ -0,0 +1,64 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Build Dictionaries
+description: Learn how to build your Intlayer dictionaries from content declaration files.
+keywords:
+  - Build
+  - Dictionaries
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - build
+---
+
+# Build Dictionaries
+
+To build your dictionaries, you can run the commands:
+
+```bash
+npx intlayer build
+```
+
+or in watch mode
+
+```bash
+npx intlayer build --watch
+```
+
+This command will find your declaration content files as default as `./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx}`. And build the dictionaries in the `.intlayer` directory.
+
+## Aliases:
+
+- `npx intlayer dictionaries build`
+- `npx intlayer dictionary build`
+- `npx intlayer dic build`
+
+## Arguments:
+
+- **`--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 build --base-dir ./src`
+
+- **`--env`**: Specify the environment (e.g., `development`, `production`). Useful in the case you use environment variables in your intlayer configuration file.
+
+  > Example: `npx intlayer build --env production`
+
+- **`--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 build --env-file .env.production.local`
+
+- **`--with`**: Start command in parallel with the build.
+
+  > Example: `npx intlayer build --with "next dev --turbopack"`
+
+- **`--skip-prepare`**: Skip the prepare step.
+
+  > Example: `npx intlayer build --skip-prepare`
+
+- **`--no-cache`**: Disable the cache.
+
+  > Example: `npx intlayer build --no-cache`

package/docs/en/cli/configuration.md

@@ -0,0 +1,63 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Manage Configuration
+description: Learn how to get and push your Intlayer configuration to the CMS.
+keywords:
+  - Configuration
+  - Config
+  - CLI
+  - Intlayer
+  - CMS
+slugs:
+  - doc
+  - concept
+  - cli
+  - configuration
+---
+
+# Manage Configuration
+
+## Get Configuration
+
+The `configuration get` command retrieves the current configuration for Intlayer, particularly the locale settings. This is useful for verifying your setup.
+
+```bash
+npx intlayer configuration get
+```
+
+## Aliases:
+
+- `npx intlayer config get`
+- `npx intlayer conf get`
+
+## Arguments:
+
+- **`--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. (default to true using CLI)
+- **`--no-cache`**: Disable the cache.
+
+## Push Configuration
+
+The `configuration push` command uploads your configuration to the Intlayer CMS and editor. This step is necessary to enable the use of distant dictionaries in the Intlayer Visual Editor.
+
+```bash
+npx intlayer configuration push
+```
+
+## Aliases:
+
+- `npx intlayer config push`
+- `npx intlayer conf push`
+
+## Arguments:
+
+- **`--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. (default to true using CLI)
+- **`--no-cache`**: Disable the cache.
+
+By pushing the configuration, your project is fully integrated with the Intlayer CMS, enabling seamless dictionary management across teams.

package/docs/en/cli/debug.md

@@ -0,0 +1,46 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Debug Intlayer Command
+description: Learn how to debug and troubleshoot Intlayer CLI issues.
+keywords:
+  - Debug
+  - Troubleshoot
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - debug
+---
+
+# Debug intlayer command
+
+## 1. **Ensure you're using the latest version**
+
+Run:
+
+```bash
+npx intlayer --version                  # current locale intlayer version
+npx intlayer@latest --version           # current latest intlayer version
+```
+
+## 2. **Check if the command is registered**
+
+You can check with:
+
+```bash
+npx intlayer --help                     # Shows the list of available commands and usage information
+npx intlayer dictionary build --help    # Shows the list of available options for a command
+```
+
+## 3. **Restart your terminal**
+
+Sometimes a terminal restart is needed to recognize new commands.
+
+## 4. **Clear npx cache (if you're stuck with an older version)**
+
+```bash
+npx clear-npx-cache
+```

package/docs/en/cli/doc-review.md

@@ -0,0 +1,43 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Review Document
+description: Learn how to review documentation files for quality, consistency, and completeness across different locales.
+keywords:
+  - Review
+  - Document
+  - Documentation
+  - AI
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - doc-review
+---
+
+# Review Document
+
+The `doc review` command analyzes documentation files for quality, consistency, and completeness across different locales.
+
+```bash
+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.
+
+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.
+
+For a complete list of arguments, see the [Translate Document](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/doc-translate.md) command documentation.