@intlayer/docs 5.5.8

package/en-GB/interest_of_intlayer.md

@@ -0,0 +1,123 @@
+# Intlayer: A tailored way to translate your website
+
+**Intlayer** is an internationalisation library designed specifically for JavaScript developers. It allows the declaration of your content everywhere in your code. It converts the declaration of multilingual content into structured dictionaries to integrate easily into your code. Using TypeScript, **Intlayer** makes your development stronger and more efficient.
+
+## Example of usage
+
+```bash codeFormat="typescript"
+.
+└── Components
+    └── MyComponent
+        ├── index.content.ts
+        └── index.tsx
+```
+
+```bash codeFormat="commonjs"
+.
+└── Components
+    └── MyComponent
+        ├── index.content.cjs
+        └── index.mjs
+```
+
+```bash codeFormat="esm"
+.
+└── Components
+    └── MyComponent
+        ├── index.content.mjs
+        └── index.js
+```
+
+```tsx fileName="./Components/MyComponent/index.content.ts" codeFormat="typescript"
+import { t, type Dictionary } from "intlayer";
+
+const componentExampleContent = {
+  key: "component-example",
+  content: {
+    myTranslatedContent: t({
+      en: "Hello World",
+      fr: "Bonjour le monde",
+      es: "Hola Mundo",
+    }),
+  },
+} satisfies Dictionary;
+
+export default componentExampleContent;
+```
+
+```jsx fileName="./Components/MyComponent/index.mjx" codeFormat="esm"
+import { t } from "intlayer";
+
+/** @type {import('intlayer').Dictionary} */
+const componentExampleContent = {
+  key: "component-example",
+  content: {
+    myTranslatedContent: t({
+      en: "Hello World",
+      fr: "Bonjour le monde",
+      es: "Hola Mundo",
+    }),
+  },
+};
+
+export default componentExampleContent;
+```
+
+```jsx fileName="./Components/MyComponent/index.csx" codeFormat="commonjs"
+const { t } = require("intlayer");
+
+/** @type {import('intlayer').Dictionary} */
+const componentExampleContent = {
+  key: "component-example",
+  content: {
+    myTranslatedContent: t({
+      en: "Hello World",
+      fr: "Bonjour le monde",
+      es: "Hola Mundo",
+    }),
+  },
+};
+
+module.exports = componentExampleContent;
+```
+
+```tsx fileName="./Components/MyComponent/index.tsx" codeFormat="typescript"
+import { useIntlayer } from "react-intlayer";
+
+export const ComponentExample = () => {
+  const { myTranslatedContent } = useIntlayer("component-example");
+
+  return <span>{myTranslatedContent}</span>;
+};
+```
+
+```jsx fileName="./Components/MyComponent/index.mjx" codeFormat="esm"
+import { useIntlayer } from "react-intlayer";
+
+const ComponentExample = () => {
+  const { myTranslatedContent } = useIntlayer("component-example");
+
+  return <span>{myTranslatedContent}</span>;
+};
+```
+
+```jsx fileName="./Components/MyComponent/index.csx" codeFormat="commonjs"
+const { useIntlayer } = require("react-intlayer");
+
+const ComponentExample = () => {
+  const { myTranslatedContent } = useIntlayer("component-example");
+
+  return <span>{myTranslatedContent}</span>;
+};
+```
+
+## Why Choose Intlayer?
+
+- **JavaScript-Powered Content Management**: Harness the flexibility of JavaScript to define and manage your content efficiently.
+- **Type-Safe Environment**: Leverage TypeScript to ensure all your content definitions are precise and error-free.
+- **Integrated Content Files**: Keep your translations close to their respective components, enhancing maintainability and clarity.
+- **Simplified Setup**: Get up and running quickly with minimal configuration, especially optimised for Next.js projects.
+- **Server Component Support**: Perfectly suited for Next.js server components, ensuring smooth server-side rendering.
+- **Enhanced Routing**: Full support for Next.js app routing, adapting seamlessly to complex application structures.
+- **MCP Server Integration**: Provides an MCP (Model Context Protocol) server for IDE automation, enabling seamless content management and i18n workflows directly within your development environment. [Learn more](https://github.com/aymericzip/intlayer/blob/main/docs/en/mcp_server.md).
+- **Interoperability**: Allow interoperability with [react-i18next](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_with_react-i18next.md), [next-i18next](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_with_next-i18next.md), [next-intl](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_with_next-intl.md), and [react-intl](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_with_react-intl.md).

package/en-GB/intlayer_CMS.md

@@ -0,0 +1,334 @@
+# Intlayer Content Management System (CMS) Documentation
+
+<iframe title="Visual Editor + CMS for Your Web App: Intlayer Explained" class="m-auto aspect-[16/9] w-full overflow-hidden rounded-lg border-0" allow="autoplay; gyroscope;" loading="lazy" width="1080" height="auto" src="https://www.youtube.com/embed/UDDTnirwi_4?autoplay=0&amp;origin=http://intlayer.org&amp;controls=0&amp;rel=1"/>
+
+The Intlayer CMS is an Application that allows you to externalise your content of an Intlayer project.
+
+For that, Intlayer introduces the concept of 'distant dictionaries'.
+
+![Intlayer CMS Interface](https://github.com/aymericzip/intlayer/blob/main/docs/assets/CMS.png)
+
+## Understanding distant dictionaries
+
+Intlayer makes a difference between 'local' and 'distant' dictionaries.
+
+- A 'local' dictionary is a dictionary that is declared in your Intlayer project. Such as the declaration file of a button, or your navigation bar. Externalising your content does not make sense in this case because this content is not supposed to change often.
+
+- A 'distant' dictionary is a dictionary that is managed through the Intlayer CMS. It could be useful to allow your team to manage your content directly on your website, and also aims to use A/B testing features and SEO automatic optimisation.
+
+## Visual editor vs CMS
+
+The [Intlayer Visual](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_visual_editor.md) editor is a tool that allows you to manage your content in a visual editor for local dictionaries. Once a change is made, the content will be replaced in the code-base. That means that the application will be rebuilt and the page will be reloaded to display the new content.
+
+In contrast, the Intlayer CMS is a tool that allows you to manage your content in a visual editor for distant dictionaries. Once a change is made, the content will **not** impact your code-base. And the website will automatically display the changed content.
+
+## Integrating
+
+For more details on how to install the package, see the relevant section below:
+
+### Integrating with Next.js
+
+For integration with Next.js, refer to the [setup guide](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_with_nextjs_15.md).
+
+### Integrating with Create React App
+
+For integration with Create React App, refer to the [setup guide](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_with_create_react_app.md).
+
+### Integrating with Vite + React
+
+For integration with Vite + React, refer to the [setup guide](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_with_vite+react.md).
+
+## Configuration
+
+In your Intlayer configuration file, you can customise the CMS settings:
+
+```typescript fileName="intlayer.config.ts" codeFormat="typescript"
+import type { IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  // ... other configuration settings
+  editor: {
+    /**
+     * Required
+     *
+     * The URL of the application.
+     * This is the URL targeted by the visual editor.
+     */
+    applicationURL: process.env.INTLAYER_APPLICATION_URL,
+
+    /**
+     * Required
+     *
+     * Client ID and client secret are required to enable the editor.
+     * They allow the identification of the user who is editing the content.
+     * They can be obtained by creating a new client in the Intlayer Dashboard - Projects (https://intlayer.org/dashboard/projects).
+     * clientId: process.env.INTLAYER_CLIENT_ID,
+     * clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+     */
+    clientId: process.env.INTLAYER_CLIENT_ID,
+    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+
+    /**
+     * Optional
+     *
+     * In the case you are self-hosting the Intlayer CMS, you can set the URL of the CMS.
+     *
+     * The URL of the Intlayer CMS.
+     * By default, it is set to https://intlayer.org
+     */
+    cmsURL: process.env.INTLAYER_CMS_URL,
+
+    /**
+     * Optional
+     *
+     * In the case you are self-hosting the Intlayer CMS, you can set the URL of the backend.
+     *
+     * The URL of the Intlayer CMS.
+     * By default, it is set to https://back.intlayer.org
+     */
+    backendURL: process.env.INTLAYER_BACKEND_URL,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.mjs" codeFormat="esm"
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  // ... other configuration settings
+  editor: {
+    /**
+     * Required
+     *
+     * The URL of the application.
+     * This is the URL targeted by the visual editor.
+     */
+    applicationURL: process.env.INTLAYER_APPLICATION_URL,
+
+    /**
+     * Required
+     *
+     * Client ID and client secret are required to enable the editor.
+     * They allow the identification of the user who is editing the content.
+     * They can be obtained by creating a new client in the Intlayer Dashboard - Projects (https://intlayer.org/dashboard/projects).
+     * clientId: process.env.INTLAYER_CLIENT_ID,
+     * clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+     */
+    clientId: process.env.INTLAYER_CLIENT_ID,
+    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+
+    /**
+     * Optional
+     *
+     * In the case you are self-hosting the Intlayer CMS, you can set the URL of the CMS.
+     *
+     * The URL of the Intlayer CMS.
+     * By default, it is set to https://intlayer.org
+     */
+    cmsURL: process.env.INTLAYER_CMS_URL,
+
+    /**
+     * Optional
+     *
+     * In the case you are self-hosting the Intlayer CMS, you can set the URL of the backend.
+     *
+     * The URL of the Intlayer CMS.
+     * By default, it is set to https://back.intlayer.org
+     */
+    backendURL: process.env.INTLAYER_BACKEND_URL,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  // ... other configuration settings
+  editor: {
+    /**
+     * Required
+     *
+     * The URL of the application.
+     * This is the URL targeted by the visual editor.
+     */
+    applicationURL: process.env.INTLAYER_APPLICATION_URL,
+
+    /**
+     * Required
+     *
+     * Client ID and client secret are required to enable the editor.
+     * They allow the identification of the user who is editing the content.
+     * They can be obtained by creating a new client in the Intlayer Dashboard - Projects (https://intlayer.org/dashboard/projects).
+     * clientId: process.env.INTLAYER_CLIENT_ID,
+     * clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+     */
+    clientId: process.env.INTLAYER_CLIENT_ID,
+    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+
+    /**
+     * Optional
+     *
+     * In the case you are self-hosting the Intlayer CMS, you can set the URL of the CMS.
+     *
+     * The URL of the Intlayer CMS.
+     * By default, it is set to https://intlayer.org
+     */
+    cmsURL: process.env.INTLAYER_CMS_URL,
+
+    /**
+     * Optional
+     *
+     * In the case you are self-hosting the Intlayer CMS, you can set the URL of the backend.
+     *
+     * The URL of the Intlayer CMS.
+     * By default, it is set to https://back.intlayer.org
+     */
+    backendURL: process.env.INTLAYER_BACKEND_URL,
+  },
+};
+
+module.exports = config;
+```
+
+> If you don't have a client ID and client secret, you can obtain them by creating a new client in the [Intlayer Dashboard - Projects](https://intlayer.org/dashboard/projects).
+
+> To see all available parameters, refer to the [configuration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/configuration.md).
+
+## Using the CMS
+
+### Push your configuration
+
+To configure the Intlayer CMS, you can use the [intlayer CLI](https://github.com/aymericzip/intlayer/tree/main/docs/en-GB/intlayer_cli.md) commands.
+
+```bash
+npx intlayer config push
+```
+
+> If you use environment variables in your `intlayer.config.ts` configuration file, you can specify the desired environment using the `--env` argument:
+
+```bash
+npx intlayer config push --env production
+```
+
+This command uploads your configuration to the Intlayer CMS.
+
+### Push a dictionary
+
+To transform your locale dictionaries into a distant dictionary, you can use the [intlayer CLI](https://github.com/aymericzip/intlayer/tree/main/docs/en-GB/intlayer_cli.md) commands.
+
+```bash
+npx intlayer dictionary push -d my-first-dictionary-key
+```
+
+> If you use environment variables in your `intlayer.config.ts` configuration file, you can specify the desired environment using the `--env` argument:
+
+```bash
+npx intlayer dictionary push -d my-first-dictionary-key --env production
+```
+
+This command uploads your initial content dictionaries, making them available for asynchronous fetching and editing through the Intlayer platform.
+
+### Edit the dictionary
+
+Then you will be able to see and manage your dictionary in the [Intlayer CMS](https://intlayer.org/dashboard/content).
+
+## Hot reloading
+
+The Intlayer CMS is able to hot reload the dictionaries when a change is detected.
+
+Without the hot reloading, a new build of the application will be needed to display the new content.
+
+By activating the [`hotReload`](https://intlayer.org/doc/concept/configuration#editor-configuration) configuration, the application will automatically replace the updated content when it is detected.
+
+```typescript fileName="intlayer.config.ts" codeFormat="typescript"
+import type { IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  // ... other configuration settings
+  editor: {
+    // ... other configuration settings
+
+    /**
+     * Indicates if the application should hot reload the locale configurations when a change is detected.
+     * For example, when a new dictionary is added or updated, the application will update the content to display on the page.
+     *
+     * Because the hot reloading needs a continuous connection to the server, it is only available for clients of the `enterprise` plan
+     *
+     * Default: false
+     */
+    hotReload: true,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.mjs" codeFormat="esm"
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  // ... other configuration settings
+  editor: {
+    // ... other configuration settings
+
+    /**
+     * Indicates if the application should hot reload the locale configurations when a change is detected.
+     * For example, when a new dictionary is added or updated, the application will update the content to display on the page.
+     *
+     * Because the hot reloading needs a continuous connection to the server, it is only available for clients of the `enterprise` plan
+     *
+     * Default: false
+     */
+    hotReload: true,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  // ... other configuration settings
+  editor: {
+    // ... other configuration settings
+
+    /**
+     * Indicates if the application should hot reload the locale configurations when a change is detected.
+     * For example, when a new dictionary is added or updated, the application will update the content to display on the page.
+     *
+     * Because the hot reloading needs a continuous connection to the server, it is only available for clients of the `enterprise` plan
+     *
+     * Default: false
+     */
+    hotReload: true,
+  },
+};
+
+module.exports = config;
+```
+
+The hot reloading replaces the content on both server and client sides.
+
+- On the server side, you should ensure that the application process has write access to the `.intlayer/dictionaries` directory.
+- On the client side, the hot reloading allows the application to hot reload the content in the browser, without needing to reload the page. However, this feature is only available for client components.
+
+> Because the hot reloading needs a continuous connection to the server using an `EventListener`, it is only available for clients of the `enterprise` plan.
+
+## Debug
+
+If you encounter any issues with the CMS, check the following:
+
+- The application is running.
+
+- The [`editor`](https://intlayer.org/doc/concept/configuration#editor-configuration) configuration is correctly set in your Intlayer configuration file.
+
+  - Required fields:
+    - The application URL should match the one you set in the editor configuration (`applicationURL`).
+    - The CMS URL
+
+- Ensure that the project configuration was pushed to the Intlayer CMS.
+
+- The visual editor uses an iframe to display your website. Ensure that the Content Security Policy (CSP) of your website allows the CMS URL as `frame-ancestors` ('https://intlayer.org' by default). Check the editor console for any errors.

package/en-GB/intlayer_cli.md

@@ -0,0 +1,239 @@
+# Intlayer CLI
+
+## Install Package
+
+Install the necessary packages using npm:
+
+```bash packageManager="npm"
+npm install intlayer-cli -g
+```
+
+```bash packageManager="yarn"
+yarn add intlayer-cli -g
+```
+
+```bash packageManager="pnpm"
+pnpm add intlayer-cli -g
+```
+
+> If `intlayer` package is already installed, the cli is automatically installed. You can skip this step.
+
+## intlayer-cli package
+
+`intlayer-cli` package intend to transpile your [intlayer declarations](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/dictionary/get_started.md) into dictionaries.
+
+This package will transpile all intlayer files, such as `src/**/*.content.{ts|js|mjs|cjs|json}`. [See how to declare your Intlayer declaration files](https://github.com/aymericzip/intlayer/blob/main/packages/intlayer/README.md).
+
+To interpret intlayer dictionaries you can interpreters, such as [react-intlayer](https://www.npmjs.com/package/react-intlayer), or [next-intlayer](https://www.npmjs.com/package/next-intlayer)
+
+## Configuration File Support
+
+Intlayer accepts multiple configuration file formats:
+
+- `intlayer.config.ts`
+- `intlayer.config.js`
+- `intlayer.config.json`
+- `intlayer.config.cjs`
+- `intlayer.config.mjs`
+- `.intlayerrc`
+
+To see how to configure available locales, or other parameters, refer to the [configuration documentation here](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/configuration.md).
+
+## Run intlayer commands
+
+### Build dictionaries
+
+To build your dictionaries, you can run the commands:
+
+```bash
+npx intlayer dictionaries build
+```
+
+or in watch mode
+
+```bash
+npx intlayer dictionaries 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.
+
+### Push dictionaries
+
+```bash
+npx intlayer dictionary push
+```
+
+If [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_visual_editor.md) is installed, you can also push dictionaries to the editor. This command will allow to make the dictionaries available to [the editor](https://intlayer.org/dashboard). By this way, you can share your dictionaries with your team and edit your content without editing the code of your application.
+
+##### Arguments:
+
+- `-d`, `--dictionaries`: IDs of the dictionaries to push. If not specified, all dictionaries will be pushed.
+  > Example: `npx intlayer dictionary push -d my-dictionary-id my-other-dictionary-id`
+- `-r`, `--deleteLocaleDictionary`: Skip the question that asks to delete the locales directories once the dictionaries are pushed, and remove them. By default, if the dictionary is defined locally, it will overwrite distant dictionaries content.
+  > Example: `npx intlayer dictionary push -r`
+- `-k`, `--keepLocaleDictionary`: Skip the question that asks to delete the locales directories once the dictionaries are pushed, and keep them. By default, if the dictionary is defined locally, it will overwrite distant dictionaries content.
+  > Example: `npx intlayer dictionary push -k`
+- `--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.
+- `--git-diff`: Only run on dictionaries with unpushed changes.
+- `--git-diff-base`: Specify the base reference for git diff.
+- `--git-diff-current`: Specify the current reference for git diff.
+- `--uncommitted`: Include uncommitted changes.
+- `--unpushed`: Include unpushed changes.
+- `--untracked`: Include untracked files.
+
+### Pull distant dictionaries
+
+```bash
+npx intlayer dictionary pull
+```
+
+If [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/en-GB/intlayer_visual_editor.md) is installed, you can also pull dictionaries from the editor. By this way, you can overwrite the content of your dictionaries for the need of your application.
+
+##### Arguments:
+
+- `-d, --dictionaries`: IDs of the dictionaries to pull. If not specified, all dictionaries will be pulled.
+  > Example: `npx intlayer dictionary pull -d my-dictionary-id my-other-dictionary-id`
+- `--newDictionariesPath`: Path to the directory where the new dictionaries will be saved. If not specified, the new dictionaries will be saved in the `./intlayer-dictionaries` directory of the project. If a `filePath` field is specified in your dictionary content, the dictionaries will not consider this argument and will be saved in the specified `filePath` directory.
+- `--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.
+
+### Audit dictionaries
+
+```bash
+npx intlayer audit
+```
+
+This command analyzes your content declaration files for potential issues such as missing translations, structural inconsistencies, or type mismatches. If it finds any problems, **intlayer audit** will propose or apply updates to keep your dictionaries consistent and complete.
+
+##### Arguments:
+
+- **`-f, --files [files...]`**  
+  A list of specific content declaration files to audit. If not provided, all discovered `*.content.{ts,js,mjs,cjs,tsx,jsx,json}` files will be audited.
+
+- **`--exclude [excludedGlobs...]`**  
+  Globs pattern to exclude from the audit (e.g. `--exclude "src/test/**"`).
+
+- **`--source-locale [sourceLocale]`**  
+  The source locale to translate from. If not specified, the default locale from your configuration will be used.
+
+- **`--output-locales [outputLocales...]`**  
+  Target locales to translate to. If not specified, all locales from your configuration will be used except the source locale.
+
+- **`--mode [mode]`**  
+  Translation mode: 'complete', 'review', or 'missing-only'. Default is 'missing-only'.
+
+- **`--git-diff`**  
+  Only run on dictionaries with unpushed changes in the git repository.
+
+- **`--git-diff-base`**  
+  Specify the base reference for git diff.
+
+- **`--git-diff-current`**  
+  Specify the current reference for git diff.
+
+- **`--uncommitted`**  
+  Include uncommitted changes.
+
+- **`--unpushed`**  
+  Include unpushed changes.
+
+- **`--untracked`**  
+  Include untracked files.
+
+- **`--keys [keys...]`**  
+  Filter dictionaries based on specified keys.
+
+- **`--excluded-keys [excludedKeys...]`**  
+  Filter out dictionaries based on specified keys.
+
+- **`--path-filter [pathFilters...]`**  
+  Filter dictionaries based on glob pattern for file paths.
+
+- **`--model [model]`**  
+  The AI model to use for the translation (e.g., `gpt-3.5-turbo`).
+
+- **`--provider [provider]`**  
+  The AI provider to use for the translation.
+
+- **`--temperature [temperature]`**  
+  Temperature setting for the AI model.
+
+- **`--api-key [apiKey]`**  
+  Provide your own API key for the AI service.
+
+- **`--custom-prompt [prompt]`**  
+  Provide a custom prompt for your translation instructions.
+
+- **`--application-context [applicationContext]`**  
+  Provide additional context for the AI translation.
+
+- **`--env`**  
+  Specify the environment (e.g., `development`, `production`).
+
+- **`--env-file [envFile]`**  
+  Provide a custom environment file to load variables from.
+
+- **`--base-dir`**  
+  Specify the base directory for the project.
+
+- **`--verbose`**  
+  Enable verbose logging for debugging.
+
+##### Example:
+
+```bash
+npx intlayer audit --exclude "tests/**" --model gpt-3.5-turbo
+```
+
+This command will ignore any files under `tests/**` and use the `gpt-3.5-turbo` model to audit the discovered content declaration files. If any issues are found, like missing translations, they will be corrected in-place, preserving the original file structure.
+
+### Manage Configuration
+
+#### Get Configuration
+
+The `get configuration` command retrieves the current configuration for Intlayer, particularly the locale settings. This is useful for verifying your setup.
+
+```bash
+npx intlayer config 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.
+
+#### Push Configuration
+
+The `push configuration` 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 config 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.
+
+By pushing the configuration, your project is fully integrated with the Intlayer CMS, enabling seamless dictionary management across teams.
+
+## Use intlayer commands in your `package.json`
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:build": "npx intlayer dictionaries build",
+  "intlayer:watch": "npx intlayer dictionaries build --watch",
+  "intlayer:push": "npx intlayer dictionary push",
+  "intlayer:pull": "npx intlayer dictionary pull",
+  "intlayer:audit": "npx intlayer audit"
+}
+```