@intlayer/docs 7.2.3 → 7.3.0-canary.0

package/docs/en-GB/cli/watch.md

@@ -0,0 +1,37 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Watch Dictionaries
+description: Learn how to watch for changes in your content declaration files and automatically build dictionaries.
+keywords:
+  - Watch
+  - Dictionaries
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - watch
+---
+
+# Watch Dictionaries
+
+```bash
+npx intlayer watch
+```
+
+This command will watch for changes in your content declaration files and build the dictionaries in the `.intlayer` directory.
+This command is the equivalent of `npx intlayer build --watch --skip-prepare`.
+
+## Aliases:
+
+- `npx intlayer dictionaries watch`
+- `npx intlayer dictionary watch`
+- `npx intlayer dic watch`
+
+## Arguments:
+
+- **`--with`**: Start command in parallel with the watch.
+
+> Example: `npx intlayer watch --with "next dev --turbopack"`

package/docs/en-GB/dictionary/condition.md

@@ -230,7 +230,7 @@ module.exports = ConditionalComponent;
 
 For more detailed information on configuration and usage, refer to the following resources:
 
-- [Intlayer CLI Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_cli.md)
+- [Intlayer CLI Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/index.md)
 - [React Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_create_react_app.md)
 - [Next Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_nextjs_15.md)
 

package/docs/en-GB/dictionary/markdown.md

