@intlayer/docs 7.5.10 → 7.5.12

package/docs/en/plugins/sync-json.md

@@ -180,18 +180,22 @@ syncJSON({
   source: ({ key, locale }) => string, // required
   location?: string, // optional label, default: "plugin"
   priority?: number, // optional priority for conflict resolution, default: 0
-  format?: 'intlayer' | 'icu' | 'i18next', // optional formatter, default: 'intlayer'
+  format?: 'intlayer' | 'icu' | 'i18next', // optional formatter, used for intlayer runtime compatibility
 });
 ```
 
 #### `format` ('intlayer' | 'icu' | 'i18next')
 
-Specifies the formatter to use for the dictionary content when synchronizing JSON files. This allows using different message formatting syntaxes compatible with various i18n libraries.
+Specifies the formatter to use for the dictionary content when synchronizing JSON files. This allows using different message formatting syntaxes compatible with intlayer runtime.
 
+- `undefined`: No formatter will be used, the JSON content will be used as is.
 - `'intlayer'`: The default Intlayer formatter (default).
 - `'icu'`: Uses ICU message formatting (compatible with libraries like react-intl, vue-i18n).
 - `'i18next'`: Uses i18next message formatting (compatible with i18next, next-i18next, Solid-i18next).
 
+> Note that using a formatter will transform your JSON content in input, and output. For complexe json rules as ICU plurals, the parsing may not ensure a 1 to 1 mapping between the input and output.
+> If you do not use Intlayer runtime, you my prefer to do not set a formatter.
+
 **Example:**
 
 ```ts

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

@@ -0,0 +1,137 @@
+---
+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
+---
+
+# CI Command
+
+```bash
+npx 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
+npx intlayer ci fill --verbose --mode complete
+```
+
+### Use in CI/CD pipelines
+
+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
+```
+
+## 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/en-GB/cli/index.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2024-08-11
-updatedAt: 2025-12-30
+updatedAt: 2026-01-06
 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:
@@ -17,6 +17,9 @@ slugs:
   - concept
   - cli
 history:
+  - version: 7.5.11
+    date: 2026-01-06
+    changes: Add projects list command
   - version: 7.5.9
     date: 2025-12-30
     changes: Add init command
@@ -119,6 +122,7 @@ To see how to configure available locales, or other parameters, refer to the [co
 - **[Build Dictionaries](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/cli/build.md)** - Build your dictionaries from content declaration files
 - **[Watch Dictionaries](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/cli/watch.md)** - Watch for changes and automatically build dictionaries
 - **[Check CLI Version](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/cli/version.md)** - Check the installed Intlayer CLI version
+- **[List Projects](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/cli/list_projects.md)** - List all Intlayer projects in a directory or git repository
 
 ### Dictionary Management
 
@@ -166,6 +170,7 @@ To see how to configure available locales, or other parameters, refer to the [co
   "intlayer:list": "npx intlayer content list",
   "intlayer:test": "npx intlayer content test",
   "intlayer:transform": "npx intlayer transform",
+  "intlayer:projects": "npx intlayer projects list",
   "intlayer:doc:translate": "npx intlayer doc translate",
   "intlayer:doc:review": "npx intlayer doc review"
 }
@@ -175,3 +180,4 @@ To see how to configure available locales, or other parameters, refer to the [co
 >
 > - `npx intlayer list` instead of `npx intlayer content list`
 > - `npx intlayer test` instead of `npx intlayer content test`
+> - `npx intlayer projects-list` or `npx intlayer pl` instead of `npx intlayer projects list`

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

@@ -1,6 +1,6 @@
 ---
 createdAt: 2024-08-11
-updatedAt: 2025-11-22
+updatedAt: 2026-01-06
 title: List Content Declaration Files
 description: Learn how to list all content declaration files in your project.
 keywords:
@@ -13,6 +13,13 @@ slugs:
   - concept
   - cli
   - list
+history:
+  - version: 7.5.12
+    date: 2026-01-06
+    changes: Add absolute output option to list command
+  - version: 7.5.11
+    date: 2026-01-06
+    changes: Add JSON output option to list command
 ---
 
 # List content declaration files
@@ -27,14 +34,36 @@ npx intlayer content list
 
 This command displays all content declaration files in your project, showing their dictionary keys and file paths. It is useful for obtaining an overview of all your content files and verifying that they are properly discovered by Intlayer.
 
-## Example:
+## Arguments:
+
+- **`--json`**: Output the results as JSON instead of formatted text. Useful for scripting and programmatic access.
+
+  > Example: `npx intlayer content list --json`
+
+## Examples:
+
+### List content declaration files:
 
 ```bash
 npx intlayer content list
 ```
 
+### Output as JSON:
+
+```bash
+npx intlayer content list --json
+```
+
+### Output as absolute paths:
+
+```bash
+npx intlayer content list --absolute
+```
+
 ## Example output:
 
+### Formatted output:
+
 ```bash
 npx intlayer content list
 Content declaration files:
