@intlayer/docs 7.5.11 → 7.5.13

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)

package/docs/uk/cli/login.md

@@ -0,0 +1,157 @@
+---
+createdAt: 2025-12-16
+updatedAt: 2025-12-16
+title: CLI — команда login
+description: Дізнайтеся, як використовувати команду login Intlayer CLI для автентифікації в Intlayer CMS та отримання облікових даних доступу.
+keywords:
+  - CLI
+  - Login
+  - Authentication
+  - CMS
+  - Intlayer
+  - Credentials
+slugs:
+  - doc
+  - concept
+  - cli
+  - login
+---
+
+# Команда Intlayer CLI — login
+
+---
+
+## Опис
+
+Команда `login` Intlayer CLI дозволяє вам автентифікуватися в Intlayer CMS. Ця команда автоматично відкриває ваш браузер за замовчуванням для завершення процесу автентифікації та отримання необхідних облікових даних (Client ID та Client Secret) для використання сервісів Intlayer.
+
+## Використання
+
+```bash
+npx intlayer login [options]
+```
+
+або
+
+```bash
+intlayer login [options]
+```
+
+## Параметри
+
+### `--cms-url <url>`
+
+Вкажіть URL Intlayer CMS, до якого потрібно підключитися для аутентифікації.
+
+- **Тип**: `string`
+- **За замовчуванням**: Значення, вказане в `intlayer.config.*` або `https://intlayer.org`
+- **Приклад**:
+
+```bash
+npx intlayer login --cms-url https://intlayer.org
+```
+
+### Параметри конфігурації
+
+Ви також можете використовувати загальні параметри конфігурації:
+
+- `--env-file <path>`: Шлях до файлу середовища
+- `-e, --env <env>`: Середовище виконання
+- `--base-dir <dir>`: Базовий каталог проекту
+- `--verbose`: Увімкнути детальний вивід (за замовчуванням: true)
+- `--prefix <prefix>`: Префікс для логів
+
+## Як це працює
+
+1. **Запуск локального сервера**: Команда запускає локальний HTTP‑сервер на випадковому порті, щоб отримати облікові дані від CMS
+2. **Відкриття браузера**: команда автоматично відкриває ваш браузер за замовчуванням на URL для входу в CMS
+3. **Аутентифікація**: завершіть аутентифікацію в браузері, використовуючи ваш обліковий запис Intlayer
+4. **Отримання облікових даних**: локальний сервер отримує Client ID та Client Secret від CMS
+5. **Інструкції**: команда відображає інструкції щодо конфігурації облікових даних у вашому проекті
+
+## Вивід
+
+Після успішного входу команда відобразить:
+
+1. **Отримані облікові дані** (Client ID та Client Secret)
+2. **Інструкції для файлу `.env`**:
+
+```bash
+INTLAYER_CLIENT_ID=your_client_id
+INTLAYER_CLIENT_SECRET=your_client_secret
+```
+
+3. **Інструкції для файлу конфігурації Intlayer**:
+
+```typescript
+{
+  editor: {
+    cmsURL: 'https://intlayer.org',
+    clientId: process.env.INTLAYER_CLIENT_ID,
+    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+  },
+}
+```
+
+## Ручна конфігурація
+
+Якщо браузер не відкрився автоматично, ви можете вручну перейти за URL, вказаним у терміналі.
+
+## Приклади
+
+### Вхід із власною URL-адресою CMS
+
+```bash
+npx intlayer login --cms-url https://custom-cms.example.com
+```
+
+### Вхід із конкретним файлом середовища
+
+```bash
+npx intlayer login --env-file .env.production
+```
+
+### Вхід у verbose-режимі
+
+```bash
+npx intlayer login --verbose
+```
+
+## Усунення несправностей
+
+### Браузер не відкривається
+
+Якщо браузер не відкривається автоматично, скопіюйте URL, показаний у терміналі, і відкрийте його вручну у браузері.
+
+### Проблеми з підключенням
+
+Якщо виникають проблеми з підключенням, перевірте:
+
+1. Що URL CMS вказано правильно
+2. Що ваше інтернет-з'єднання працює належним чином
+3. Що жодні фаєрволи не блокують з'єднання
+
+### Облікові дані не отримано
+
+Якщо облікові дані не надійшли:
+
+1. Переконайтеся, що ви завершили процес аутентифікації в браузері
+2. Перевірте, що локальний порт не заблокований
+3. Спробуйте виконати команду ще раз
+
+## Наступні кроки
+
+Після завершення входу:
+
+1. Додайте облікові дані до вашого файлу `.env`
+2. Сконфігуруйте ваш файл `intlayer.config.*` з цими обліковими даними
+3. Використовуйте CLI-команди для керування вашими словниками:
+   - [`npx intlayer push`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/push.md) - Push dictionaries to the CMS
+   - [`npx intlayer pull`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/pull.md) - Pull dictionaries from the CMS
+   - [`npx intlayer fill`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/fill.md) - Заповнити відсутні переклади
+
+## Див. також
+
+- [Документація CLI](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/cli/index.md)
+- [Конфігурація Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/configuration.md)
+- [CMS Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/intlayer_CMS.md)