@@ -371,7 +371,7 @@ const IntlayerMarkdownProvider = ({ children }) => (
 
 ## Additional Resources
 
-- [Intlayer CLI Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_cli.md)
+- [Intlayer CLI Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/index.md)
 - [React Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_create_react_app.md)
 - [Next Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_nextjs_15.md)
 - [markdown-to-jsx on npm](https://www.npmjs.com/package/markdown-to-jsx)

package/docs/en-GB/dictionary/nesting.md

@@ -266,7 +266,7 @@ module.exports = NestComponent;
 
 For more detailed information on configuration and usage, refer to the following resources:
 
-- [Intlayer CLI Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_cli.md)
+- [Intlayer CLI Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/index.md)
 - [React Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_create_react_app.md)
 - [Next Intlayer Documentation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_nextjs_15.md)
 

package/docs/en-GB/intlayer_with_nextjs_14.md

@@ -62,7 +62,7 @@ yarn add intlayer next-intlayer
 
 - **intlayer**
 
-  The core package that provides internationalization tools for configuration management, translation, [content declaration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/content_file.md), transpilation, and [CLI commands](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_cli.md).
+  The core package that provides internationalization tools for configuration management, translation, [content declaration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/content_file.md), transpilation, and [CLI commands](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/index.md).
 
 - **next-intlayer**
 

package/docs/en-GB/intlayer_with_react_native+expo.md

@@ -644,7 +644,7 @@ For more details on how to use the extension, refer to the [Intlayer VS Code Ext
 
 - **Visual Editor**: Use the [Intlayer Visual Editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/intlayer_visual_editor.md) to manage translations visually.
 - **CMS Integration**: You can also externalise and fetch your dictionary content from a [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_CMS.md).
-- **CLI Commands**: Explore the [Intlayer CLI](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_cli.md) for tasks like **extracting translations** or **checking missing keys**.
+- **CLI Commands**: Explore the [Intlayer CLI](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/cli/index.md) for tasks like **extracting translations** or **checking missing keys**.
 
 Enjoy building your **React Native** apps with fully powered i18n through **Intlayer**!
 

package/docs/en-GB/packages/intlayer/getPrefix.md

@@ -0,0 +1,213 @@
+---
+createdAt: 2025-11-16
+updatedAt: 2025-11-16
+title: getPrefix Function Documentation | intlayer
+description: See how to use the getPrefix function for intlayer package
+keywords:
+  - getPrefix
+  - prefix
+  - Intlayer
+  - intlayer
+  - Internationalisation
+  - Documentation
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getPrefix
+history:
+  - version: 7.1.0
+    date: 2025-11-16
+    changes: Initial documentation
+---
+
+# Documentation: `getPrefix` Function in `intlayer`
+
+## Description
+
+The `getPrefix` function determines the URL prefix for a given locale based on the routing mode configuration. It compares the locale with the default locale and returns an object containing three different prefix formats for flexible URL construction.
+
+**Key Features:**
+
+- Takes a locale as the first parameter (required)
+- Optional `options` object with `defaultLocale` and `mode`
+- Returns an object with `prefix`, and `localePrefix` properties
+- Supports all routing modes: `prefix-no-default`, `prefix-all`, `no-prefix`, and `search-params`
+- Lightweight utility for determining when to add locale prefixes
+
+---
+
+## Function Signature
+
+```typescript
+getPrefix(
+  locale: Locales,               // Required
+  options?: {                    // Optional
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): GetPrefixResult
+
+type GetPrefixResult = {
+  prefix: string;   // e.g., 'fr/' or ''
+  localePrefix?: Locale; // e.g., 'fr' or undefined
+}
+```
+
+---
+
+## Parameters
+
+- `locale: Locales`
+  - **Description**: The locale to generate the prefix for. If the value is falsy (undefined, null, empty string), the function returns an empty string.
+  - **Type**: `Locales`
+  - **Required**: Yes
+
+- `options?: object`
+  - **Description**: Configuration object for prefix determination.
+  - **Type**: `object`
+  - **Required**: No (Optional)
+
+  - `options.defaultLocale?: Locales`
+    - **Description**: The default locale for the application. If not provided, uses the configured default locale from your project configuration.
+    - **Type**: `Locales`
+    - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/configuration.md#middleware)
+
+  - `options.mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Description**: The URL routing mode for locale handling. If not provided, uses the configured mode from your project configuration.
+    - **Type**: `'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/configuration.md#middleware)
+    - **Modes**:
+      - `prefix-no-default`: Returns empty strings when locale matches default locale
+      - `prefix-all`: Returns prefix for all locales including default
+      - `no-prefix`: Returns empty strings (no prefix in URLs)
+      - `search-params`: Returns empty strings (locale in query parameters)
+
+### Returns
+
+- **Type**: `GetPrefixResult`
+- **Description**: An object containing three different prefix formats:
+  - `prefix`: The path prefix with trailing slash (e.g., `'fr/'`, `''`)
+  - `localePrefix`: The locale identifier without slashes (e.g., `'fr'`, `undefined`)
+
+---
+
+## Example Usage
+
+### Basic Usage
+
+```typescript codeFormat="typescript"
+import { getPrefix, Locales } from "intlayer";
+
+// Check prefix for English locale
+getPrefix(Locales.ENGLISH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-all",
+});
+// Returns: { prefix: 'en/', localePrefix: 'en' }
+
+// Check prefix for French locale
+getPrefix(Locales.FRENCH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Returns: { prefix: 'fr/', localePrefix: 'fr' }
+```
+
+```javascript codeFormat="esm"
+import { getPrefix, Locales } from "intlayer";
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+// Returns: { prefix: '', localePrefix: undefined }
+```
+
+```javascript codeFormat="commonjs"
+const { getPrefix, Locales } = require("intlayer");
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+// Returns: { prefix: '', localePrefix: undefined }
+```
+
+### Different Routing Modes
+
+```typescript
+import { getPrefix, Locales } from "intlayer";
+
+// prefix-all: Always returns prefix
+getPrefix(Locales.ENGLISH, {
+  mode: "prefix-all",
+  defaultLocale: Locales.ENGLISH,
+});
+// Returns: { prefix: '/en', localePrefix: 'en' }
+
+// prefix-no-default: No prefix when locale matches default
+getPrefix(Locales.ENGLISH, {
+  mode: "prefix-no-default",
+  defaultLocale: Locales.ENGLISH,
+});
+// Returns: { prefix: '', localePrefix: undefined }
+
+// // prefix-no-default: Returns prefix when locale differs from default
+getPrefix(Locales.FRENCH, {
+  mode: "prefix-no-default",
+  defaultLocale: Locales.ENGLISH,
+});
+// Returns: { prefix: 'fr/', localePrefix: 'fr' }
+
+// no-prefix & search-params: Never returns prefix
+getPrefix(Locales.ENGLISH, { mode: "no-prefix" });
+// Returns: { prefix: '', localePrefix: undefined }
+
+getPrefix(Locales.ENGLISH, { mode: "search-params" });
+// Returns: { prefix: '', localePrefix: undefined }
+```
+
+### Practical Example
+
+```typescript
+import { getPrefix, Locales } from "intlayer";
+
+// Build URLs with the appropriate prefix for a specific locale
+const locale = Locales.FRENCH;
+const { prefix, localePrefix } = getPrefix(locale, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+
+// // Using prefix for path construction
+const url1 = `/${prefix}about`.replace(/\/+/g, "/");
+// Result: "/fr/about"
+
+// Using localePrefix for locale identification
+console.log(`Current locale: ${localePrefix}`);
+// Output: "Current locale: fr"
+```
+
+---
+
+## Related Functions
+
+- [`getLocalizedUrl`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/intlayer/getLocalizedUrl.md): Generates a localised URL for a specific locale
+- [`getMultilingualUrls`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/intlayer/getMultilingualUrls.md): Generates URLs for all configured locales
+
+---
+
+## TypeScript
+
+```typescript
+type GetPrefixResult = {
+  prefix: string; // The path prefix with trailing slash (e.g., 'fr/' or '')
+  localePrefix?: Locale; // The locale identifier without slashes (e.g., 'fr' or undefined)
+};
+
+function getPrefix(
+  locale: Locales,
+  options?: {
+    defaultLocale?: Locales;
+    mode?: "prefix-no-default" | "prefix-all" | "no-prefix" | "search-params";
+  }
+): GetPrefixResult;
+```

package/docs/es/cli/build.md

@@ -0,0 +1,64 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Construir Diccionarios
+description: Aprende cómo construir tus diccionarios de Intlayer a partir de archivos de declaración de contenido.
+keywords:
+  - Construir
+  - Diccionarios
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - build
+---
+
+# Construir Diccionarios
+
+Para construir tus diccionarios, puedes ejecutar los comandos:
+
+```bash
+npx intlayer build
+```
+
+o en modo watch
+
+```bash
+npx intlayer build --watch
+```
+
+Este comando encontrará tus archivos de declaración de contenido por defecto en `./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx}`. Y construirá los diccionarios en el directorio `.intlayer`.
+
+## Alias:
+
+- `npx intlayer dictionaries build`
+- `npx intlayer dictionary build`
+- `npx intlayer dic build`
+
+## Argumentos:
+
+- **`--base-dir`**: Especifica el directorio base para el proyecto. Para obtener la configuración de intlayer, el comando buscará el archivo `intlayer.config.{ts,js,json,cjs,mjs}` en el directorio base.
+
+  > Ejemplo: `npx intlayer build --base-dir ./src`
+
+- **`--env`**: Especifica el entorno (por ejemplo, `development`, `production`). Útil en caso de que uses variables de entorno en tu archivo de configuración de intlayer.
+
+  > Ejemplo: `npx intlayer build --env production`
+
+- **`--env-file`**: Proporciona un archivo de entorno personalizado desde el cual cargar variables. Útil en caso de que uses variables de entorno en tu archivo de configuración de intlayer.
+
+  > Ejemplo: `npx intlayer build --env-file .env.production.local`
+
+- **`--with`**: Inicia un comando en paralelo con la construcción.
+
+  > Ejemplo: `npx intlayer build --with "next dev --turbopack"`
+
+- **`--skip-prepare`**: Omitir el paso de preparación.
+
+  > Ejemplo: `npx intlayer build --skip-prepare`
+
+- **`--no-cache`**: Deshabilitar la caché.
+
+  > Ejemplo: `npx intlayer build --no-cache`

package/docs/es/cli/configuration.md

@@ -0,0 +1,63 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Gestionar Configuración
+description: Aprende cómo obtener y enviar tu configuración de Intlayer al CMS.
+keywords:
+  - Configuración
+  - Config
+  - CLI
+  - Intlayer
+  - CMS
+slugs:
+  - doc
+  - concept
+  - cli
+  - configuration
+---
+
+# Gestionar Configuración
+
+## Obtener Configuración
+
+El comando `configuration get` recupera la configuración actual de Intlayer, particularmente los ajustes de localización. Esto es útil para verificar tu configuración.
+
+```bash
+npx intlayer configuration get
+```
+
+## Alias:
+
+- `npx intlayer config get`
+- `npx intlayer conf get`
+
+## Argumentos:
+
+- **`--env`**: Especifica el entorno (por ejemplo, `development`, `production`).
+- **`--env-file`**: Proporciona un archivo de entorno personalizado para cargar variables desde él.
+- **`--base-dir`**: Especifica el directorio base para el proyecto.
+- **`--verbose`**: Habilita el registro detallado para depuración. (por defecto en true usando CLI)
+- **`--no-cache`**: Desactiva la caché.
+
+## Enviar Configuración
+
+El comando `configuration push` sube tu configuración al CMS y editor de Intlayer. Este paso es necesario para habilitar el uso de diccionarios remotos en el Editor Visual de Intlayer.
+
+```bash
+npx intlayer configuration push
+```
+
+## Alias:
+
+- `npx intlayer config push`
+- `npx intlayer conf push`
+
+## Argumentos:
+
+- **`--env`**: Especifica el entorno (por ejemplo, `development`, `production`).
+- **`--env-file`**: Proporciona un archivo de entorno personalizado para cargar variables.
+- **`--base-dir`**: Especifica el directorio base para el proyecto.
+- **`--verbose`**: Habilita el registro detallado para depuración. (por defecto en true usando CLI)
+- **`--no-cache`**: Desactiva la caché.
+
+Al enviar la configuración, tu proyecto queda completamente integrado con el CMS de Intlayer, permitiendo una gestión fluida de diccionarios entre equipos.

package/docs/es/cli/debug.md

@@ -0,0 +1,46 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Depurar comando Intlayer
+description: Aprende cómo depurar y solucionar problemas del CLI de Intlayer.
+keywords:
+  - Depurar
+  - Solucionar problemas
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - debug
+---
+
+# Depurar comando intlayer
+
+## 1. **Asegúrate de estar usando la versión más reciente**
+
+Ejecuta:
+
+```bash
+npx intlayer --version                  # versión actual de intlayer en la localidad
+npx intlayer@latest --version           # versión más reciente actual de intlayer
+```
+
+## 2. **Verifica si el comando está registrado**
+
+Puedes verificar con:
+
+```bash
+npx intlayer --help                     # Muestra la lista de comandos disponibles e información de uso
+npx intlayer dictionary build --help    # Muestra la lista de opciones disponibles para un comando
+```
+
+## 3. **Reinicia tu terminal**
+
+A veces es necesario reiniciar el terminal para que reconozca nuevos comandos.
+
+## 4. **Limpia la caché de npx (si estás atascado con una versión antigua)**
+
+```bash
+npx clear-npx-cache
+```

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

@@ -0,0 +1,43 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Revisar Documento
+description: Aprende cómo revisar archivos de documentación para calidad, consistencia y completitud en diferentes locales.
+keywords:
+  - Revisión
+  - Documento
+  - Documentación
+  - IA
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - doc-review
+---
+
+# Revisar Documento
+
+El comando `doc review` analiza archivos de documentación para calidad, consistencia y completitud en diferentes locales.
+
+```bash
+npx intlayer doc review
+```
+
+Se puede usar para revisar archivos que ya están traducidos y para verificar si la traducción es correcta.
+
+Para la mayoría de los casos de uso,
+
+- prefiere usar `doc translate` cuando la versión traducida de este archivo no está disponible.
+- prefiere usar `doc review` cuando la versión traducida de este archivo ya existe.
+
+> Ten en cuenta que el proceso de revisión consume más tokens de entrada que el proceso de traducción para revisar el mismo archivo en su totalidad. Sin embargo, el proceso de revisión optimizará los fragmentos a revisar y omitirá las partes que no hayan cambiado.
+
+## Argumentos:
+
+El comando `doc review` acepta los mismos argumentos que `doc translate`, permitiéndote revisar archivos de documentación específicos y aplicar controles de calidad.
+
+Si activaste una de las opciones de git, el comando solo revisará la parte de los archivos que están siendo modificados. El script procesará el archivo dividiéndolo en fragmentos y revisará cada fragmento. Si no hay cambios en el fragmento, el script lo omitirá para acelerar el proceso de revisión y limitar el costo de la API del proveedor de IA.
+
+Para una lista completa de argumentos, consulta la documentación del comando [Translate Document](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/cli/doc-translate.md).

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

@@ -0,0 +1,132 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Traducir Documento
+description: Aprende cómo traducir automáticamente archivos de documentación usando servicios de traducción AI.
+keywords:
+  - Traducir
+  - Documento
+  - Documentación
+  - AI
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - doc-translate
+---
+
+# Traducir Documento
+
+El comando `doc translate` traduce automáticamente archivos de documentación desde un locale base a locales destino usando servicios de traducción AI.
+
+```bash
+npx intlayer doc translate
+```
+
+## Argumentos:
+
+**Opciones de lista de archivos:**
+
+- **`--doc-pattern [docPattern...]`**: Patrones glob para coincidir con archivos de documentación a traducir.
+
+  > Ejemplo: `npx intlayer doc translate --doc-pattern "docs/**/*.md" "src/**/*.mdx"`
+
+- **`--excluded-glob-pattern [excludedGlobPattern...]`**: Patrones glob para excluir archivos de la traducción.
+
+  > Ejemplo: `npx intlayer doc translate --excluded-glob-pattern "docs/internal/**"`
+
+- **`--skip-if-modified-before [skipIfModifiedBefore]`**: Omitir el archivo si ha sido modificado antes del tiempo dado.
+  - Puede ser un tiempo absoluto como "2025-12-05" (string o Date)
+  - Puede ser un tiempo relativo en ms `1 * 60 * 60 * 1000` (1 hora)
+  - Esta opción verifica la hora de actualización del archivo usando el método `fs.stat`. Por lo tanto, podría verse afectada por Git u otras herramientas que modifiquen el archivo.
+
+  > Ejemplo: `npx intlayer doc translate --skip-if-modified-before "2025-12-05"`
+
+- **`--skip-if-modified-after [skipIfModifiedAfter]`**: Omitir el archivo si ha sido modificado dentro del tiempo dado.
+  - Puede ser un tiempo absoluto como "2025-12-05" (string o Date)
+  - Puede ser un tiempo relativo en ms `1 * 60 * 60 * 1000` (1 hora)
+  - Esta opción verifica la hora de actualización del archivo usando el método `fs.stat`. Por lo tanto, podría verse afectada por Git u otras herramientas que modifiquen el archivo.
+
+  > Ejemplo: `npx intlayer doc translate --skip-if-modified-after "2025-12-05"`
+
+- **`--skip-if-exists`**: Omitir el archivo si ya existe.
+
+  > Ejemplo: `npx intlayer doc translate --skip-if-exists`
+
+**Opciones de salida de entrada:**
+
+- **`--locales [locales...]`**: Locales de destino para traducir la documentación.
+
+  > Ejemplo: `npx intlayer doc translate --locales fr es de`
+
+- **`--base-locale [baseLocale]`**: Locale de origen desde el cual traducir.
+
+  > Ejemplo: `npx intlayer doc translate --base-locale en`
+
+**Opciones de procesamiento de archivos:**
+
+- **`--nb-simultaneous-file-processed [nbSimultaneousFileProcessed]`**: Número de archivos a procesar simultáneamente para la traducción.
+
+  > Ejemplo: `npx intlayer doc translate --nb-simultaneous-file-processed 5`
+
+**Opciones de IA:**
+
+- **`--model [model]`**: El modelo de IA a usar para la traducción (por ejemplo, `gpt-3.5-turbo`).
+- **`--provider [provider]`**: El proveedor de IA a usar para la traducción.
+- **`--temperature [temperature]`**: Configuración de temperatura para el modelo de IA.
+- **`--api-key [apiKey]`**: Proporciona tu propia clave API para el servicio de IA.
+- **`--application-context [applicationContext]`**: Proporciona contexto adicional para la traducción de IA.
+- **`--custom-prompt [prompt]`**: Personaliza el prompt base utilizado para la traducción. (Nota: Para la mayoría de los casos, se recomienda usar la opción `--custom-instructions` en su lugar, ya que proporciona un mejor control sobre el comportamiento de la traducción.)
+
+  > Ejemplo: `npx intlayer doc translate --model deepseek-chat --provider deepseek --temperature 0.5 --api-key sk-1234567890 --application-context "Mi aplicación es una tienda de gatos"`
+
+**Opciones de variables de entorno:**
+
+- **`--env`**: Especifica el entorno (por ejemplo, `development`, `production`).
+- **`--env-file [envFile]`**: Proporciona un archivo de entorno personalizado para cargar variables.
+- **`--base-dir`**: Especifica el directorio base para el proyecto.
+- **`--no-cache`**: Desactiva la caché.
+
+  > Ejemplo: `npx intlayer doc translate --base-dir ./docs --env-file .env.production.local`
+
+**Opciones de registro:**
+
+- **`--verbose`**: Habilita el registro detallado para depuración. (por defecto es true usando CLI)
+
+  > Ejemplo: `npx intlayer doc translate --verbose`
+
+**Opciones de instrucciones personalizadas:**
+
+- **`--custom-instructions [customInstructions]`**: Instrucciones personalizadas añadidas al prompt. Útil para aplicar reglas específicas respecto al formato, traducción de URLs, etc.
+  - Puede ser un tiempo absoluto como "2025-12-05" (string o Date)
+  - Puede ser un tiempo relativo en ms `1 * 60 * 60 * 1000` (1 hora)
+  - Esta opción verifica la fecha de actualización del archivo usando el método `fs.stat`. Por lo tanto, podría verse afectada por Git u otras herramientas que modifiquen el archivo.
+
+  > Ejemplo: `npx intlayer doc translate --custom-instructions "Evitar traducir URLs y mantener el formato markdown"`
+
+  > Ejemplo: `npx intlayer doc translate --custom-instructions "$(cat ./instructions.md)"`
+
+**Opciones de Git:**
+
+- **`--git-diff`**: Ejecutar solo en diccionarios que incluyan cambios desde la base (por defecto `origin/main`) hasta la rama actual (por defecto: `HEAD`).
+- **`--git-diff-base`**: Especificar la referencia base para git diff (por defecto `origin/main`).
+- **`--git-diff-current`**: Especificar la referencia actual para git diff (por defecto: `HEAD`).
+- **`--uncommitted`**: Incluir cambios no confirmados.
+- **`--unpushed`**: Incluir cambios no enviados.
+- **`--untracked`**: Incluir archivos no rastreados.
+
+  > Ejemplo: `npx intlayer doc translate --git-diff --git-diff-base origin/main --git-diff-current HEAD`
+
+  > Ejemplo: `npx intlayer doc translate --uncommitted --unpushed --untracked`
+
+> Tenga en cuenta que la ruta del archivo de salida se determinará reemplazando los siguientes patrones
+>
+> - `/{{baseLocale}}/` por `/{{locale}}/` (Unix)
+> - `\{{baseLocale}}\` por `\{{locale}}\` (Windows)
+> - `_{{baseLocale}}.` por `_{{locale}}.`
+> - `{{baseLocale}}_` por `{{locale}}_`
+> - `.{{baseLocaleName}}.` por `.{{localeName}}.`
+>
+> Si no se encuentra el patrón, el archivo de salida añadirá `.{{locale}}` a la extensión del archivo. `./my/file.md` se traducirá a `./my/file.fr.md` para el locale francés.

package/docs/es/cli/editor.md

@@ -0,0 +1,28 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Comandos del Editor
+description: Aprende a usar los comandos del editor de Intlayer.
+keywords:
+  - Editor
+  - Editor Visual
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - editor
+---
+
+# Comandos del editor
+
+El comando `editor` envuelve nuevamente los comandos de `intlayer-editor`.
+
+> Para poder usar el comando `editor`, el paquete `intlayer-editor` debe estar instalado. (Ver [Editor Visual de Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/intlayer_visual_editor.md))
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:editor:start": "npx intlayer editor start --with 'next dev --turbopack'"
+}
+```