@@ -45,6 +74,14 @@ Content declaration files:
 Total content declaration files: 3
 ```
 
+### JSON output:
+
+```bash
+$ npx intlayer content list --json
+
+[{"key":"home-page","path":"src/components/HomePage/homePage.content.ts"},{"key":"server-component","path":"src/components/ServerComponent/serverComponent.content.ts"},{"key":"client-component","path":"src/components/ClientComponent/clientComponent.content.ts"}]
+```
+
 This command will output:
 
 - A formatted list of all content declaration files with their keys and relative file paths

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

@@ -0,0 +1,130 @@
+---
+createdAt: 2025-12-30
+updatedAt: 2026-01-06
+title: List Intlayer Projects
+description: Learn how to list all Intlayer projects in a directory or git repository.
+keywords:
+  - List
+  - Projects
+  - CLI
+  - Intlayer
+  - Git
+slugs:
+  - doc
+  - concept
+  - cli
+  - list-projects
+history:
+  - version: 7.5.12
+    date: 2026-01-06
+    changes: Add absolute output option to list projects command
+---
+
+# List Intlayer Projects
+
+```bash
+npx intlayer projects list
+```
+
+This command searches for and lists all Intlayer projects by finding directories that contain Intlayer configuration files. It is useful for discovering all Intlayer projects in a monorepo, workspace or git repository.
+
+## Aliases:
+
+- `npx intlayer projects-list`
+- `npx intlayer pl`
+
+## Arguments:
+
+- **`--base-dir [path]`**: Specify the base directory to search from. Defaults to the current working directory.
+
+  > Example: `npx intlayer projects list --base-dir /path/to/workspace`
+
+  > Example: `npx intlayer projects list --base-dir /path/to/workspace`
+
+- **`--git-root`**: Search from the git root directory rather than the base directory. This is useful for finding all Intlayer projects in a monorepo or git repository.
+
+  > Example: `npx intlayer projects list --git-root`
+
+- **`--json`**: Output the results as JSON instead of formatted text. Useful for scripting and programmatic access.
+
+  > Example: `npx intlayer projects list --json`
+
+- **`--absolute`**: Output the results as absolute paths instead of relative paths.
+
+  > Example: `npx intlayer projects list --absolute`
+
+## How it works:
+
+The command searches for Intlayer configuration files in the specified directory (or the git root if `--git-root` is used). It looks for the following configuration file patterns:
+
+- `intlayer.config.ts`
+- `intlayer.config.js`
+- `intlayer.config.json`
+- `intlayer.config.cjs`
+- `intlayer.config.mjs`
+- `.intlayerrc`
+
+Each directory containing one of these files is considered an Intlayer project and will be listed in the output.
+
+## Examples:
+
+### List projects in current directory:
+
+```bash
+npx intlayer projects list
+```
+
+### List projects in a specific directory:
+
+```bash
+npx intlayer projects list --base-dir ./packages
+```
+
+### List all projects in the git repository:
+
+```bash
+npx intlayer projects list --git-root
+```
+
+### Using the shortcut alias:
+
+```bash
+npx intlayer pl --git-root
+```
+
+### Output as JSON:
+
+```bash
+npx intlayer projects list --json
+```
+
+## Example output:
+
+### Formatted output:
+
+```bash
+$ npx intlayer projects list --git-root
+
+Found 3 Intlayer project(s):
+
+  - /Users/user/workspace/packages/app
+  - /Users/user/workspace/packages/admin
+  - /Users/user/workspace/packages/shared
+```
+
+### JSON output:
+
+```bash
+$ npx intlayer projects list --json
+
+["/Users/user/workspace/packages/app","/Users/user/workspace/packages/admin","/Users/user/workspace/packages/shared"]
+```
+
+## Use cases:
+
+- **Monorepo management**: Discover all Intlayer projects in a monorepo structure
+- **Project discovery**: Find all Intlayer-enabled projects in a workspace
+- **CI/CD**: Verify Intlayer projects in automated workflows
+- **Documentation**: Generate documentation that lists all projects using Intlayer
+
+The output provides absolute paths to each project directory, making it easy to navigate to them or to script operations across multiple Intlayer projects.

package/docs/en-GB/intlayer_CMS.md

@@ -71,6 +71,26 @@ For integration with Vite + React, refer to the [setup guide](https://github.com
 
 ## Configuration
 
+Run the following command to login to the Intlayer CMS:
+
+```bash packageManager="npm"
+npx intlayer login
+```
+
+```bash packageManager="yarn"
+yarn intlayer login
+```
+
+```bash packageManager="pnpm"
+pnpm intlayer login
+```
+
+```bash packageManager="bun"
+bunx intlayer login
+```
+
+This will open your default browser to complete the authentication process and receive the necessary credentials (Client ID and Client Secret) to use Intlayer services.
+
 In your Intlayer configuration file, you can customise the CMS settings:
 
 ```typescript fileName="intlayer.config.ts" codeFormat="typescript"

