@intlayer/docs 7.5.7 → 7.5.9

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

@@ -0,0 +1,89 @@
+---
+createdAt: 2025-12-30
+updatedAt: 2025-12-30
+title: Initialise Intlayer
+description: Learn how to initialise Intlayer in your project.
+keywords:
+  - Initialise
+  - CLI
+  - Intlayer
+  - AI
+slugs:
+  - doc
+  - concept
+  - cli
+  - init
+history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
+---
+
+# Initialise Intlayer
+
+```bash
+npx intlayer init
+```
+
+The `init` command automatically sets up Intlayer in your project by configuring the necessary files and settings. It's the recommended way to get started with Intlayer.
+
+## Aliases:
+
+- `npx intlayer init`
+
+## Arguments:
+
+- `--project-root [projectRoot]` - Optional. Specify the project root directory. If not provided, the command will search for the project root starting from the current working directory.
+
+## What it does:
+
+The `init` command performs the following setup tasks:
+
+1. **Validates project structure** - Ensures you are in a valid project directory containing a `package.json` file
+2. **Updates `.gitignore`** - Adds `.intlayer` to your `.gitignore` file to exclude generated files from version control
+3. **Configures TypeScript** - Updates all `tsconfig.json` files to include Intlayer type definitions (`.intlayer/**/*.ts`)
+4. **Creates configuration file** - Generates an `intlayer.config.ts` (for TypeScript projects) or `intlayer.config.mjs` (for JavaScript projects) with default settings
+5. **Updates Vite config** - If a Vite configuration file is detected, adds the `vite-intlayer` plugin import
+6. **Updates Next.js config** - If a Next.js configuration file is detected, adds the `next-intlayer` plugin import
+
+## Examples:
+
+### Basic initialisation:
+
+```bash
+npx intlayer init
+```
+
+This will initialise Intlayer in the current directory, automatically detecting the project root.
+
+### Initialise with custom project root:
+
+```bash
+npx intlayer init --project-root ./my-project
+```
+
+This will initialise Intlayer in the specified directory.
+
+## Example output:
+
+```bash
+npx intlayer init
+Checking Intlayer configuration...
+✓ Added .intlayer to .gitignore
+✓ Updated tsconfig.json to include intlayer types
+Created intlayer.config.ts
+✓ Injected import into vite.config.ts
+✓ Intlayer init setup complete.
+```
+
+## Notes:
+
+- The command is idempotent — you can run it multiple times safely. It will skip steps that are already configured.
+- If a configuration file already exists, it will not be overwritten.
+- TypeScript config files without an `include` array (e.g., solution-style configs with references) are skipped.
+- The command will exit with an error if no `package.json` is found in the project root.
+
+- The command is idempotent - you can run it multiple times safely. It will skip steps that are already configured.
+- If a configuration file already exists, it will not be overwritten.
+- TypeScript config files without an `include` array (e.g., solution-style configs with references) are skipped.
+- The command will exit with an error if no `package.json` is found in the project root.

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

@@ -31,6 +31,10 @@ yarn add @intlayer/cli --save-dev
 pnpm add @intlayer/cli --save-dev
 ```
 
+```bash packageManager="bun"
+bun add @intlayer/cli --dev
+```
+
 Example of usage:
 
 ```ts

package/docs/en-GB/intlayer_visual_editor.md

