@intlayer/docs 7.5.12 → 7.5.14

package/docs/uk/cli/index.md

@@ -0,0 +1,190 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2026-01-06
+title: CLI - Усі CLI-команди Intlayer для вашого багатомовного вебсайту
+description: Дізнайтеся, як використовувати Intlayer CLI для керування вашим багатомовним вебсайтом. Дотримуйтесь кроків цієї онлайн-документації, щоб налаштувати проєкт за кілька хвилин.
+keywords:
+  - CLI
+  - Command Line Interface
+  - Internationalization
+  - Документація
+  - Intlayer
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - concept
+  - cli
+history:
+  - version: 7.5.11
+    date: 2026-01-06
+    changes: Додано команду CI
+  - version: 7.5.11
+    date: 2026-01-06
+    changes: Додано команду списку проєктів
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Додано команду init
+  - version: 7.2.3
+    date: 2025-11-22
+    changes: Додано команду transform
+  - version: 7.1.0
+    date: 2025-11-05
+    changes: Додано опцію skipIfExists для команди translate
+  - version: 6.1.4
+    date: 2025-01-27
+    changes: Додано aliases для аргументів і команд CLI
+  - version: 6.1.3
+    date: 2025-10-05
+    changes: Додано опцію build для команд
+  - version: 6.1.2
+    date: 2025-09-26
+    changes: Додано команду version
+  - version: 6.1.0
+    date: 2025-09-26
+    changes: Встановлено опцію verbose за замовчуванням у true через CLI
+  - version: 6.1.0
+    date: 2025-09-23
+    changes: Додано команду watch та опцію with
+  - version: 6.0.1
+    date: 2025-09-23
+    changes: Додано команду editor
+  - version: 6.0.0
+    date: 2025-09-17
+    changes: Додано команди content test і list
+  - version: 5.5.11
+    date: 2025-07-11
+    changes: Оновлено документацію параметрів команд CLI
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Ініціалізація історії
+---
+
+# Intlayer CLI — Усі команди Intlayer CLI для вашого багатомовного сайту
+
+---
+
+## Table of Contents
+
+<TOC/>
+
+---
+
+## Встановлення пакету
+
+Встановіть необхідні пакети за допомогою одного з пакетних менеджерів:
+
+```bash packageManager="npm"
+npm install intlayer-cli -g
+```
+
+```bash packageManager="yarn"
+yarn add intlayer-cli -g
+```
+
+```bash packageManager="pnpm"
+pnpm add intlayer-cli -g
+```
+
+```bash packageManager="bun"
+bun add intlayer-cli -g
+```
+
+> Якщо пакет `intlayer` уже встановлено, CLI встановлюється автоматично. Ви можете пропустити цей крок.
+
+## Пакет intlayer-cli
+
+Пакет `intlayer-cli` призначений для трансляції ваших [оголошень intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/dictionary/content_file.md) у словники.
+
+Цей пакет транспілює всі файли Intlayer, наприклад `src/**/*.content.{ts|js|mjs|cjs|json}`. [Див. як оголосити ваші файли декларацій Intlayer](https://github.com/aymericzip/intlayer/blob/main/packages/intlayer/README.md).
+
+Щоб інтерпретувати словники Intlayer, ви можете використовувати інтерпретатори, такі як [react-intlayer](https://www.npmjs.com/package/react-intlayer) або [next-intlayer](https://www.npmjs.com/package/next-intlayer).
+
+## Підтримка конфігураційних файлів
+
+Intlayer підтримує кілька форматів конфігураційних файлів:
+
+- `intlayer.config.ts`
+- `intlayer.config.js`
+- `intlayer.config.json`
+- `intlayer.config.cjs`
+- `intlayer.config.mjs`
+- `.intlayerrc`
+
+Щоб дізнатися, як налаштувати доступні локалі або інші параметри, перегляньте [документацію з конфігурації](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/configuration.md).
+
+## Запуск команд intlayer
+
+### Аутентифікація
+
+- **[Вхід](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/login.md)** - Аутентифікація в Intlayer CMS і отримання облікових даних доступу
+
+### Основні команди
+
+- **[Побудова словників](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/build.md)** - Побудуйте словники з файлів декларацій контенту
+- **[Спостереження за словниками](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/watch.md)** - Слідкувати за змінами та автоматично збирати словники
+- **[Перевірити версію CLI](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/version.md)** - Перевірити встановлену версію Intlayer CLI
+- **[Список проєктів](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/list_projects.md)** - Перелічити всі проєкти Intlayer у директорії або git-репозиторії
+
+### Керування словниками
+
+- **[Відправити словники](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/push.md)** - Відправити словники до редактора та CMS Intlayer
+- **[Завантажити словники](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/pull.md)** - Завантажити словники з редактора та CMS Intlayer
+- **[Заповнити словники](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/fill.md)** - Заповнюйте, перевіряйте та перекладайте словники за допомогою AI
+- **[Перевірити відсутні переклади](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/test.md)** - Перевіряйте та виявляйте відсутні переклади
+- **[Перелічити файли декларації контенту](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/list.md)** - Перелічити всі файли декларації контенту у вашому проєкті
+
+### Керування компонентами
+
+- **[Трансформувати компоненти](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/transform.md)** - Трансформувати існуючі компоненти для використання Intlayer
+
+### Конфігурація
+
+- **[Ініціалізація Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/init.md)** - Налаштуйте Intlayer у вашому проєкті з автоматичною конфігурацією
+- **[Управління конфігурацією](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/configuration.md)** - Отримуйте та надсилайте конфігурацію Intlayer до CMS
+
+### Управління документацією
+
+- **[Переклад документа](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/doc-translate.md)** - Автоматично перекладайте файли документації за допомогою AI
+- **[Перевірка документа](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/doc-review.md)** - Перевіряйте файли документації на якість та узгодженість
+
+### Редактор та Live Sync
+
+- **[Команди редактора](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/editor.md)** - Використовуйте команди редактора Intlayer
+- **[Команди Live Sync](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/live.md)** - Використовуйте Live Sync, щоб відображати зміни контенту CMS під час виконання
+
+### CI/CD та автоматизація
+
+- **[CI Command](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/ci.md)** - Запускайте команди Intlayer з автоматично підставленими обліковими даними для CI/CD пайплайнів
+
+### Інструменти розробки
+
+- **[CLI SDK](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/sdk.md)** - Використовуйте Intlayer CLI SDK у власному коді
+- **[Команда налагодження Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/debug.md)** - Налагоджуйте та усувайте проблеми CLI Intlayer
+
+## Використовуйте команди intlayer у вашому `package.json`
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:init": "npx intlayer init",
+  "intlayer:login": "npx intlayer login",
+  "intlayer:build": "npx intlayer build",
+  "intlayer:watch": "npx intlayer build --watch",
+  "intlayer:push": "npx intlayer push",
+  "intlayer:pull": "npx intlayer pull",
+  "intlayer:fill": "npx intlayer fill",
+  "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"
+}
+```
+
+> **Примітка**: Ви також можете використовувати коротші псевдоніми:
+>
+> - `npx intlayer list` замість `npx intlayer content list`
+> - `npx intlayer test` замість `npx intlayer content test`
+> - `npx intlayer projects-list` або `npx intlayer pl` замість `npx intlayer projects list`

package/docs/uk/cli/init.md

@@ -0,0 +1,84 @@
+---
+createdAt: 2025-12-30
+updatedAt: 2025-12-30
+title: Ініціалізація Intlayer
+description: Дізнайтесь, як ініціалізувати Intlayer у вашому проєкті.
+keywords:
+  - Ініціалізація
+  - CLI
+  - Intlayer
+  - AI
+slugs:
+  - doc
+  - concept
+  - cli
+  - init
+history:
+  - version: 7.5.9
+    date: 2025-12-30
+    changes: Додано команду init
+---
+
+# Ініціалізація Intlayer
+
+```bash
+npx intlayer init
+```
+
+Команда `init` автоматично налаштовує Intlayer у вашому проєкті, конфігуруючи необхідні файли та параметри. Це рекомендований спосіб почати роботу з `Intlayer`.
+
+## Аліаси:
+
+- `npx intlayer init`
+
+## Аргументи:
+
+- `--project-root [projectRoot]` - Опційно. Вкажіть кореневу директорію проєкту. Якщо не вказано, команда шукатиме корінь проєкту, починаючи з поточної робочої директорії.
+
+## Що робить:
+
+Команда `init` виконує такі дії з налаштування:
+
+1. **Validates project structure** - Переконується, що ви перебуваєте в дійсній директорії проекту з файлом `package.json`
+2. **Updates `.gitignore`** - Додає `.intlayer` до вашого файлу `.gitignore`, щоб виключити згенеровані файли з контролю версій
+3. **Configures TypeScript** - Оновлює всі файли `tsconfig.json`, щоб включити визначення типів Intlayer (`.intlayer/**/*.ts`)
+4. **Creates configuration file** - Генерує `intlayer.config.ts` (для проєктів на TypeScript) або `intlayer.config.mjs` (для проєктів на JavaScript) з налаштуваннями за замовчуванням
+5. **Updates Vite config** - Якщо виявлено файл конфігурації Vite, додає імпорт плагіна `vite-intlayer`
+6. **Оновлює конфігурацію Next.js** - Якщо виявлено файл конфігурації Next.js, додає імпорт плагіна `next-intlayer`
+
+## Приклади:
+
+### Базова ініціалізація:
+
+```bash
+npx intlayer init
+```
+
+Це ініціалізує Intlayer у поточному каталозі, автоматично виявляючи корінь проєкту.
+
+### Ініціалізація з користувацьким коренем проєкту:
+
+```bash
+npx intlayer init --project-root ./my-project
+```
+
+Це ініціалізує Intlayer у вказаному каталозі.
+
+## Приклад виведення:
+
+```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.
+```
+
+## Примітки:
+
+- Команда ідемпотентна - її можна безпечно запускати кілька разів. Вона пропустить кроки, які вже налаштовано.
+- Якщо файл конфігурації вже існує, він не буде перезаписаний.
+- Файли конфігурації TypeScript без масиву `include` (наприклад, конфіги у стилі solution з references) пропускаються.
+- Команда завершиться з помилкою, якщо у корені проєкту не знайдено `package.json`.

package/docs/uk/cli/list.md

@@ -0,0 +1,90 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2026-01-06
+title: Перелік файлів декларації контенту
+description: Дізнайтеся, як перерахувати всі файли декларацій контенту у вашому проєкті.
+keywords:
+  - Перелік
+  - Декларація контенту
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - list
+history:
+  - version: 7.5.12
+    date: 2026-01-06
+    changes: Додано опцію виводу абсолютних шляхів для команди list
+  - version: 7.5.11
+    date: 2026-01-06
+    changes: Додано опцію виводу у форматі JSON для команди list
+---
+
+# Перелік файлів декларації контенту
+
+```bash
+npx intlayer content list
+```
+
+## Аліаси:
+
+- `npx intlayer list`
+
+Ця команда відображає всі файли декларації контенту у вашому проєкті, показуючи їхні ключі в словнику та шляхи до файлів. Це корисно для отримання огляду всіх ваших файлів контенту та перевірки того, що Intlayer правильно їх виявляє.
+
+## Arguments:
+
+- **`--json`**: Виводити результати у форматі JSON замість відформатованого тексту. Корисно для скриптів і програмного доступу.
+
+  > Приклад: `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:
+ - home-page        - src/components/HomePage/homePage.content.ts
+ - server-component - src/components/ServerComponent/serverComponent.content.ts
+ - client-component - src/components/ClientComponent/clientComponent.content.ts
+
+Загальна кількість файлів декларації контенту: 3
+```
+
+### Вивід у форматі JSON:
+
+```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"}]
+```
+
+Ця команда виведе:
+
+- Відформатований список усіх файлів декларації контенту з їхніми ключами та відносними шляхами
+- Загальну кількість знайдених файлів декларації контенту
+
+Вивід допомагає переконатися, що всі ваші файли контенту налаштовані правильно й доступні системі Intlayer.

package/docs/uk/cli/list_projects.md

@@ -0,0 +1,128 @@
+---
+createdAt: 2025-12-30
+updatedAt: 2025-12-30
+title: Перелік проєктів Intlayer
+description: Дізнайтеся, як перелічити всі проєкти Intlayer у директорії або git-репозиторії.
+keywords:
+  - Список
+  - Проєкти
+  - CLI
+  - Intlayer
+  - Git
+slugs:
+  - doc
+  - concept
+  - cli
+  - list-projects
+history:
+  - version: 7.5.12
+    date: 2026-01-06
+    changes: Додано опцію виведення абсолютних шляхів для команди list projects
+---
+
+# Перелік проєктів Intlayer
+
+```bash
+npx intlayer projects list
+```
+
+Ця команда шукає та перераховує всі проєкти Intlayer, знаходячи каталоги, які містять конфігураційні файли Intlayer. Це корисно для виявлення всіх проєктів Intlayer у monorepo, workspace або git-репозиторії.
+
+## Псевдоніми:
+
+- `npx intlayer projects-list`
+- `npx intlayer pl`
+
+## Аргументи:
+
+- **`--base-dir [path]`**: Вкажіть базову директорію для пошуку. За замовчуванням — поточна робоча директорія.
+
+  > Приклад: `npx intlayer projects list --base-dir /path/to/workspace`
+
+- **`--git-root`**: Шукати від кореня git-репозиторію замість базової директорії. Це корисно для знаходження всіх проєктів Intlayer у монорепо або git-репозиторії.
+
+  > Приклад: `npx intlayer projects list --git-root`
+
+- **`--json`**: Вивести результати у форматі JSON замість форматованого тексту. Корисно для скриптів та програмного доступу.
+
+  > Приклад: `npx intlayer projects list --json`
+
+- **`--absolute`**: Виводити результати як абсолютні шляхи замість відносних.
+
+  > Приклад: `npx intlayer projects list --absolute`
+
+## Як це працює:
+
+Команда шукає файли конфігурації Intlayer у вказаній директорії (або в корені git, якщо використано `--git-root`). Вона шукає такі шаблони файлів конфігурації:
+
+- `intlayer.config.ts`
+- `intlayer.config.js`
+- `intlayer.config.json`
+- `intlayer.config.cjs`
+- `intlayer.config.mjs`
+- `.intlayerrc`
+
+Кожна директорія, що містить один із цих файлів, вважається проектом Intlayer і буде включена до виводу.
+
+## Приклади:
+
+### Список проектів у поточній директорії:
+
+```bash
+npx intlayer projects list
+```
+
+### Список проектів у вказаній директорії:
+
+```bash
+npx intlayer projects list --base-dir ./packages
+```
+
+### Список усіх проектів у git-репозиторії:
+
+```bash
+npx intlayer projects list --git-root
+```
+
+### Використання скороченого аліасу:
+
+```bash
+npx intlayer pl --git-root
+```
+
+### Вивід у форматі JSON:
+
+```bash
+npx intlayer projects list --json
+```
+
+## Приклад виводу:
+
+### Відформатований вивід:
+
+```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-вивід:
+
+```bash
+$ npx intlayer projects list --json
+
+["/Users/user/workspace/packages/app","/Users/user/workspace/packages/admin","/Users/user/workspace/packages/shared"]
+```
+
+## Сценарії використання:
+
+- **Управління монорепозиторієм**: Виявлення всіх проектів Intlayer у структурі монорепозиторію
+- **Виявлення проектів**: Знайти всі проекти з підтримкою Intlayer у робочому просторі
+- **CI/CD**: Перевірка проектів Intlayer у автоматизованих workflow
+- **Документація**: Генерувати документацію зі списком усіх проектів, які використовують Intlayer
+
+Вивід надає абсолютні шляхи до кожного каталогу проекту, що полегшує навігацію або автоматизацію операцій над кількома проектами Intlayer.

package/docs/uk/cli/live.md

@@ -0,0 +1,41 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Команди Live Sync
+description: Дізнайтеся, як використовувати Live Sync для відображення змін контенту CMS під час виконання.
+keywords:
+  - Live Sync
+  - CMS
+  - Runtime
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - live
+---
+
+# Команди Live Sync
+
+Live Sync дозволяє вашому застосунку відображати зміни контенту CMS під час виконання. Перебудова або повторне розгортання не потрібні. Коли увімкнено, оновлення передаються на сервер Live Sync, який оновлює словники, які читає ваш застосунок. Детальніше див. [Intlayer CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/intlayer_CMS.md).
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:live:start": "npx intlayer live start --with 'next dev --turbopack'"
+}
+```
+
+## Аргументи:
+
+**Параметри конфігурації:**
+
+- **`--base-dir`**: Вкажіть базову директорію проєкту. Щоб отримати конфігурацію intlayer, команда шукатиме файл `intlayer.config.{ts,js,json,cjs,mjs}` у базовій директорії.
+
+- **`--no-cache`**: Вимкнути кеш.
+
+  > Приклад: `npx intlayer dictionary push --env-file .env.production.local`
+
+**Параметри логування:**
+
+- **`--verbose`**: Увімкнути детальне логування для відлагодження. (за замовчуванням true у CLI)