package/docs/uk/cli/pull.md

@@ -0,0 +1,78 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Отримати словники
+description: Дізнайтеся, як витягувати словники з редактора Intlayer та CMS.
+keywords:
+  - Витягування
+  - Словники
+  - CLI
+  - Intlayer
+  - Редактор
+  - CMS
+slugs:
+  - doc
+  - concept
+  - cli
+  - pull
+---
+
+# Отримання віддалених словників
+
+```bash
+npx intlayer pull
+```
+
+Якщо встановлено [редактор Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/intlayer_visual_editor.md), ви також можете витягувати словники з редактора. Таким чином ви можете перезаписати вміст ваших словників відповідно до потреб вашого застосунку.
+
+## Псевдоніми:
+
+- `npx intlayer dictionaries pull`
+- `npx intlayer dictionary pull`
+- `npx intlayer dic pull`
+
+## Аргументи:
+
+**Опції словника:**
+
+- **`-d, --dictionaries`**: Ідентифікатори словників, які потрібно витягнути. Якщо не вказано, будуть витягнуті всі словники.
+
+  > Приклад: `npx intlayer dictionary pull -d my-dictionary-id my-other-dictionary-id`
+
+- **`--dictionary`**: Ідентифікатори словників, які потрібно витягнути (аліас для --dictionaries).
+
+  > Приклад: `npx intlayer dictionary pull --dictionary my-dictionary-id my-other-dictionary-id`
+
+**Параметри конфігурації:**
+
+- **`--base-dir`**: Вказати базову директорію проекту. Щоб отримати конфігурацію intlayer, команда шукатиме файл `intlayer.config.{ts,js,json,cjs,mjs}` у базовій директорії.
+
+  > Приклад: `npx intlayer dictionary push --env-file .env.production.local`
+
+- **`--no-cache`**: Вимкнути кеш.
+
+  > Приклад: `npx intlayer build --no-cache`
+
+**Параметри змінних середовища:**
+
+- **`--env`**: Вказати середовище (наприклад, `development`, `production`).
+- **`--env-file`**: Надати власний файл середовища для завантаження змінних.
+- **`--base-dir`**: Вказати базову директорію для проекту. Щоб отримати конфігурацію intlayer, команда шукатиме файл `intlayer.config.{ts,js,json,cjs,mjs}` у базовій директорії.
+
+  > Приклад: `npx intlayer dictionary push --env-file .env.production.local`
+
+  > Приклад: `npx intlayer dictionary push --env production`
+
+**Параметри виводу:**
+
+- **`--new-dictionaries-path`** : Шлях до директорії, у якій будуть збережені нові словники. Якщо не вказано, нові словники будуть збережені в директорії `./intlayer-dictionaries` проекту. Якщо у вмісті вашого словника вказано поле `filePath`, словники не враховуватимуть цей аргумент і будуть збережені у вказаній директорії `filePath`.
+
+**Параметри логування:**
+
+- **`--verbose`**: Увімкнути детальне логування для налагодження. (за замовчуванням true у CLI)
+
+## Приклад:
+
+```bash
+npx intlayer dictionary pull --newDictionariesPath ./my-dictionaries-dir/
+```

package/docs/uk/cli/push.md