@@ -80,6 +80,10 @@ yarn add intlayer-editor --save-dev
 pnpm add intlayer-editor --save-dev
 ```
 
+```bash packageManager="bun"
+bun add intlayer-editor --dev
+```
+
 ## Configuration
 
 In your Intlayer configuration file, you can customise the editor settings:

package/docs/en-GB/intlayer_with_angular.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-04-18
-updatedAt: 2025-06-29
-title: How to translate your Angular app – i18n guide 2025
+updatedAt: 2025-12-30
+title: How to translate your Angular app – i18n guide 2026
 description: Discover how to make your Angular website multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalization
@@ -15,6 +15,9 @@ slugs:
   - angular
 # applicationTemplate: https://github.com/aymericzip/intlayer-angular-template
 history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
   - version: 5.5.10
     date: 2025-06-29
     changes: Init history
@@ -47,14 +50,22 @@ Install the necessary packages using npm:
 
 ```bash packageManager="npm"
 npm install intlayer angular-intlayer @intlayer/webpack
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer angular-intlayer @intlayer/webpack
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer angular-intlayer @intlayer/webpack
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer angular-intlayer @intlayer/webpack
+bunx intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_astro.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-03-07
-updatedAt: 2025-10-03
-title: How to translate your Astro app – i18n guide 2025
+updatedAt: 2025-12-30
+title: How to translate your Astro app – i18n guide 2026
 description: Learn how to add internationalisation (i18n) to your Astro website using Intlayer. Follow this guide to make your site multilingual.
 keywords:
   - Internationalisation
@@ -17,6 +17,9 @@ slugs:
   - astro
 applicationTemplate: https://github.com/aymericzip/intlayer-astro-template
 history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
   - version: 6.2.0
     date: 2025-10-03
     changes: Refresh for Astro integration, config, usage

package/docs/en-GB/intlayer_with_create_react_app.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-08-11
-updatedAt: 2025-06-29
-title: How to translate your React Create App – i18n guide 2025
+updatedAt: 2025-12-30
+title: How to translate your React Create App – i18n guide 2026
 description: Discover how to make your Create React App (CRA) website multilingual. Follow the documentation to internationalize (i18n) and translate it.
 keywords:
   - Internationalization
@@ -17,6 +17,9 @@ slugs:
   - create-react-app
 applicationTemplate: https://github.com/aymericzip/intlayer-react-cra-template
 history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
   - version: 5.5.10
     date: 2025-06-29
     changes: Init history
@@ -45,14 +48,22 @@ Install the necessary packages using npm:
 
 ```bash packageManager="npm"
 npm install intlayer react-intlayer react-scripts-intlayer
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer react-intlayer react-scripts-intlayer
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer react-intlayer react-scripts-intlayer
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer react-intlayer react-scripts-intlayer
+bunx intlayer init
 ```
 
 - **intlayer**
@@ -88,14 +99,22 @@ Install the necessary packages using npm:
 
 ```bash packageManager="npm"
 npm install intlayer react-intlayer react-scripts-intlayer
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer react-intlayer react-scripts-intlayer
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer react-intlayer react-scripts-intlayer
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer react-intlayer react-scripts-intlayer
+bunx intlayer init
 ```
 
 - **intlayer**

package/docs/en-GB/intlayer_with_express.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-08-11
-updatedAt: 2025-06-29
-title: How to translate your Express backend – i18n guide 2025
+updatedAt: 2025-12-30
+title: How to translate your Express backend – i18n guide 2026
 description: Discover how to make your Express backend multilingual. Follow the documentation to internationalize (i18n) and translate it.
 keywords:
   - Internationalization
@@ -15,6 +15,9 @@ slugs:
   - environment
   - express
 history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
   - version: 5.5.10
     date: 2025-06-29
     changes: Init history
@@ -48,14 +51,22 @@ To begin using `express-intlayer`, install the package using npm:
 
 ```bash packageManager="npm"
 npm install intlayer express-intlayer
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer express-intlayer
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer express-intlayer
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer express-intlayer
+bunx intlayer init
 ```
 
 ### Setup

package/docs/en-GB/intlayer_with_lynx+react.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-03-09
-updatedAt: 2025-06-29
-title: How to translate your Lynx mobile app – i18n guide 2025
+updatedAt: 2025-12-30
+title: How to translate your Lynx mobile app – i18n guide 2026
 description: Discover how to make your Lynx and React mobile app multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation
@@ -17,6 +17,9 @@ slugs:
   - lynx-and-react
 applicationTemplate: https://github.com/aymericzip/intlayer-lynx-template
 history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
   - version: 5.5.10
     date: 2025-06-29
     changes: Init history