package/docs/en-GB/intlayer_with_next-i18next.md

@@ -592,7 +592,6 @@ const config: IntlayerConfig = {
   },
   plugins: [
     syncJSON({
-      format: "i18next",
       source: ({ locale }) => `./locales/${locale}.json`,
     }),
   ],

package/docs/en-GB/intlayer_with_nextjs_14.md

@@ -81,6 +81,34 @@ bunx intlayer init
 
 ### Step 2: Configure Your Project
 
+Here is the final structure that we will make:
+
+```bash
+.
+├── src
+│   ├── app
+│   │   ├── [locale]
+│   │   │   ├── layout.tsx            # Locale layout for the Intlayer provider
+│   │   │   ├── page.content.ts
+│   │   │   └── page.tsx
+│   │   └── layout.tsx                # Root layout for style and global providers
+│   ├── components
+│   │   ├── client-component-example.content.ts
+│   │   ├── ClientComponentExample.tsx
+│   │   ├── LocaleSwitcher
+│   │   │   ├── localeSwitcher.content.ts
+│   │   │   └── LocaleSwitcher.tsx
+│   │   ├── server-component-example.content.ts
+│   │   └── ServerComponentExample.tsx
+│   └── middleware.ts
+├── intlayer.config.ts
+├── next.config.ts
+├── package.json
+└── tsconfig.json
+```
+
+> If you don't want locale routing, intlayer can be used as a simple provider / hook. See [this guide](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_nextjs_no_locale_path.md) for more details.
+
 Create a config file to configure the languages of your application:
 
 ```typescript fileName="intlayer.config.ts" codeFormat="typescript"

package/docs/en-GB/intlayer_with_nextjs_15.md

@@ -84,6 +84,34 @@ bunx intlayer init
 
 ### Step 2: Configure Your Project
 
+Here is the final structure that we will make:
+
+```bash
+.
+├── src
+│   ├── app
+│   │   ├── [locale]
+│   │   │   ├── layout.tsx            # Locale layout for the Intlayer provider
+│   │   │   ├── page.content.ts
+│   │   │   └── page.tsx
+│   │   └── layout.tsx                # Root layout for style and global providers
+│   ├── components
+│   │   ├── client-component-example.content.ts
+│   │   ├── ClientComponentExample.tsx
+│   │   ├── LocaleSwitcher
+│   │   │   ├── localeSwitcher.content.ts
+│   │   │   └── LocaleSwitcher.tsx
+│   │   ├── server-component-example.content.ts
+│   │   └── ServerComponentExample.tsx
+│   └── middleware.ts
+├── intlayer.config.ts
+├── next.config.ts
+├── package.json
+└── tsconfig.json
+```
+
+> If you don't want locale routing, intlayer can be used as a simple provider / hook. See [this guide](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_nextjs_no_locale_path.md) for more details.
+
 Create a config file to configure the languages of your application:
 
 ```typescript fileName="intlayer.config.ts" codeFormat="typescript"

package/docs/en-GB/intlayer_with_nextjs_16.md

@@ -104,6 +104,34 @@ bunx intlayer init
 
 ### Step 2: Configure Your Project
 
+Here is the final structure that we will make:
+
+```bash
+.
+├── src
+│   ├── app
+│   │   ├── [locale]
+│   │   │   ├── layout.tsx            # Locale layout for the Intlayer provider
+│   │   │   ├── page.content.ts
+│   │   │   └── page.tsx
+│   │   └── layout.tsx                # Root layout for style and global providers
+│   ├── components
+│   │   ├── client-component-example.content.ts
+│   │   ├── ClientComponentExample.tsx
+│   │   ├── LocaleSwitcher
+│   │   │   ├── localeSwitcher.content.ts
+│   │   │   └── LocaleSwitcher.tsx
+│   │   ├── server-component-example.content.ts
+│   │   └── ServerComponentExample.tsx
+│   └── proxy.ts
+├── intlayer.config.ts
+├── next.config.ts
+├── package.json
+└── tsconfig.json
+```
+
+> If you don't want locale routing, intlayer can be used as a simple provider / hook. See [this guide](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_nextjs_no_locale_path.md) for more details.
+
 Create a config file to configure the languages of your application:
 
 ```typescript fileName="intlayer.config.ts" codeFormat="typescript"