@intlayer/docs 7.0.7 → 7.0.8-canary.0

package/docs/ru/intlayer_cli.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2024-08-11
-updatedAt: 2025-07-11
+updatedAt: 2025-01-27
 title: CLI
 description: Узнайте, как использовать Intlayer CLI для управления вашим многоязычным сайтом. Следуйте шагам в этой онлайн-документации, чтобы настроить ваш проект за несколько минут.
 keywords:
@@ -17,6 +17,30 @@ slugs:
   - concept
   - cli
 history:
+  - version: 7.1.0
+    date: 2025-11-05
+    changes: Добавлена опция skipIfExists для команды translate
+  - version: 6.1.4
+    date: 2025-01-27
+    changes: Добавлены псевдонимы для аргументов и команд 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
@@ -27,6 +51,14 @@ history:
 
 # Intlayer CLI
 
+---
+
+## Содержание
+
+<TOC/>
+
+---
+
 ## Установка пакета
 
 Установите необходимые пакеты с помощью npm:
@@ -51,7 +83,7 @@ pnpm add intlayer-cli -g
 
 Этот пакет транспилирует все файлы 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 вы можете использовать интерпретаторы, такие как [react-intlayer](https://www.npmjs.com/package/react-intlayer) или [next-intlayer](https://www.npmjs.com/package/next-intlayer)
 
 ## Поддержка конфигурационных файлов
 
@@ -68,6 +100,15 @@ Intlayer поддерживает несколько форматов конфи
 
 ## Запуск команд intlayer
 
+### Проверка версии CLI
+
+```bash
+npx intlayer --version
+npx intlayer version
+```
+
+Обе команды выводят установленную версию Intlayer CLI.
+
 ### Сборка словарей
 
 Для сборки ваших словарей вы можете выполнить команды:
@@ -90,6 +131,53 @@ npx intlayer build --watch
 - `npx intlayer dictionary build`
 - `npx intlayer dic build`
 
+##### Аргументы:
+
+- **`--base-dir`**: Укажите базовый каталог для проекта. Для получения конфигурации intlayer команда будет искать файл `intlayer.config.{ts,js,json,cjs,mjs}` в базовом каталоге.
+
+  > Пример: `npx intlayer build --base-dir ./src`
+
+- **`--env`**: Укажите окружение (например, `development`, `production`). Полезно, если вы используете переменные окружения в вашем конфигурационном файле intlayer.
+
+  > Пример: `npx intlayer build --env production`
+
+- **`--env-file`**: Укажите пользовательский файл окружения для загрузки переменных. Полезно, если вы используете переменные окружения в вашем конфигурационном файле intlayer.
+
+> Пример: `npx intlayer build --env-file .env.production.local`
+
+- **`--with`**: Запустить команду параллельно со сборкой.
+
+  > Пример: `npx intlayer build --with "next dev --turbopack"`
+
+- **`--skip-prepare`**: Пропустить шаг подготовки.
+
+  > Пример: `npx intlayer build --skip-prepare`
+
+- **`--no-cache`**: Отключить кэширование.
+
+  > Пример: `npx intlayer build --no-cache`
+
+### Наблюдение за словарями
+
+```bash
+npx intlayer watch
+```
+
+Эта команда будет отслеживать изменения в ваших файлах декларации контента и создавать словари в директории `.intlayer`.
+Эта команда эквивалентна `npx intlayer build --watch --skip-prepare`.
+
+##### Псевдонимы:
+
+- `npx intlayer dictionaries build`
+- `npx intlayer dictionary build`
+- `npx intlayer dic build`
+
+##### Аргументы:
+
+- **`--with`**: Запустить команду параллельно с watch.
+
+  > Пример: `npx intlayer watch --with "next dev --turbopack"`
+
 ### Отправка словарей
 
 ```bash
@@ -112,12 +200,20 @@ npx intlayer dictionary push
 
   > Пример: `npx intlayer dictionary push -d my-dictionary-id my-other-dictionary-id`
 
+- **`--dictionary`**: идентификаторы словарей для загрузки (псевдоним для --dictionaries).
+
+> Пример: `npx intlayer dictionary push --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`). Полезно, если вы используете переменные окружения в вашем конфигурационном файле intlayer.
@@ -143,7 +239,11 @@ npx intlayer dictionary push
 
 **Опции логирования:**
 
-- **`--verbose`**: Включить подробное логирование для отладки.
+- **`--build`**: Собирает словари перед отправкой, чтобы гарантировать актуальность содержимого. Значение true принудительно запускает сборку, false пропускает сборку, undefined позволяет использовать кэш сборки.
+
+**Параметры логирования:**
+
+- **`--verbose`**: Включить подробное логирование для отладки. (по умолчанию включено при использовании CLI)
 
 **Опции Git:**
 
@@ -180,12 +280,20 @@ npx intlayer pull
 
   > Пример: `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`).
@@ -202,7 +310,7 @@ npx intlayer pull
 
 **Опции логирования:**
 
-- **`--verbose`**: Включить подробное логирование для отладки.
+- **`--verbose`**: Включить подробное логирование для отладки. (по умолчанию включено при использовании CLI)
 
 ##### Пример:
 
@@ -236,10 +344,18 @@ npx intlayer fill
 
   > Пример: `npx intlayer dictionary fill -k key1 key2`
 
+- **`--key [keys...]`**: Фильтровать словари по ключам (псевдоним для --keys).
+
+> Пример: `npx intlayer dictionary fill --key key1 key2`
+
 - **`--excluded-keys [excludedKeys...]`**: Исключение словарей по ключам. Если не указано, будут проверены все словари.
 
   > Пример: `npx intlayer dictionary fill --excluded-keys key1 key2`
 
+- **`--excluded-key [excludedKeys...]`**: Фильтровать словари на основе ключей (псевдоним для --excluded-keys).
+
+  > Пример: `npx intlayer dictionary fill --excluded-keys key1 key2`
+
 - **`--path-filter [pathFilters...]`**: Фильтрация словарей по шаблону glob для путей к файлам.
 
   > Пример: `npx intlayer dictionary fill --path-filter "src/home/**"`
@@ -250,7 +366,7 @@ npx intlayer fill
 
 - **`--output-locales [outputLocales...]`**: Целевые локали для перевода. Если не указано, будут использованы все локали из вашей конфигурации, кроме исходной локали.
 
-- **`--mode [mode]`**: Режим перевода: 'complete' (полный), 'review' (проверка) или 'missing-only' (только отсутствующие). По умолчанию - 'missing-only'.
+- **`--mode [mode]`**: Режим перевода: `complete` (полный), `review` (проверка). По умолчанию — `complete`. Режим `complete` заполнит весь отсутствующий контент, режим `review` заполнит отсутствующий контент и проверит существующие ключи.
 
 **Опции Git:**
 
@@ -291,9 +407,19 @@ npx intlayer fill
 
   > Пример: `npx intlayer fill --base-dir ./src`
 
+- **`--no-cache`**: Отключить кэш.
+
+  > Пример: `npx intlayer build --no-cache`
+
 **Опции логирования:**
 
-- **`--verbose`**: Включить подробное логирование для отладки.
+- **`--build`**: Собирает словари перед отправкой, чтобы гарантировать актуальность содержимого. Значение true принудительно запускает сборку, false пропускает сборку, undefined позволяет использовать кэш сборки.
+
+- **`--skip-metadata`**: Пропустить заполнение отсутствующих метаданных (описание, заголовок, теги) для словарей.
+
+**Параметры логирования:**
+
+- **`--verbose`**: Включить подробное логирование для отладки. (по умолчанию включено при использовании CLI)
 
 ##### Пример:
 
@@ -303,6 +429,109 @@ npx intlayer fill --file src/home/*.content.ts --source-locale en --output-local
 
 Эта команда переведёт содержимое с английского на французский и испанский для всех файлов декларации контента в директории `src/home/`, используя модель GPT-3.5 Turbo.
 
+### Тест отсутствующих переводов
+
+```bash
+npx intlayer content test
+```
+
+##### Псевдонимы:
+
+- `npx intlayer test`
+
+Эта команда анализирует ваши файлы деклараций контента, чтобы выявить отсутствующие переводы во всех настроенных локалях. Она предоставляет подробный отчет, показывающий, какие ключи перевода отсутствуют для каких локалей, помогая вам поддерживать согласованность в вашем многоязычном контенте.
+
+##### Пример вывода:
+
+```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
+Локали: en, ru, ja, fr, ko, zh, es, de, ar, it, en-GB, pt, hi, tr, pl
+Обязательные локали: en
+Отсутствующие локали: pl, tr, es
+Отсутствующие обязательные локали: -
+Всего отсутствующих локалей: 3
+Всего отсутствующих обязательных локалей: 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
+```
+
+##### Пример вывода:
+
+```bash
+npx intlayer content list
+Файлы деклараций контента:
+ - 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
+```
+
+Эта команда просканирует все ваши файлы деклараций контента и отобразит:
+
+- Подробный список отсутствующих переводов с их ключами, отсутствующими локалями и путями к файлам
+- Итоговая статистика, включая общее количество отсутствующих локалей и отсутствующих обязательных локалей
+- Цветовое выделение для удобного выявления проблем
+
+Вывод помогает быстро определить, какие переводы необходимо завершить, чтобы ваше приложение корректно работало во всех настроенных локалях.
+
+### Файлы деклараций содержимого списков
+
+```bash
+npx intlayer content list
+```
+
+##### Псевдонимы:
+
+- `npx intlayer list`
+
+Эта команда отображает все файлы деклараций контента в вашем проекте, показывая их ключи словаря и пути к файлам. Это полезно для получения обзора всех ваших файлов контента и проверки того, что они правильно обнаружены Intlayer.
+
+##### Пример:
+
+```bash
+npx intlayer content list
+```
+
+Эта команда выведет:
+
+- Отформатированный список всех файлов деклараций контента с их ключами и относительными путями к файлам
+- Общее количество найденных файлов деклараций контента
+
+Вывод помогает вам убедиться, что все ваши файлы контента правильно настроены и доступны для системы Intlayer.
+
 ### Управление конфигурацией
 
 #### Получить конфигурацию
@@ -323,7 +552,8 @@ npx intlayer configuration get
 - **`--env`**: Указать окружение (например, `development`, `production`).
 - **`--env-file`**: Указать пользовательский файл окружения для загрузки переменных.
 - **`--base-dir`**: Указать базовый каталог проекта.
-- **`--verbose`**: Включить подробное логирование для отладки.
+- **`--verbose`**: Включить подробное логирование для отладки. (по умолчанию true при использовании CLI)
+- **`--no-cache`**: Отключить кэш.
 
 #### Отправка конфигурации
 
@@ -343,7 +573,8 @@ npx intlayer configuration push
 - **`--env`**: Указать окружение (например, `development`, `production`).
 - **`--env-file`**: Указать пользовательский файл окружения для загрузки переменных.
 - **`--base-dir`**: Указать базовый каталог проекта.
-- **`--verbose`**: Включить подробное логирование для отладки.
+- **`--verbose`**: Включить подробное логирование для отладки. (по умолчанию true при использовании CLI)
+- **`--no-cache`**: Отключить кэш.
 
 Отправляя конфигурацию, ваш проект полностью интегрируется с Intlayer CMS, что обеспечивает бесшовное управление словарями в командах.
 
@@ -385,6 +616,10 @@ npx intlayer doc translate
 
   > Пример: `npx intlayer doc translate --skip-if-modified-after "2025-12-05"`
 
+- **`--skip-if-exists`**: Пропустить файл, если он уже существует.
+
+> Пример: `npx intlayer doc translate --skip-if-exists`
+
 **Опции вывода:**
 
 - **`--locales [locales...]`**: Целевые локали для перевода документации.
@@ -408,7 +643,7 @@ npx intlayer doc translate
 - **`--temperature [temperature]`**: Параметр температуры для модели ИИ.
 - **`--api-key [apiKey]`**: Предоставьте собственный API-ключ для сервиса ИИ.
 - **`--application-context [applicationContext]`**: Предоставьте дополнительный контекст для перевода ИИ.
-- **`--custom-prompt [prompt]`**: Настроить базовый запрос, используемый для перевода. (Примечание: для большинства случаев рекомендуется использовать опцию `--custom-instructions`, так как она обеспечивает лучший контроль над поведением перевода.)
+- **`--custom-prompt [prompt]`**: Настройте базовый запрос, используемый для перевода. (Примечание: для большинства случаев рекомендуется использовать опцию `--custom-instructions`, так как она обеспечивает лучший контроль над поведением перевода.)
 
   > Пример: `npx intlayer doc translate --model deepseek-chat --provider deepseek --temperature 0.5 --api-key sk-1234567890 --application-context "Моё приложение - магазин для кошек"`
 
@@ -417,12 +652,13 @@ npx intlayer doc translate
 - **`--env`**: Указать окружение (например, `development`, `production`).
 - **`--env-file [envFile]`**: Указать пользовательский файл окружения для загрузки переменных.
 - **`--base-dir`**: Указать базовую директорию проекта.
+- **`--no-cache`**: Отключить кэш.
 
   > Пример: `npx intlayer doc translate --base-dir ./docs --env-file .env.production.local`
 
 **Опции логирования:**
 
-- **`--verbose`**: Включить подробное логирование для отладки.
+- **`--verbose`**: Включить подробное логирование для отладки. (по умолчанию включено при использовании CLI)
 
   > Пример: `npx intlayer doc translate --verbose`
 
@@ -433,7 +669,7 @@ npx intlayer doc translate
   - Может быть относительное время в миллисекундах `1 * 60 * 60 * 1000` (1 час)
   - Эта опция проверяет время обновления файла с помощью метода `fs.stat`. Поэтому она может быть затронута Git или другими инструментами, которые изменяют файл.
 
-  > Пример: `npx intlayer doc translate --custom-instructions "Избегайте перевода URL и сохраняйте формат markdown"`
+  > Пример: `npx intlayer doc translate --custom-instructions "Avoid translating urls, and keep the markdown format"`
 
   > Пример: `npx intlayer doc translate --custom-instructions "$(cat ./instructions.md)"`
 
@@ -450,15 +686,15 @@ npx intlayer doc translate
 
   > Пример: `npx intlayer doc translate --uncommitted --unpushed --untracked`
 
-> Обратите внимание, что путь выходного файла будет определяться заменой следующих шаблонов
->
-> - `/{{baseLocale}}/` заменяется на `/{{locale}}/` (Unix)
-> - `\{{baseLocale}}\` заменяется на `\{{locale}}\` (Windows)
-> - `_{{baseLocale}}.` заменяется на `_{{locale}}.`
-> - `{{baseLocale}}_` заменяется на `{{locale}}_`
-> - `.{{baseLocaleName}}.` заменяется на `.{{localeName}}.`
->
-> Если шаблон не найден, к расширению файла будет добавлено `.{{locale}}`. Например, `./my/file.md` будет переведён в `./my/file.fr.md` для французской локали.
+Обратите внимание, что путь выходного файла будет определяться заменой следующих шаблонов
+
+- `/{{baseLocale}}/` на `/{{locale}}/` (Unix)
+- `\{{baseLocale}}\` на `\{{locale}}\` (Windows)
+- `_{{baseLocale}}.` на `_{{locale}}.`
+- `{{baseLocale}}_` на `{{locale}}_`
+- `.{{baseLocaleName}}.` на `.{{localeName}}.`
+
+Если шаблон не найден, к расширению файла будет добавлено `.{{locale}}`. Например, `./my/file.md` будет преобразован в `./my/file.fr.md` для французской локали.
 
 #### Проверка документации
 
@@ -475,7 +711,7 @@ npx intlayer doc review
 - предпочтительно использовать `doc translate`, когда переведённая версия этого файла недоступна.
 - предпочтительно использовать `doc review`, когда переведённая версия этого файла уже существует.
 
-> Обратите внимание, что процесс проверки (review) потребляет больше входных токенов, чем процесс перевода (translate) для полной проверки одного и того же файла. Однако процесс проверки оптимизирует проверяемые части (чанки) и пропускает неизменённые участки.
+Обратите внимание, что процесс проверки (review) потребляет больше входных токенов, чем процесс перевода (translate) для полной проверки одного и того же файла. Однако процесс проверки оптимизирует проверяемые части (чанки) и пропускает неизменённые участки.
 
 ##### Аргументы:
 
@@ -497,9 +733,52 @@ npx intlayer doc review
 }
 ```
 
+> **Примечание**: Вы также можете использовать более короткие псевдонимы:
+>
+> - `npx intlayer list` вместо `npx intlayer content list`
+> - `npx intlayer test` вместо `npx intlayer content test`
+
+### Команды редактора
+
+Команда `editor` оборачивает команды `intlayer-editor`.
+
+> Чтобы использовать команду `editor`, необходимо установить пакет `intlayer-editor`. (См. [Intlayer Visual Editor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_visual_editor.md))
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:editor:start": "npx intlayer editor start --with 'next dev --turbopack'"
+}
+```
+
+### Команды Live Sync
+
+Live Sync позволяет вашему приложению отражать изменения контента CMS в режиме реального времени. Не требуется повторная сборка или повторный деплой. При включении обновления передаются на сервер Live Sync, который обновляет словари, используемые вашим приложением. Подробнее смотрите в разделе [Intlayer CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/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)
+
+---
+
 ## CLI SDK
 
-CLI SDK - это библиотека, которая позволяет использовать Intlayer CLI в вашем собственном коде.
+CLI SDK — это библиотека, которая позволяет использовать Intlayer CLI в вашем собственном коде.
 
 ```bash packageManager="npm"
 npm install @intlayer/cli --save-dev