@@ -45,14 +48,22 @@ From your Lynx project, install the following packages:
 
 ```bash packageManager="npm"
 npm install intlayer react-intlayer lynx-intlayer
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer react-intlayer lynx-intlayer
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer react-intlayer lynx-intlayer
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer react-intlayer lynx-intlayer
+bunx intlayer init
 ```
 
 **Intlayer** is an **innovative, open-source internationalisation (i18n) library** that simplifies multilingual support in modern applications. It works in many JavaScript/TypeScript environments, **including Lynx** (via the `react-intlayer` package).
@@ -72,14 +83,22 @@ From your Lynx project, install the following packages:
 
 ```bash packageManager="npm"
 npm install intlayer react-intlayer lynx-intlayer
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer react-intlayer lynx-intlayer
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer react-intlayer lynx-intlayer
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer react-intlayer lynx-intlayer
+bunx intlayer init
 ```
 
 ### Packages

package/docs/en-GB/intlayer_with_nestjs.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-09-09
-updatedAt: 2025-09-09
-title: How to translate your Nest backend – i18n guide 2025
+updatedAt: 2025-12-30
+title: How to translate your Nest backend – i18n guide 2026
 description: Discover how to make your NestJS backend multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation
@@ -17,6 +17,9 @@ slugs:
 applicationTemplate: https://github.com/AydinTheFirst/nestjs-intlayer
 author: AydinTheFirst
 history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
   - version: 5.8.0
     date: 2025-09-09
     changes: Initial doc
@@ -59,14 +62,22 @@ To begin using `express-intlayer`, install the package using npm:
 
 ```bash packageManager="npm"
 npm install intlayer express-intlayer
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer express-intlayer
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer express-intlayer
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer express-intlayer
+bunx intlayer init
 ```
 
 ### Configure tsconfig.json

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

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-10-05
 updatedAt: 2025-10-05
-title: How to translate your Next.js 15 using next-i18next – i18n guide 2025
+title: How to translate your Next.js 15 using next-i18next – i18n guide 2026
 description: A practical, production-ready guide to internationalise a Next.js 15 App Router app with i18next/next-i18next and enhance it with Intlayer.
 keywords:
   - Internationalisation
@@ -57,6 +57,10 @@ pnpm add next-i18next i18next react-i18next i18next-resources-to-backend
 yarn add next-i18next i18next react-i18next i18next-resources-to-backend
 ```
 
+```bash packageManager="bun"
+bun add next-i18next i18next react-i18next i18next-resources-to-backend
+```
+
 Start with a clear structure. Keep messages split by locale and namespace.
 
 ```bash
@@ -553,14 +557,22 @@ Install the intlayer dependencies:
 
 ```bash packageManager="npm"
 npm install intlayer @intlayer/sync-json-plugin --save-dev
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer @intlayer/sync-json-plugin --save-dev
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer @intlayer/sync-json-plugin --dev
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer @intlayer/sync-json-plugin --dev
+bunx intlayer init
 ```
 
 ```ts fileName="intlayer.config.ts"

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

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-10-05
 updatedAt: 2025-10-05
-title: How to translate your Next.js 15 using next-intl – i18n guide 2025
+title: How to translate your Next.js 15 using next-intl – i18n guide 2026
 description: Discover how to make your Next.js 15 App Router website multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation
@@ -52,6 +52,10 @@ pnpm add next-intl
 yarn add next-intl
 ```
 
+```bash packageManager="bun"
+bun add next-intl
+```
+
 ```bash
 .
 ├── locales
@@ -402,6 +406,11 @@ yarn add intlayer @intlayer/sync-json-plugin --dev
 pnpm add intlayer @intlayer/sync-json-plugin --save-dev
 ```
 
