@intlayer/docs 7.5.12 → 7.5.14

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
+```
+
+Вивід допомагає швидко визначити, які переклади потрібно завершити, щоб ваша програма коректно працювала у всіх налаштованих локалях.

package/docs/uk/cli/transform.md

@@ -0,0 +1,65 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Трансформувати компоненти
+description: Дізнайтеся, як трансформувати існуючі компоненти для використання Intlayer.
+keywords:
+  - Трансформація
+  - Компоненти
+  - Міграція
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - transform
+---
+
+# Трансформувати компоненти
+
+```bash
+npx intlayer transform
+```
+
+Ця команда аналізує ваші файли коду, щоб допомогти перенести існуючі компоненти на Intlayer. Вона підтримує інтерактивний вибір файлів або вказання конкретних файлів.
+
+## Аліаси:
+
+- `npx intlayer trans`
+
+## Параметри:
+
+**Опції вибору файлів:**
+
+- **`-f, --file [files...]`**: Список конкретних файлів для трансформації. Якщо не вказано, CLI просканує файли, що відповідають шаблону (`**/*.{tsx,jsx,vue,svelte,ts,js}`) і запропонує вам вибрати, які з них трансформувати.
+
+  > Приклад: `npx intlayer transform -f src/components/MyComponent.tsx`
+
+**Параметри виводу:**
+
+- **`-o, --output-content-declarations [outputContentDeclarations]`**: Каталог для збереження згенерованих файлів декларацій контенту.
+
+  > Приклад: `npx intlayer transform -o src/content`
+
+- **`--code-only`**: Трансформувати лише код компоненту (не записувати декларацію контенту).
+
+  > Приклад: `npx intlayer transform --code-only`
+
+- **`--declaration-only`**: Лише згенерувати декларацію контенту (не переписувати компонент).
+
+  > Приклад: `npx intlayer transform --declaration-only`
+
+**Параметри конфігурації:**
+
+- **`--base-dir`**: Вказати базовий каталог для проєкту.
+- **`--env`**: Вказати середовище.
+- **`--env-file`**: Надати власний файл середовища.
+- **`--verbose`**: Увімкнути детальне логування.
+
+**Необхідні плагіни:**
+
+Команда transform працює без додаткових плагінів для файлів TypeScript / JSX. Однак для проектів на Vue та Svelte потрібно встановити наступні плагіни:
+
+- **`@intlayer/vue-transformer`**: Для файлів Vue.
+- **`@intlayer/svelte-transformer`**: Для файлів Svelte.

package/docs/uk/cli/version.md

@@ -0,0 +1,24 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Перевірка версії CLI
+description: Дізнайтеся, як перевірити встановлену версію Intlayer CLI.
+keywords:
+  - Версія
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - version
+---
+
+# Перевірка версії CLI
+
+```bash
+npx intlayer --version
+npx intlayer version
+```
+
+Обидві команди виводять встановлену версію Intlayer CLI.

package/docs/uk/cli/watch.md

@@ -0,0 +1,37 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Відстеження словників
+description: Дізнайтеся, як відстежувати зміни у ваших файлах декларації контенту та автоматично створювати словники.
+keywords:
+  - Відстеження
+  - Словники
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - watch
+---
+
+# Відстеження словників
+
+```bash
+npx intlayer watch
+```
+
+Ця команда відстежуватиме зміни у ваших файлах декларації контенту та автоматично створюватиме словники в каталозі `.intlayer`.
+Ця команда еквівалентна `npx intlayer build --watch --skip-prepare`.
+
+## Псевдоніми:
+
+- `npx intlayer dictionaries watch`
+- `npx intlayer dictionary watch`
+- `npx intlayer dic watch`
+
+## Аргументи:
+
+- **`--with`**: Запускає команду паралельно з відстеженням.
+
+  > Приклад: `npx intlayer watch --with "next dev --turbopack"`