@@ -0,0 +1,98 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Push словників
+description: Дізнайтеся, як передати ваші словники до редактора Intlayer та CMS.
+keywords:
+  - Push
+  - Словники
+  - CLI
+  - Intlayer
+  - Editor
+  - CMS
+slugs:
+  - doc
+  - concept
+  - cli
+  - push
+---
+
+# Push словників
+
+```bash
+npx intlayer dictionary push
+```
+
+Якщо [intlayer editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/uk/intlayer_visual_editor.md) встановлено, ви також можете передавати словники до редактора. Ця команда дозволяє зробити словники доступними в [редакторі](https://app.intlayer.org/). Таким чином ви можете ділитися своїми словниками з командою та редагувати вміст без редагування коду вашого додатка.
+
+## Псевдоніми:
+
+- `npx intlayer dictionaries push`
+- `npx intlayer dictionary push`
+- `npx intlayer dic push`
+
+## Аргументи:
+
+**Параметри словників:**
+
+- **`-d`, `--dictionaries`**: ідентифікатори словників для завантаження (pull). Якщо не вказано, будуть відправлені всі словники.
+
+  > Example: `npx intlayer dictionary push -d my-dictionary-id my-other-dictionary-id`
+
+- **`--dictionary`**: ідентифікатори словників для завантаження (аліас для --dictionaries).
+
+  > Example: `npx intlayer dictionary push --dictionary my-dictionary-id my-other-dictionary-id`
+
+**Параметри конфігурації:**
+
+- **`--base-dir`**: Вказати базову директорію проекту. Щоб отримати конфігурацію intlayer, команда шукатиме файл `intlayer.config.{ts,js,json,cjs,mjs}` у базовій директорії.
+
+  > Example: `npx intlayer dictionary push --env-file .env.production.local`
+
+- **`--no-cache`**: Вимкнути кеш.
+
+  > Приклад: `npx intlayer build --no-cache`
+
+**Параметри змінних середовища:**
+
+- **`--env`**: Вказати оточення (наприклад, `development`, `production`). Корисно, якщо ви використовуєте змінні середовища у вашому конфігураційному файлі intlayer.
+- **`--env-file`**: Вказати власний файл змінних оточення, з якого будуть завантажені змінні. Корисно, якщо ви використовуєте змінні середовища у вашому конфігураційному файлі intlayer.
+
+  > Приклад: `npx intlayer dictionary push --env-file .env.production.local`
+
+  > Приклад: `npx intlayer dictionary push --env production`
+
+**Параметри виведення:**
+
+- **`-r`, `--delete-locale-dictionary`**: Пропустити запит, який просить видалити директорії локалей після того, як словники буде відправлено, і видалити їх. За замовчуванням, якщо словник визначено локально, він перезапише віддалений вміст словників.
+
+  > Example: `npx intlayer dictionary push -r`
+
+  > Example: `npx intlayer dictionary push --delete-locale-dictionary`
+
+- **`-k`, `--keep-locale-dictionary`**: Пропустити запит, який просить видалити директорії локалей після того, як словники буде відправлено, і зберегти їх. За замовчуванням, якщо словник визначено локально, він перезапише віддалений вміст словників.
+
+  > Example: `npx intlayer dictionary push -k`
+
+  > Example: `npx intlayer dictionary push --keep-locale-dictionary`
+
+**Параметри підготовки:**
+
+- **`--build`**: Збирати словники перед пушем, щоб забезпечити актуальність вмісту. True примусово виконає збірку, false пропустить її, undefined дозволить використовувати кеш збірки.
+
+**Log options:**
+
+- **`--verbose`**: Увімкнути детальне логування для налагодження. (за замовчуванням true при використанні CLI)
+
+**Git options:**
+
+- **`--git-diff`**: Запускати лише для словників, які містять зміни від базової ревізії (за замовчуванням `origin/main`) до поточної гілки (за замовчуванням: `HEAD`).
+- **`--git-diff-base`**: Вказати базову ревізію для git diff (за замовчуванням `origin/main`).
+- **`--git-diff-current`**: Вказати поточну ревізію для git diff (за замовчуванням `HEAD`).
+- **`--uncommitted`**: Включити незакомічені зміни.
+- **`--unpushed`**: Включити незапушені зміни.
+- **`--untracked`**: Включити невідстежувані файли.
+
+  > Приклад: `npx intlayer dictionary push --git-diff --git-diff-base origin/main --git-diff-current HEAD`
+
+  > Приклад: `npx intlayer dictionary push --uncommitted --unpushed --untracked`

package/docs/uk/cli/sdk.md

@@ -0,0 +1,71 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: SDK для CLI
+description: Дізнайтеся, як використовувати Intlayer CLI SDK у власному коді.
+keywords:
+  - SDK
+  - CLI
+  - Intlayer
+  - Програмне
+slugs:
+  - doc
+  - concept
+  - cli
+  - sdk
+---
+
+# SDK для CLI
+
+CLI SDK — це бібліотека, яка дозволяє використовувати Intlayer CLI у вашому власному коді.
+
+```bash packageManager="npm"
+npm install @intlayer/cli --save-dev
+```
+
+```bash packageManager="yarn"
+yarn add @intlayer/cli --save-dev
+```
+
+```bash packageManager="pnpm"
+pnpm add @intlayer/cli --save-dev
+```
+
+```bash packageManager="bun"
+bun add @intlayer/cli --dev
+```
+
+Приклад використання:
+
+```ts
+import {
+  push,
+  pull,
+  fill,
+  build,
+  listContentDeclaration,
+  testMissingTranslations,
+  docTranslate,
+  docReview,
+  transform,
+} from "@intlayer/cli";
+
+push();
+// ... (опущено)
+pull();
+// ... (опущено)
+fill();
+// ... (опущено)
+build();
+// ... (опущено)
+listContentDeclaration();
+// ... (опущено)
+testMissingTranslations();
+// ... (опущено)
+docTranslate();
+// ... (опущено)
+docReview();
+// ... (опущено)
+transform();
+// ... (опущено)
+```

package/docs/uk/cli/test.md

@@ -0,0 +1,76 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Перевірка відсутніх перекладів
+description: Дізнайтеся, як перевіряти та виявляти відсутні переклади у ваших словниках.
+keywords:
+  - Тест
+  - Відсутні переклади
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - test
+---
+
+# Перевірка відсутніх перекладів
+
+```bash
+npx intlayer content test
+```
+
+## Аліаси:
+
+- `npx intlayer test`
+
+Ця команда аналізує ваші файли декларацій контенту, щоб ідентифікувати відсутні переклади у всіх налаштованих locales. Вона генерує детальний звіт, який показує, яких ключів перекладу бракує для яких locales, допомагаючи вам підтримувати узгодженість у вашому багатомовному контенті.
+
+## Приклад виводу:
+
+```bash
+pnpm intlayer content test
+Відсутні переклади:
+ - home-page                      - tr         - src/components/HomePage/homePage.content.ts
+ - server-component               - es, tr     - src/components/ServerComponent/serverComponent.content.ts
+ - client-component               - pl, tr     - src/components/ClientComponent/clientComponent.content.ts
+Locales: en, ru, ja, fr, ko, zh, es, de, ar, it, en-GB, pt, hi, tr, pl
+Required locales: en
+Missing locales: pl, tr, es
+Missing required locales: -
+Total missing locales: 3
+Total missing required locales: 0
+```
+
+## Аргументи:
+
+**Параметри конфігурації:**
+
+- **`--env`**: Вкажіть середовище (наприклад, `development`, `production`).
+- **`--env-file [envFile]`**: Надайте власний файл середовища для завантаження змінних.
+- **`--base-dir`**: Вкажіть базовий каталог проекту.
+
+  > Приклад: `npx intlayer content test --base-dir ./src --env-file .env.production.local`
+
+- **`--no-cache`**: Вимкнути кеш.
+
+  > Приклад: `npx intlayer build --no-cache`
+
+**Параметри підготовки:**
+
+- **`--build`**: Побудувати словники перед відправкою, щоб переконатися, що контент актуальний. True примусить виконати збірку, false пропустить збірку, undefined дозволить використовувати кеш збірки.
+
+**Параметри логування:**
+
+- **`--verbose`**: Увімкнути детальне логування для налагодження. (за замовчуванням true при використанні CLI)
+
+  > Приклад: `npx intlayer content test --verbose`
+
+## Приклад:
+
+```bash
+npx intlayer content test --verbose
+```
+
+Вивід допомагає швидко визначити, які переклади потрібно завершити, щоб ваша програма коректно працювала у всіх налаштованих локалях.