+```bash packageManager="bun"
+bun add intlayer @intlayer/sync-json-plugin --dev
+bunx intlayer init
+```
+
 Create the intlayer configuration file:
 
 ```tsx fileName="intlayer.config.ts"

package/docs/en-GB/intlayer_with_nextjs_14.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-12-06
-updatedAt: 2025-06-29
-title: How to translate your Next.js 14 app – i18n guide 2025
+updatedAt: 2025-12-30
+title: How to translate your Next.js 14 app – i18n guide 2026
 description: Discover how to make your Next.js 14 App Router website multilingual. Follow the documentation to internationalize (i18n) and translate it.
 keywords:
   - Internationalization
@@ -17,6 +17,9 @@ slugs:
   - 14
 applicationTemplate: https://github.com/aymericzip/intlayer-next-14-template
 history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
   - version: 5.5.10
     date: 2025-06-29
     changes: Init history
@@ -50,14 +53,22 @@ Install the necessary packages using npm:
 
 ```bash packageManager="npm"
 npm install intlayer next-intlayer
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer next-intlayer
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer next-intlayer
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer next-intlayer
+bunx intlayer init
 ```
 
 - **intlayer**
@@ -1397,14 +1408,22 @@ To enable this optimization, install the `@intlayer/swc` package. Once installed
 
 ```bash packageManager="npm"
 npm install @intlayer/swc --save-dev
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add @intlayer/swc --save-dev
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add @intlayer/swc --save-dev
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add @intlayer/swc --dev
+bunx intlayer init
 ```
 
 > Note: This optimization is only available for Next.js 13 and above.

package/docs/en-GB/intlayer_with_nextjs_15.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2024-12-06
-updatedAt: 2025-06-29
-title: How to translate your 15 app – i18n guide 2025
+updatedAt: 2025-12-30
+title: How to translate your 15 app – i18n guide 2026
 description: Discover how to make your Next.js 15 website multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation
@@ -18,6 +18,9 @@ slugs:
 applicationTemplate: https://github.com/aymericzip/intlayer-next-15-template
 youtubeVideo: https://www.youtube.com/watch?v=e_PPG7PTqGU
 history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
   - version: 5.5.10
     date: 2025-06-29
     changes: Init history
@@ -53,14 +56,22 @@ Install the necessary packages using npm:
 
 ```bash packageManager="npm"
 npm install intlayer next-intlayer
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer next-intlayer
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer next-intlayer
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer next-intlayer
+bunx intlayer init
 ```
 
 - **intlayer**
@@ -1501,14 +1512,22 @@ To enable this optimisation, install the `@intlayer/swc` package. Once installed
 
 ```bash packageManager="npm"
 npm install @intlayer/swc --save-dev
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add @intlayer/swc --save-dev
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add @intlayer/swc --save-dev
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add @intlayer/swc --dev
+bunx intlayer init
 ```
 
 > Note: This optimisation is only available for Next.js 13 and above.

package/docs/en-GB/intlayer_with_nextjs_16.md

@@ -1,7 +1,7 @@
 ---
 createdAt: 2025-10-25
-updatedAt: 2025-10-26
-title: How to translate your Next.js 16 app – i18n guide 2025
+updatedAt: 2025-12-30
+title: How to translate your Next.js 16 app – i18n guide 2026
 description: Discover how to make your Next.js 16 website multilingual. Follow the documentation to internationalise (i18n) and translate it.
 keywords:
   - Internationalisation
@@ -17,6 +17,9 @@ slugs:
 applicationTemplate: https://github.com/aymericzip/intlayer-next-16-template
 youtubeVideo: https://www.youtube.com/watch?v=e_PPG7PTqGU
 history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Add init command
   - version: 7.0.0
     date: 2025-06-29
     changes: Init history
@@ -73,14 +76,22 @@ Install the necessary packages using npm:
 
 ```bash packageManager="npm"
 npm install intlayer next-intlayer
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer next-intlayer
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer next-intlayer
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add intlayer next-intlayer
+bunx intlayer init
 ```
 
 - **intlayer**
@@ -1611,14 +1622,22 @@ To enable this optimisation, install the `@intlayer/swc` package. Once installed
 
 ```bash packageManager="npm"
 npm install @intlayer/swc --save-dev
+npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add @intlayer/swc --save-dev
+pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add @intlayer/swc --save-dev
+yarn intlayer init
+```
+
+```bash packageManager="bun"
+bun add @intlayer/swc --dev
+bunx intlayer init
 ```
 
 > Note: This optimisation is only available for Next.js 13 and above.