@intlayer/docs 9.5.1 → 9.5.3

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

@@ -1,186 +0,0 @@
----
-createdAt: 2026-01-06
-updatedAt: 2026-01-06
-title: CI Command
-description: Learn how to use the Intlayer CI command to run Intlayer commands with auto-injected credentials in CI/CD pipelines and monorepos.
-keywords:
-  - CI
-  - CI/CD
-  - Automation
-  - Monorepo
-  - Credentials
-  - CLI
-  - Intlayer
-slugs:
-  - doc
-  - concept
-  - cli
-  - ci
-history:
-  - version: 7.5.11
-    date: 2026-01-06
-    changes: "Add CI command"
-author: aymericzip
----
-
-# CI Command
-
-```bash packageManager="npm"
-npx intlayer ci <command...>
-```
-
-```bash packageManager="yarn"
-yarn intlayer ci <command...>
-```
-
-```bash packageManager="pnpm"
-pnpm intlayer ci <command...>
-```
-
-```bash packageManager="bun"
-bun x intlayer ci <command...>
-```
-
-The CI command is designed for automation and CI/CD pipelines. It automatically injects credentials from the `INTLAYER_PROJECT_CREDENTIALS` environment variable and can run Intlayer commands across multiple projects in a monorepo.
-
-## How it works
-
-The CI command operates in two modes:
-
-1. **Single Project Mode**: If the current working directory matches one of the project paths in `INTLAYER_PROJECT_CREDENTIALS`, it runs the command for that specific project only.
-
-2. **Iteration Mode**: If no specific project context is detected, it iterates over all configured projects and runs the command for each one.
-
-## Environment Variable
-
-The command requires the `INTLAYER_PROJECT_CREDENTIALS` environment variable to be set. This variable should contain a JSON object mapping project paths to their credentials:
-
-```json
-{
-  "packages/app": {
-    "clientId": "your-client-id-1",
-    "clientSecret": "your-client-secret-1"
-  },
-  "packages/admin": {
-    "clientId": "your-client-id-2",
-    "clientSecret": "your-client-secret-2"
-  }
-}
-```
-
-## Package Manager Detection
-
-The CI command automatically detects which package manager is being used (npm, yarn, pnpm, or bun) based on the `npm_config_user_agent` environment variable and uses the appropriate command to execute Intlayer.
-
-## Arguments
-
-- **`<command...>`**: The Intlayer command to execute (e.g., `fill`, `push`, `build`). You can pass any Intlayer command and its arguments.
-
-  > Example: `npx intlayer ci fill --verbose`
-  >
-  > Example: `npx intlayer ci push`
-  >
-  > Example: `npx intlayer ci build`
-
-## Examples
-
-### Run a command in single project mode
-
-If you're in a project directory that matches one of the paths in `INTLAYER_PROJECT_CREDENTIALS`:
-
-```bash
-cd packages/app
-npx intlayer ci fill
-```
-
-This will run the `fill` command with credentials automatically injected for the `packages/app` project.
-
-### Run a command across all projects
-
-If you're in a directory that doesn't match any project path, the command will iterate over all configured projects:
-
-```bash
-cd /path/to/monorepo
-npx intlayer ci push
-```
-
-This will run the `push` command for each project configured in `INTLAYER_PROJECT_CREDENTIALS`.
-
-### Pass additional flags
-
-You can pass any flags to the underlying Intlayer command:
-
-```bash packageManager="npm"
-npx intlayer ci fill --verbose --mode complete
-```
-
-```bash packageManager="yarn"
-yarn intlayer ci fill --verbose --mode complete
-```
-
-```bash packageManager="pnpm"
-pnpm intlayer ci fill --verbose --mode complete
-```
-
-```bash packageManager="bun"
-bun x intlayer ci fill --verbose --mode complete
-```
-
-### Use in CI/CD pipelines
-
-Running `intlayer init` scaffolds two ready-to-use GitHub Actions workflows for you (see [Scaffolded GitHub Actions](#scaffolded-github-actions) below). The example here shows the equivalent setup using the `ci` command for a monorepo, where credentials are injected per project from `INTLAYER_PROJECT_CREDENTIALS`.
-
-In your CI/CD configuration (e.g., GitHub Actions, GitLab CI), set the `INTLAYER_PROJECT_CREDENTIALS` as a secret:
-
-```yaml
-# GitHub Actions example
-env:
-  INTLAYER_PROJECT_CREDENTIALS: ${{ secrets.INTLAYER_PROJECT_CREDENTIALS }}
-
-steps:
-  - name: Fill dictionaries
-    run: npx intlayer ci fill
-```
-
-## Scaffolded GitHub Actions
-
-When you run `intlayer init`, Intlayer detects your package manager (npm, yarn, pnpm, or bun) and scaffolds two GitHub Actions workflows under `.github/workflows/`, with commands matching that package manager:
-
-- **`intlayer-fill.yml`** — On every pull request, builds the dictionaries and runs `intlayer fill --git-diff --mode complete` to generate missing translations for the changed dictionaries, then commits the result back to the PR branch.
-- **`intlayer-test.yml`** — On every pull request, builds the dictionaries and runs `intlayer test`, failing the check when required locales are missing translations.
-
-Existing workflow files are never overwritten. To skip scaffolding entirely, run:
-
-```bash
-npx intlayer init --no-github-actions
-```
-
-### Providing AI access to the fill workflow
-
-The scaffolded `intlayer-fill.yml` requires AI access. Two options are available (configured in the workflow's `env` block):
-
-1. **Your own AI provider key** — Add an `AI_API_KEY` secret in your repository settings (Settings → Secrets and variables → Actions). The workflow forwards it via `--provider`, `--model`, and `--api-key`.
-2. **Intlayer CMS access keys** — Add `INTLAYER_CLIENT_ID` and `INTLAYER_CLIENT_SECRET` secrets and wire them into your `intlayer.config` `editor` section. CMS access keys grant AI access through the Intlayer backend.
-
-The `intlayer-test.yml` workflow does not require any AI access.
-
-## Error Handling
-
-- If `INTLAYER_PROJECT_CREDENTIALS` is not set, the command will exit with an error.
-- If `INTLAYER_PROJECT_CREDENTIALS` is not valid JSON, the command will exit with an error.
-- If a project path doesn't exist, it will be skipped with a warning.
-- If any project fails, the command will exit with a non-zero status code.
-
-## Use Cases
-
-- **Monorepo automation**: Run Intlayer commands across multiple projects in a monorepo
-- **CI/CD pipelines**: Automate dictionary management in continuous integration workflows
-- **Bulk operations**: Perform the same operation on multiple Intlayer projects at once
-- **Secret management**: Securely manage credentials for multiple projects using environment variables
-
-## Security Best Practices
-
-- Store `INTLAYER_PROJECT_CREDENTIALS` as encrypted secrets in your CI/CD platform
-- Never commit credentials to version control
-- Use environment-specific credentials for different deployment environments
-- Rotate credentials regularly

package/docs/es/cli/ci.md

@@ -1,186 +0,0 @@
----
-createdAt: 2026-01-06
-updatedAt: 2026-01-06
-title: Comando CI
-description: Aprende a usar el comando Intlayer CI para ejecutar comandos Intlayer con credenciales auto-inyectadas en pipelines CI/CD y monorepos.
-keywords:
-  - CI
-  - CI/CD
-  - Automatización
-  - Monorepo
-  - Credenciales
-  - CLI
-  - Intlayer
-slugs:
-  - doc
-  - concept
-  - cli
-  - ci
-history:
-  - version: 7.5.11
-    date: 2026-01-06
-    changes: "Agregar comando CI"
-author: aymericzip
----
-
-# Comando CI
-
-```bash packageManager="npm"
-npx intlayer ci <command...>
-```
-
-```bash packageManager="yarn"
-yarn intlayer ci <command...>
-```
-
-```bash packageManager="pnpm"
-pnpm intlayer ci <command...>
-```
-
-```bash packageManager="bun"
-bun x intlayer ci <command...>
-```
-
-El comando CI está diseñado para automatización y pipelines CI/CD. Inyecta automáticamente credenciales desde la variable de entorno `INTLAYER_PROJECT_CREDENTIALS` y puede ejecutar comandos Intlayer en múltiples proyectos en un monorepo.
-
-## Cómo funciona
-
-El comando CI opera en dos modos:
-
-1. **Modo de proyecto único**: Si el directorio de trabajo actual coincide con una de las rutas de proyecto en `INTLAYER_PROJECT_CREDENTIALS`, ejecuta el comando solo para ese proyecto específico.
-
-2. **Modo de iteración**: Si no se detecta un contexto de proyecto específico, itera sobre todos los proyectos configurados y ejecuta el comando para cada uno.
-
-## Variable de entorno
-
-El comando requiere que se establezca la variable de entorno `INTLAYER_PROJECT_CREDENTIALS`. Esta variable debe contener un objeto JSON que mapee las rutas de proyecto a sus credenciales:
-
-```json
-{
-  "packages/app": {
-    "clientId": "your-client-id-1",
-    "clientSecret": "your-client-secret-1"
-  },
-  "packages/admin": {
-    "clientId": "your-client-id-2",
-    "clientSecret": "your-client-secret-2"
-  }
-}
-```
-
-## Detección del gestor de paquetes
-
-El comando CI detecta automáticamente qué gestor de paquetes se está usando (npm, yarn, pnpm o bun) basándose en la variable de entorno `npm_config_user_agent` y usa el comando apropiado para ejecutar Intlayer.
-
-## Argumentos
-
-- **`<command...>`**: El comando Intlayer a ejecutar (por ejemplo, `fill`, `push`, `build`). Puedes pasar cualquier comando Intlayer y sus argumentos.
-
-  > Ejemplo: `npx intlayer ci fill --verbose`
-  >
-  > Ejemplo: `npx intlayer ci push`
-  >
-  > Ejemplo: `npx intlayer ci build`
-
-## Ejemplos
-
-### Ejecutar un comando en modo de proyecto único
-
-Si estás en un directorio de proyecto que coincide con una de las rutas en `INTLAYER_PROJECT_CREDENTIALS`:
-
-```bash
-cd packages/app
-npx intlayer ci fill
-```
-
-Esto ejecutará el comando `fill` con las credenciales inyectadas automáticamente para el proyecto `packages/app`.
-
-### Ejecutar un comando en todos los proyectos
-
-Si estás en un directorio que no coincide con ninguna ruta de proyecto, el comando iterará sobre todos los proyectos configurados:
-
-```bash
-cd /path/to/monorepo
-npx intlayer ci push
-```
-
-Esto ejecutará el comando `push` para cada proyecto configurado en `INTLAYER_PROJECT_CREDENTIALS`.
-
-### Pasar banderas adicionales
-
-Puedes pasar cualquier bandera al comando Intlayer subyacente:
-
-```bash packageManager="npm"
-npx intlayer ci fill --verbose --mode complete
-```
-
-```bash packageManager="yarn"
-yarn intlayer ci fill --verbose --mode complete
-```
-
-```bash packageManager="pnpm"
-pnpm intlayer ci fill --verbose --mode complete
-```
-
-```bash packageManager="bun"
-bun x intlayer ci fill --verbose --mode complete
-```
-
-### Usar en pipelines CI/CD
-
-Ejecutar `intlayer init` genera dos flujos de trabajo de GitHub Actions listos para usar (ver [GitHub Actions generados](#scaffolded-github-actions) abajo). El ejemplo aquí muestra la configuración equivalente usando el comando `ci` para un monorepo, donde las credenciales se inyectan por proyecto desde `INTLAYER_PROJECT_CREDENTIALS`.
-
-En tu configuración CI/CD (por ejemplo, GitHub Actions, GitLab CI), establece `INTLAYER_PROJECT_CREDENTIALS` como secreto:
-
-```yaml
-# Ejemplo de GitHub Actions
-env:
-  INTLAYER_PROJECT_CREDENTIALS: ${{ secrets.INTLAYER_PROJECT_CREDENTIALS }}
-
-steps:
-  - name: Llenar diccionarios
-    run: npx intlayer ci fill
-```
-
-## Acciones de GitHub generadas automáticamente
-
-Cuando ejecutas `intlayer init`, Intlayer detecta tu gestor de paquetes (npm, yarn, pnpm, o bun) y genera automáticamente dos flujos de trabajo de GitHub Actions en `.github/workflows/`, con comandos que coinciden con ese gestor de paquetes:
-
-- **`intlayer-fill.yml`** — En cada pull request, construye los diccionarios y ejecuta `intlayer fill --git-diff --mode complete` para generar traducciones faltantes en los diccionarios modificados, luego confirma el resultado en la rama del PR.
-- **`intlayer-test.yml`** — En cada pull request, construye los diccionarios y ejecuta `intlayer test`, fallando la verificación cuando faltan traducciones en las locales requeridas.
-
-Los archivos de flujo de trabajo existentes nunca se sobrescriben. Para omitir la generación automática por completo, ejecuta:
-
-```bash
-npx intlayer init --no-github-actions
-```
-
-### Proporcionar acceso a IA al flujo de trabajo de relleno
-
-El `intlayer-fill.yml` generado requiere acceso a IA. Hay dos opciones disponibles (configuradas en el bloque `env` del flujo de trabajo):
-
-1. **Tu propia clave de proveedor de IA** — Agrega un secreto `AI_API_KEY` en la configuración de tu repositorio (Settings → Secrets and variables → Actions). El flujo de trabajo la reenvía a través de `--provider`, `--model` y `--api-key`.
-2. **Claves de acceso a Intlayer CMS** — Agrega los secretos `INTLAYER_CLIENT_ID` e `INTLAYER_CLIENT_SECRET` e intégralos en la sección `editor` de tu `intlayer.config`. Las claves de acceso a CMS otorgan acceso a IA a través del backend de Intlayer.
-
-El flujo de trabajo `intlayer-test.yml` no requiere acceso a IA.
-
-## Manejo de errores
-
-- Si `INTLAYER_PROJECT_CREDENTIALS` no está establecida, el comando saldrá con un error.
-- Si `INTLAYER_PROJECT_CREDENTIALS` no es un JSON válido, el comando saldrá con un error.
-- Si una ruta de proyecto no existe, se omitirá con una advertencia.
-- Si algún proyecto falla, el comando saldrá con un código de estado distinto de cero.
-
-## Casos de uso
-
-- **Automatización de monorepo**: Ejecutar comandos Intlayer en múltiples proyectos en un monorepo
-- **Pipelines CI/CD**: Automatizar la gestión de diccionarios en flujos de trabajo de integración continua
-- **Operaciones masivas**: Realizar la misma operación en múltiples proyectos Intlayer a la vez
-- **Gestión de secretos**: Gestionar de forma segura las credenciales para múltiples proyectos usando variables de entorno
-
-## Mejores prácticas de seguridad
-
-- Almacena `INTLAYER_PROJECT_CREDENTIALS` como secretos cifrados en tu plataforma CI/CD
-- Nunca comprometas las credenciales en el control de versiones
-- Usa credenciales específicas del entorno para diferentes entornos de despliegue
-- Rota las credenciales regularmente

package/docs/fr/cli/ci.md

@@ -1,186 +0,0 @@
----
-createdAt: 2026-01-06
-updatedAt: 2026-01-06
-title: Commande CI
-description: Apprenez à utiliser la commande Intlayer CI pour exécuter des commandes Intlayer avec des identifiants auto-injectés dans les pipelines CI/CD et les monorepos.
-keywords:
-  - CI
-  - CI/CD
-  - Automatisation
-  - Monorepo
-  - Identifiants
-  - CLI
-  - Intlayer
-slugs:
-  - doc
-  - concept
-  - cli
-  - ci
-history:
-  - version: 7.5.11
-    date: 2026-01-06
-    changes: "Ajouter la commande CI"
-author: aymericzip
----
-
-# Commande CI
-
-```bash packageManager="npm"
-npx intlayer ci <command...>
-```
-
-```bash packageManager="yarn"
-yarn intlayer ci <command...>
-```
-
-```bash packageManager="pnpm"
-pnpm intlayer ci <command...>
-```
-
-```bash packageManager="bun"
-bun x intlayer ci <command...>
-```
-
-La commande CI est conçue pour l'automatisation et les pipelines CI/CD. Elle injecte automatiquement les identifiants à partir de la variable d'environnement `INTLAYER_PROJECT_CREDENTIALS` et peut exécuter des commandes Intlayer sur plusieurs projets dans un monorepo.
-
-## Fonctionnement
-
-La commande CI fonctionne en deux modes :
-
-1. **Mode projet unique** : Si le répertoire de travail actuel correspond à l'un des chemins de projet dans `INTLAYER_PROJECT_CREDENTIALS`, elle exécute la commande uniquement pour ce projet spécifique.
-
-2. **Mode itération** : Si aucun contexte de projet spécifique n'est détecté, elle itère sur tous les projets configurés et exécute la commande pour chacun d'eux.
-
-## Variable d'environnement
-
-La commande nécessite que la variable d'environnement `INTLAYER_PROJECT_CREDENTIALS` soit définie. Cette variable doit contenir un objet JSON mappant les chemins de projet à leurs identifiants :
-
-```json
-{
-  "packages/app": {
-    "clientId": "your-client-id-1",
-    "clientSecret": "your-client-secret-1"
-  },
-  "packages/admin": {
-    "clientId": "your-client-id-2",
-    "clientSecret": "your-client-secret-2"
-  }
-}
-```
-
-## Détection du gestionnaire de paquets
-
-La commande CI détecte automatiquement le gestionnaire de paquets utilisé (npm, yarn, pnpm ou bun) en fonction de la variable d'environnement `npm_config_user_agent` et utilise la commande appropriée pour exécuter Intlayer.
-
-## Arguments
-
-- **`<command...>`** : La commande Intlayer à exécuter (par exemple, `fill`, `push`, `build`). Vous pouvez passer n'importe quelle commande Intlayer et ses arguments.
-
-  > Exemple : `npx intlayer ci fill --verbose`
-  >
-  > Exemple : `npx intlayer ci push`
-  >
-  > Exemple : `npx intlayer ci build`
-
-## Exemples
-
-### Exécuter une commande en mode projet unique
-
-Si vous êtes dans un répertoire de projet qui correspond à l'un des chemins dans `INTLAYER_PROJECT_CREDENTIALS` :
-
-```bash
-cd packages/app
-npx intlayer ci fill
-```
-
-Cela exécutera la commande `fill` avec les identifiants automatiquement injectés pour le projet `packages/app`.
-
-### Exécuter une commande sur tous les projets
-
-Si vous êtes dans un répertoire qui ne correspond à aucun chemin de projet, la commande itérera sur tous les projets configurés :
-
-```bash
-cd /path/to/monorepo
-npx intlayer ci push
-```
-
-Cela exécutera la commande `push` pour chaque projet configuré dans `INTLAYER_PROJECT_CREDENTIALS`.
-
-### Passer des drapeaux supplémentaires
-
-Vous pouvez passer n'importe quels drapeaux à la commande Intlayer sous-jacente :
-
-```bash packageManager="npm"
-npx intlayer ci fill --verbose --mode complete
-```
-
-```bash packageManager="yarn"
-yarn intlayer ci fill --verbose --mode complete
-```
-
-```bash packageManager="pnpm"
-pnpm intlayer ci fill --verbose --mode complete
-```
-
-```bash packageManager="bun"
-bun x intlayer ci fill --verbose --mode complete
-```
-
-### Utilisation dans les pipelines CI/CD
-
-L'exécution de `intlayer init` crée deux workflows GitHub Actions prêts à l'emploi pour vous (voir [Scaffolded GitHub Actions](#scaffolded-github-actions) ci-dessous). L'exemple ici montre la configuration équivalente en utilisant la commande `ci` pour un monorepo, où les credentials sont injectés par projet depuis `INTLAYER_PROJECT_CREDENTIALS`.
-
-Dans votre configuration CI/CD (par exemple, GitHub Actions, GitLab CI), définissez `INTLAYER_PROJECT_CREDENTIALS` comme secret :
-
-```yaml
-# Exemple GitHub Actions
-env:
-  INTLAYER_PROJECT_CREDENTIALS: ${{ secrets.INTLAYER_PROJECT_CREDENTIALS }}
-
-steps:
-  - name: Remplir les dictionnaires
-    run: npx intlayer ci fill
-```
-
-## GitHub Actions générés automatiquement
-
-Lorsque vous exécutez `intlayer init`, Intlayer détecte votre gestionnaire de paquets (npm, yarn, pnpm, ou bun) et génère automatiquement deux workflows GitHub Actions sous `.github/workflows/`, avec des commandes correspondant à ce gestionnaire de paquets :
-
-- **`intlayer-fill.yml`** — Sur chaque pull request, construit les dictionnaires et exécute `intlayer fill --git-diff --mode complete` pour générer les traductions manquantes pour les dictionnaires modifiés, puis valide le résultat sur la branche PR.
-- **`intlayer-test.yml`** — Sur chaque pull request, construit les dictionnaires et exécute `intlayer test`, échouant la vérification si les locales requises ont des traductions manquantes.
-
-Les fichiers de workflow existants ne sont jamais écrasés. Pour ignorer complètement la génération automatique, exécutez :
-
-```bash
-npx intlayer init --no-github-actions
-```
-
-### Fournir un accès IA au workflow de remplissage
-
-Le fichier `intlayer-fill.yml` généré nécessite un accès IA. Deux options sont disponibles (configurées dans le bloc `env` du workflow) :
-
-1. **Votre propre clé de fournisseur IA** — Ajoutez un secret `AI_API_KEY` dans les paramètres de votre référentiel (Settings → Secrets and variables → Actions). Le workflow le transmet via `--provider`, `--model` et `--api-key`.
-2. **Clés d'accès Intlayer CMS** — Ajoutez les secrets `INTLAYER_CLIENT_ID` et `INTLAYER_CLIENT_SECRET` et intégrez-les dans la section `editor` de votre `intlayer.config`. Les clés d'accès CMS accordent l'accès IA via le backend Intlayer.
-
-Le workflow `intlayer-test.yml` ne nécessite aucun accès IA.
-
-## Gestion des erreurs
-
-- Si `INTLAYER_PROJECT_CREDENTIALS` n'est pas définie, la commande se terminera avec une erreur.
-- Si `INTLAYER_PROJECT_CREDENTIALS` n'est pas un JSON valide, la commande se terminera avec une erreur.
-- Si un chemin de projet n'existe pas, il sera ignoré avec un avertissement.
-- Si un projet échoue, la commande se terminera avec un code de statut non nul.
-
-## Cas d'utilisation
-
-- **Automatisation de monorepo** : Exécuter des commandes Intlayer sur plusieurs projets dans un monorepo
-- **Pipelines CI/CD** : Automatiser la gestion des dictionnaires dans les workflows d'intégration continue
-- **Opérations en masse** : Effectuer la même opération sur plusieurs projets Intlayer à la fois
-- **Gestion des secrets** : Gérer de manière sécurisée les identifiants pour plusieurs projets en utilisant des variables d'environnement
-
-## Bonnes pratiques de sécurité
-
-- Stockez `INTLAYER_PROJECT_CREDENTIALS` comme secrets chiffrés dans votre plateforme CI/CD
-- Ne commitez jamais les identifiants dans le contrôle de version
-- Utilisez des identifiants spécifiques à l'environnement pour différents environnements de déploiement
-- Faites tourner les identifiants régulièrement