opensource/nocobase
3
0
Fork 0
mirror of https://github.com/nocobase/nocobase.git synced 2026-08-30 16:56:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update Russian documentation translation

Browse Source
This commit is contained in:
Andrey Sembaev
2026-07-01 12:20:06 +03:00
committed by chenos
parent 7051ec39e2
commit b66925820d
110 changed files with 1384 additions and 932 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/ru/ai-employees/configuration/admin-configuration.md
+2 -2
View File
@@ -32,7 +32,7 @@ AI-сотрудники разделены на два уровня: **«Опр
* Роль остается неизменной, но сотрудник может справляться с различными сценариями
* Обновление или замена задач не влияет на самого сотрудника
* Контекст и задачи независимы друг от друга, что упрощает обслуживание
* Описание и задачи независимы, благодаря чему обслуживание проще
## II. Процесс настройки (5 шагов)
@@ -337,4 +337,4 @@ AI-сотрудники разделены на два уровня: **«Опр
3. Достаточно ли четкий промпт
4. Ясна ли цель задачи
Двигаясь последовательно, вы сможете создать по-настоящему эффективную AI-команду.
Двигаясь последовательно, вы сможете создать по-настоящему эффективную AI-команду.
docs/docs/ru/ai-employees/features/mcp.md
+8 -8
View File
@@ -1,18 +1,18 @@
---
pkg: "@nocobase/plugin-ai"
title: "Подключение AI-сотрудника к MCP"
description: "Подключите MCP-сервис к AI-сотруднику, проверьте доступность MCP-сервиса и управляйте правами вызова инструментов MCP."
keywords: "Навыки AI-сотрудника,MCP,Model Context Protocol,tools"
title: "Подключение ИИ-сотрудника к MCP"
description: "Подключите MCP-сервис к ИИ-сотруднику, проверьте доступность MCP-сервиса и управляйте правами вызова инструментов MCP."
keywords: "Навыки ИИ-сотрудника,MCP,Model Context Protocol,инструменты"
---
# Подключение MCP
AI-сотрудники могут подключаться к MCP-сервисам, реализующим протокол Model Context Protocol (MCP). После подключения MCP-сервиса AI-сотрудник сможет использовать предоставляемые им инструменты для выполнения задач.
ИИ-сотрудники могут подключаться к MCP-сервисам, реализующим протокол Model Context Protocol (MCP). После подключения MCP-сервиса ИИ-сотрудник сможет использовать предоставляемые им инструменты для выполнения задач.
## Конфигурация MCP
## Настройка MCP
В модуле конфигурации MCP можно добавлять новые MCP-сервисы и управлять уже подключёнными.
В модуле настройки MCP можно добавлять новые MCP-сервисы и управлять уже подключёнными.
![20260323095943](https://static-docs.nocobase.com/20260323095943.png)
@@ -59,12 +59,12 @@ Docker-образ NocoBase поддерживает только команды
Нажмите кнопку `Просмотр` в списке MCP-сервисов, чтобы увидеть список инструментов, предоставляемых MCP-сервисом.
В списке инструментов MCP-сервиса также можно настроить права использования инструмента AI-сотрудником: при значении `Ask` перед вызовом будет запрашиваться подтверждение; при значении `Allow` инструмент будет вызываться напрямую при необходимости.
В списке инструментов MCP-сервиса также можно настроить права использования инструмента ИИ-сотрудником: `Спросить` — запрос подтверждения перед вызовом; `Разрешить` — прямой вызов при необходимости.
![20260323111106](https://static-docs.nocobase.com/20260323111106.png)
## Использование MCP-сервиса
После включения нужного MCP-сервиса в модуле конфигурации MCP, при общении с AI-сотрудником, он будет автоматически использовать инструменты, предоставляемые MCP-сервисом, для выполнения задач.
После включения нужного MCP-сервиса в модуле настройки MCP при общении с ИИ-сотрудником он будет автоматически использовать инструменты, предоставляемые MCP-сервисом, для выполнения задач.
![20260323110535](https://static-docs.nocobase.com/20260323110535.png)
docs/docs/ru/ai-employees/features/model-settings.md
+22 -22
View File
@@ -1,70 +1,70 @@
---
title: 'Настройка моделей AI-сотрудников'
description: 'Настройка моделей AI-сотрудников.'
title: 'Настройка моделей ИИ-сотрудников'
description: 'Настройка моделей ИИ-сотрудников.'
keywords: 'AI Employee model settings,dedicated model,model scope,LLM service,NocoBase AI'
---
# Настройка моделей AI-сотрудников
# Настройка моделей ИИ-сотрудников
По умолчанию AI-сотрудники могут использовать все включенные LLM-сервисы и модели. Администраторы могут включить выделенные настройки модели для конкретного сотрудника и ограничить набор моделей.
По умолчанию ИИ-сотрудники могут использовать все включённые службы языковой модели и модели. Администраторы могут включить настройки выделенной модели для конкретного сотрудника и ограничить набор моделей.
## Предварительные условия
## Предварительная подготовка
- Плагин **AI Employees** включен.
- Настроен хотя бы один LLM-сервис.
- Целевой AI-сотрудник включен.
- Плагин **ИИ-сотрудники** включён.
- Настроена хотя бы одна служба языковой модели.
- Целевой ИИ-сотрудник включён.
Настройку LLM-сервиса см. [Настройка LLM-сервиса](/ai-employees/features/llm-service).
Настройку службы языковой модели см. [Настройка службы языковой модели](/ai-employees/features/llm-service).
## Точки входа
Перейдите в `System Settings -> AI Employees -> AI employees`, откройте нужного сотрудника и переключитесь на `Model settings`.
Перейдите в `Настройки системы -> ИИ-сотрудники -> ИИ-сотрудники`, откройте нужного сотрудника и переключитесь на `Настройки модели`.
![](https://static-docs.nocobase.com/202605121216415.png)
## Включение настроек выделенной модели
После включения `Enable dedicated model configuration` выберите разрешенные модели в `Models`.
После включения `Включить настройку выделенной модели` выберите разрешённые модели в `Модели`.
- Переключатель модели в чате показывает только выбранные модели.
- Быстрые задачи и workflow-узлы могут использовать только выбранные модели.
- Быстрые задачи и узлы рабочего процесса могут использовать только выбранные модели.
:::info{title=Совет}
Если выделенные настройки активны, но модель не выбрана, доступная модель не будет определена.
Если настройки выделенной модели активны, но модель не выбрана, доступная модель не будет определена.
:::
## Отключение настроек выделенной модели
После отключения снова применяются правила по умолчанию:
- Можно использовать все включенные LLM-модели.
- Можно использовать все включённые модели языковой модели.
- Без ручного выбора система использует глобальную модель по умолчанию.
## Правила выбора модели
При выполнении задачи итоговая модель выбирается в таком порядке:
1. Если выделенные настройки модели включены, сначала выбирать модель в пределах выбранного диапазона.
1. Если настройки выделенной модели включены, сначала выбирать модель в пределах выбранного диапазона.
2. Если запрос указывает модель и она разрешена, использовать эту модель.
3. Если указанная модель не разрешена, использовать первую разрешенную модель.
4. Если выделенные настройки не включены, предпочитать модель, указанную в запросе.
3. Если указанная модель не разрешена, использовать первую разрешённую модель.
4. Если настройки выделенной модели не включены, предпочитать модель, указанную в запросе.
5. Если модель не указана, использовать глобальную модель по умолчанию.
## Рекомендации
- Если локальное развертывание невозможно, выбирайте специализированную переводческую модель, а не обычную чат-модель.
- Если локальное развёртывание невозможно, выбирайте специализированную переводческую модель, а не обычную чат-модель.
- Параллелизм можно настраивать по возможностям модели для управления пропускной способностью, временем ответа и стоимостью.
## FAQ
## Частые вопросы
### Почему список моделей пуст?
Обычно LLM-сервис не настроен или модель не включена. Проверьте `Enabled Models`.
Обычно служба языковой модели не настроена или модель не включена. Проверьте `Включенные модели`.
### Почему пользователи не могут переключаться на другие модели?
При включенных выделенных настройках доступен только выбранный диапазон моделей.
При включённых настройках выделенной модели доступен только выбранный диапазон моделей.
### Какие записи затрагиваются?
Затрагивает новые чаты, быстрые задачи, workflow-узлы AI Employee и встроенные задачи плагина. Исторические сообщения не пересоздаются.
Затрагивает новые чаты, быстрые задачи, узлы рабочего процесса с ИИ-сотрудником и встроенные задачи плагина. Исторические сообщения не пересоздаются.
docs/docs/ru/ai-employees/features/skills.md
+13 -13
View File
@@ -1,13 +1,13 @@
---
pkg: '@nocobase/plugin-ai'
title: 'Использование навыков AI-сотрудником'
description: 'Skills (навыки) — это руководства по экспертным знаниям для AI-сотрудника: General skills и Employee-specific skills.'
keywords: 'Навыки AI-сотрудника,Skills,NocoBase'
title: 'Использование навыков ИИ-сотрудником'
description: 'Навыки — это руководства по экспертным знаниям для ИИ-сотрудника: общие навыки и навыки, специфичные для сотрудника.'
keywords: 'Навыки ИИ-сотрудника,Skills,NocoBase'
---
# Использование навыков
Skills (навыки) — это руководства по экспертным знаниям, предоставляемые AI-сотруднику, которые помогают ему использовать несколько инструментов для решения задач в специализированных областях.
Навыки — это руководства по экспертным знаниям, предоставляемые ИИ-сотруднику, которые помогают ему использовать несколько инструментов для решения задач в специализированных областях.
В настоящее время навыки не поддерживают пользовательскую настройку и предустановлены системой.
@@ -15,8 +15,8 @@ Skills (навыки) — это руководства по экспертны
Страница навыков делится на две категории:
1. `General skills`: общие для всех AI-сотрудников, обычно доступны только для чтения.
2. `Employee-specific skills`: индивидуальные для текущего сотрудника.
1. `Общие навыки`: общие для всех ИИ-сотрудников, обычно доступны только для чтения.
2. `Навыки, специфичные для сотрудника`: индивидуальные для текущего сотрудника.
![](https://static-docs.nocobase.com/202604230832639.png)
@@ -26,14 +26,14 @@ Skills (навыки) — это руководства по экспертны
| Название навыка | Описание функций |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
| Data metadata | Получение метаданных модели данных системы, информации о таблицах данных и полях, что помогает AI-сотруднику понять контекст бизнеса. |
| Data query | Запросы к данным таблиц с поддержкой фильтрации по условиям, агрегатных запросов и других функций, помогает AI-сотруднику получать бизнес-данные. |
| Business analysis report | Генерация аналитических отчётов на основе бизнес-данных с поддержкой многомерного анализа и визуализации, помогает AI-сотруднику получать бизнес-инсайты. |
| Document search | Поиск и чтение предустановленного контента документации, помогает AI-сотруднику выполнять работу на основе документации, в настоящее время в основном для написания JS-кода. |
| Метаданные данных | Получение метаданных модели данных системы, информации о коллекциях и полях, что помогает ИИ-сотруднику понять контекст бизнеса. |
| Запрос данных | Запросы к данным коллекций с поддержкой фильтрации по условиям, агрегатных запросов и других функций, помогает ИИ-сотруднику получать бизнес-данные. |
| Бизнес-аналитический отчёт | Генерация аналитических отчётов на основе бизнес-данных с поддержкой многомерного анализа и визуализации, помогает ИИ-сотруднику получать бизнес-инсайты. |
| Поиск по документации | Поиск и чтение предустановленного контента документации, помогает ИИ-сотруднику выполнять работу на основе документации, в настоящее время в основном для написания JS-кода. |
### Специализированные навыки
### Навыки, специфичные для сотрудника
| Название навыка | Описание функций | Принадлежащий сотрудник |
| ------------------ | -------------------------------------------------------------- | ----------------------- |
| Data modeling | Навык моделирования данных, понимание и построение бизнес-моделей данных | Orin |
| Frontend developer | Написание и тестирование JS-кода для фронтенд-блоков | Nathan |
| Моделирование данных | Навык моделирования данных, понимание и построение бизнес-моделей данных | Orin |
| Разработчик фронтенда | Написание и тестирование JS-кода для фронтенд-блоков | Nathan |
docs/docs/ru/ai-employees/features/task.md
+1 -1
View File
@@ -38,4 +38,4 @@
После настройки задач они будут отображаться во всплывающем окне профиля AI-сотрудника и в приветственном сообщении перед началом диалога. Нажмите на задачу, чтобы запустить её выполнение.
![clipboard-image-1771913319](https://static-docs.nocobase.com/clipboard-image-1771913319.png)
![clipboard-image-1771913319](https://static-docs.nocobase.com/clipboard-image-1771913319.png)
docs/docs/ru/ai-employees/scenarios/business-report.md
+5 -5
View File
@@ -1,21 +1,21 @@
---
pkg: '@nocobase/plugin-ai'
title: 'Создание бизнес-аналитического отчёта'
title: 'Создание аналитического бизнес-отчёта'
---
# Создание бизнес-аналитического отчёта
На примере CRM-системы из онлайн-DEMO рассмотрим, как AI-сотрудник анализирует данные о клиентах и заказах в системе и создаёт аналитический отчёт.
На примере CRM-системы из онлайн-демо рассмотрим, как ИИ-сотрудник анализирует данные о клиентах и заказах в системе и создаёт аналитический отчёт.
## Загрузка навыков
Сначала AI-сотрудник загружает соответствующие навыки и приступает к работе.
Сначала ИИ-сотрудник загружает соответствующие навыки и приступает к работе.
![](https://static-docs.nocobase.com/202604230924035.png)
## Анализ модели данных
## Анализ моделей данных
Получение источника данных и метаинформации о таблицах данных.
Получение источников данных и метаданных коллекций.
![](https://static-docs.nocobase.com/202604230926297.png)
docs/docs/ru/ai-employees/scenarios/localization-hy-mt.md
+37 -37
View File
@@ -1,13 +1,13 @@
---
pkg: '@nocobase/plugin-ai'
title: 'Использование Lina и локального HY-MT1.5-1.8B для перевода записей локализации'
description: 'Разверните модель перевода HY-MT1.5 GGUF через llama-server и настройте ее для пакетного перевода записей локализации NocoBase с помощью Lina.'
description: 'Разверните модель перевода HY-MT1.5 GGUF через llama-server и настройте её для пакетного перевода записей локализации NocoBase с помощью Lina.'
keywords: 'Lina,localization,HY-MT,GGUF,llama-server,OpenAI compatible,AI translation,NocoBase'
---
# Использование Lina и локального HY-MT1.5-1.8B для перевода записей локализации
В этом руководстве описан практический сценарий локализации: локально развернуть небольшую специализированную модель перевода, открыть ее как OpenAI-совместимый сервис и настроить Lina для пакетного перевода записей локализации NocoBase.
В этом руководстве описан практический сценарий локализации: локально развернуть небольшую специализированную модель перевода, открыть её как OpenAI-совместимый сервис и настроить Lina для пакетного перевода записей локализации NocoBase.
Подход подходит для множества системных записей, текстов плагинов, меню, названий коллекций и подписей полей. В отличие от онлайн-моделей, локальные модели не зависят от внешних лимитов RPM, TPM и параллельности, а параллельность можно настраивать по возможностям машины и модели.
@@ -17,18 +17,18 @@ keywords: 'Lina,localization,HY-MT,GGUF,llama-server,OpenAI compatible,AI transl
- Модель: `tencent/HY-MT1.5-1.8B-GGUF`
- Сервис инференса: `llama-server`
- Интеграция: OpenAI-compatible API
- AI Employee: Lina
- Точка входа: страница Localization Management
- Интеграция: OpenAI-совместимый API
- ИИ-сотрудник: Lina
- Точка входа: страница управления локализацией
:::info{title=Примечание}
HY-MT1.5-1.8B — небольшая специализированная модель перевода. Она лучше подходит для коротких записей, UI-текстов и пакетного перевода. Общие чат-модели не рекомендуется выбирать первыми для задач локализации.
:::
## Предварительные условия
## Предварительная подготовка
- Плагин **Localization Management** включен.
- Целевой язык включен.
- Плагин **Управление локализацией** включён.
- Целевой язык включён.
- Записи локализации синхронизированы.
- Локальная машина или сервер может запускать [`llama-server`](https://github.com/ggml-org/llama.cpp).
- Сервис NocoBase может обращаться к HTTP-адресу `llama-server`.
@@ -100,19 +100,19 @@ curl http://127.0.0.1:8000/v1/chat/completions \
Если запрос долго не отвечает, модель может быть слишком медленной, параллельность слишком высокой или контекст слишком большим. Сначала уменьшите `-np` и параллельность перевода NocoBase, затем наблюдайте время ответа.
:::
## Настройка LLM-сервиса в NocoBase
## Настройка службы языковой модели в NocoBase
Перейдите в `System Settings -> AI Employees -> LLM service` и добавьте LLM-сервис.
Перейдите в `Настройки системы -> ИИ-сотрудники -> Служба языковой модели` и добавьте службу языковой модели.
| Настройка | Пример |
| --- | --- |
| Provider | OpenAI (completions) |
| Title | HY-MT Local |
| Base URL | `http://127.0.0.1:8000/v1` |
| API Key | Если `llama-server` не использует аутентификацию, укажите фиктивное значение, например `dummy`. |
| Enabled Models | Выберите `tencent/HY-MT1.5-1.8B-GGUF:Q4_K_M` или введите фактическое имя модели. |
| Провайдер | OpenAI (completions) |
| Заголовок | HY-MT Local |
| Базовый URL | `http://127.0.0.1:8000/v1` |
| Ключ API | Если `llama-server` не использует аутентификацию, укажите фиктивное значение, например `dummy`. |
| Включенные модели | Выберите `tencent/HY-MT1.5-1.8B-GGUF:Q4_K_M` или введите фактическое имя модели. |
После настройки используйте `Test flight`, чтобы проверить модель.
После настройки используйте `Тест запуска`, чтобы проверить модель.
:::info{title=Совет}
Если NocoBase запущен в Docker, `127.0.0.1` указывает на сам контейнер и может не обращаться к сервису на хосте. Используйте IP хоста, адрес контейнерной сети или `host.docker.internal`.
@@ -120,15 +120,15 @@ curl http://127.0.0.1:8000/v1/chat/completions \
## Настройка выделенной модели Lina
Перейдите в `System Settings -> AI Employees -> AI employees`, откройте Lina и перейдите в `Model settings`.
Перейдите в `Настройки системы -> ИИ-сотрудники -> ИИ-сотрудники`, откройте Lina и перейдите в `Настройки модели`.
1. Включите `Enable dedicated model configuration`.
2. Выберите локальную модель HY-MT в `Models`.
1. Включите `Включить настройку выделенной модели`.
2. Выберите локальную модель HY-MT в `Модели`.
3. Сохраните конфигурацию.
После этого Lina будет использовать эту модель для задач перевода локализации и не будет переключаться на общие чат-модели.
Подробнее см. [Настройка моделей AI Employee](/ai-employees/features/model-settings).
Подробнее см. [Настройка моделей ИИ-сотрудников](/ai-employees/features/model-settings).
## Настройка параллельности перевода
@@ -153,30 +153,30 @@ AI_LOCALIZATION_CONCURRENCY=10
4. Увеличивайте постепенно только при стабильной работе.
:::warning{title=Примечание}
Не задавайте слишком высокую параллельность сразу. Если она превышает реальную емкость модели, задачи могут замедлиться из-за очередей, таймаутов или зависания сервиса.
Не задавайте слишком высокую параллельность сразу. Если она превышает реальную ёмкость модели, задачи могут замедлиться из-за очередей, таймаутов или зависания сервиса.
:::
## Запуск перевода локализации
Перейдите в `System Management -> Localization Management`.
Перейдите в `Управление системой -> Управление локализацией`.
1. Переключитесь на целевой язык.
2. Нажмите `Synchronize`, чтобы убедиться, что записи синхронизированы.
2. Нажмите `Синхронизировать`, чтобы убедиться, что записи синхронизированы.
3. Нажмите аватар Lina.
4. Выберите область задачи:
- `Incremental translation`: переводит записи, у которых еще нет перевода.
- `Selected translation`: переводит выбранные записи в таблице.
- `Full translation`: переводит все записи текущего языка.
- `Инкрементальный перевод`: переводит записи, у которых ещё нет перевода.
- `Перевод выбранных записей`: переводит выбранные записи в таблице.
- `Полный перевод`: переводит все записи текущего языка.
5. Проверьте число записей, провайдера и модель в диалоге подтверждения.
6. Если выбран инкрементальный или полный перевод, выберите область перевода:
- `All`
- `Built-in entries`: системные и плагинные записи.
- `Custom entries`: названия маршрутов, коллекций и полей, а также UI-контент.
- `Все`
- `Встроенные записи`: системные и плагинные записи.
- `Пользовательские записи`: названия маршрутов, коллекций и полей, а также UI-контент.
7. При необходимости настройте языки справочного перевода. Для инкрементального и полного перевода справочные языки настраиваются отдельно для встроенных и пользовательских записей; перевод выбранных элементов показывает только одну общую настройку справочных языков.
8. Подтвердите создание асинхронной задачи.
9. Дождитесь завершения, проверьте переводы и опубликуйте.
Сначала используйте `Selected translation` для нескольких записей, чтобы проверить стиль вывода и скорость, затем запускайте инкрементальный или полный перевод.
Сначала используйте `Перевод выбранных записей` для нескольких записей, чтобы проверить стиль вывода и скорость, затем запускайте инкрементальный или полный перевод.
## Как Lina формирует запросы перевода
@@ -188,7 +188,7 @@ Lina формирует запросы из записей и эталонных
- Система сначала использует справочный перевод на языке по умолчанию. Если его нет, она пробует резервный язык.
- Результаты записываются в целевой язык, но не публикуются автоматически.
Семантика prompt примерно следующая:
Семантика промпта примерно следующая:
```text
Refer to the following translation:
@@ -213,26 +213,26 @@ Translate the following text into {target_language}. Output only the translated
### Модель возвращает объяснения вместо переводов
Локальные модели перевода обычно стабильнее общих чат-моделей. Если объяснения все еще появляются, сначала проверьте тот же prompt через `curl`, чтобы понять стиль вывода модели. Также можно начать с более коротких записей или снизить параметры sampling, например temperature.
Локальные модели перевода обычно стабильнее общих чат-моделей. Если объяснения всё ещё появляются, сначала проверьте тот же промпт через `curl`, чтобы понять стиль вывода модели. Также можно начать с более коротких записей или снизить параметры sampling, например temperature.
### NocoBase не может подключиться к сервису модели
Проверьте:
- Содержит ли Base URL `/v1`.
- Содержит ли базовый URL `/v1`.
- Может ли среда выполнения NocoBase обратиться к адресу.
- Не блокирует ли порт firewall или контейнерная сеть.
- Продолжает ли работать `llama-server`.
## Проверка перед публикацией
После завершения AI-перевода проверьте результат перед публикацией:
После завершения ИИ-перевода проверьте результат перед публикацией:
- Отфильтруйте по модулю и проверьте короткие записи: меню, кнопки, имена полей и статусы.
- Проверьте переменные, placeholders, HTML-теги и символы форматирования.
- Проверьте переменные, заполнители, HTML-теги и символы форматирования.
- Проверьте согласованность ключевых бизнес-терминов.
- Если переводы встроенных записей были перезаписаны, повторно синхронизируйте в Localization Management и выберите `Reset system built-in entry translations`, чтобы восстановить значения по умолчанию. Чтобы внести переводы по умолчанию для системы и официальных плагинов, см. [Translation Contribution](/get-started/translations).
- Сначала публикуйте в тестовой среде, затем синхронизируйте в production.
- Если переводы встроенных записей были перезаписаны, повторно синхронизируйте в управлении локализацией и выберите `Сбросить переводы встроенных системных записей`, чтобы восстановить значения по умолчанию. Чтобы внести переводы по умолчанию для системы и официальных плагинов, см. [Вклад в переводы](/get-started/translations).
- Сначала публикуйте в тестовой среде, затем синхронизируйте в производственное окружение.
## Ссылки
docs/docs/ru/ai-employees/workflow/nodes/employee/approval.md
+8 -8
View File
@@ -1,31 +1,31 @@
# Согласование узла
# Узел согласования
## Уведомление
После срабатывания узла AI-сотрудника в рабочем процессе настроенные в узле согласующие лица увидят красную точку-индикатор у точки входа AI-сотрудников на главной странице.
После срабатывания узла ИИ-сотрудника в рабочем процессе настроенные в узле согласующие лица увидят красную точку-индикатор у точки входа ИИ-сотрудников на главной странице.
![20260420171416](https://static-docs.nocobase.com/20260420171416.png)
В списке диалогов с AI-сотрудником можно увидеть задачи рабочего процесса, ожидающие согласования.
В списке диалогов с ИИ-сотрудником можно увидеть задачи рабочего процесса, ожидающие согласования.
![20260420171642](https://static-docs.nocobase.com/20260420171642.png)
## Согласование
Нажмите на задачу рабочего процесса, чтобы открыть окно диалога, где отображается история сообщений AI-сотрудника. Последняя карточка, отправленная AI-сотрудником, и есть содержимое, требующее согласования в данном узле.
Нажмите на задачу рабочего процесса, чтобы открыть окно диалога, где отображается история сообщений ИИ-сотрудника. Последняя карточка, отправленная ИИ-сотрудником, и есть содержимое, требующее согласования в данном узле.
![20260420180710](https://static-docs.nocobase.com/20260420180710.png)
Для содержимого, ожидающего согласования, доступны три действия: Approve (одобрить), Revise (изменить), Reject (отклонить).
Для содержимого, ожидающего согласования, доступны три действия: `Одобрить`, `Доработать` и `Отклонить`.
При нажатии Approve содержимое, сгенерированное ИИ, одобряется, и рабочий процесс продолжается. Диалог становится доступным только для чтения, продолжать общение с AI-сотрудником невозможно.
При нажатии `Одобрить` содержимое, сгенерированное ИИ, одобряется, и рабочий процесс продолжается. Диалог становится доступным только для чтения, продолжать общение с ИИ-сотрудником невозможно.
![20260420180632](https://static-docs.nocobase.com/20260420180632.png)
При нажатии Revise можно отправить ИИ замечания на правку. После отправки ИИ ответит новой карточкой согласования.
При нажатии `Доработать` можно отправить ИИ замечания на правку. После отправки ИИ ответит новой карточкой согласования.
![20260420180908](https://static-docs.nocobase.com/20260420180908.png)
При нажатии Reject выполнение отклоняется, и рабочий процесс останавливается. Диалог становится доступным только для чтения, продолжать общение с AI-сотрудником невозможно.
При нажатии `Отклонить` выполнение отклоняется, и рабочий процесс останавливается. Диалог становится доступным только для чтения, продолжать общение с ИИ-сотрудником невозможно.
![20260420181003](https://static-docs.nocobase.com/20260420181003.png)
docs/docs/ru/ai-employees/workflow/nodes/employee/configuration.md
+32 -32
View File
@@ -1,95 +1,95 @@
# Узел AI-сотрудника
# Узел ИИ-сотрудника
## Введение
Узел AI-сотрудника используется в рабочем процессе для назначения AI-сотруднику выполнения определённой задачи с последующим выводом структурированной информации.
Узел ИИ-сотрудника используется в рабочем процессе для назначения ИИ-сотруднику выполнения определённой задачи с последующим выводом структурированной информации.
После создания рабочего процесса при добавлении узлов рабочего процесса можно выбрать узел AI-сотрудника.
После создания рабочего процесса при добавлении узлов рабочего процесса можно выбрать узел ИИ-сотрудника.
![20260420142250](https://static-docs.nocobase.com/20260420142250.png)
## Настройка узла
### Подготовка
### Предварительная подготовка
Перед настройкой узла AI-сотрудника необходимо разобраться, как создавать рабочие процессы, как настраивать LLM-сервис, а также узнать о назначении встроенных AI-сотрудников и о том, как создавать AI-сотрудников.
Перед настройкой узла ИИ-сотрудника необходимо разобраться, как создавать рабочие процессы, как настраивать службу языковой модели, а также узнать о назначении встроенных ИИ-сотрудников и о том, как создавать ИИ-сотрудников.
Можно ознакомиться со следующими документами:
- [Рабочие процессы](/workflow)
- [Настройка LLM-сервиса](/ai-employees/features/llm-service)
- [Встроенные AI-сотрудники](/ai-employees/built-in/)
- [Создание AI-сотрудника](/ai-employees/features/new-ai-employees)
- [Настройка службы языковой модели](/ai-employees/features/llm-service)
- [Встроенные ИИ-сотрудники](/ai-employees/built-in/)
- [Новый ИИ-сотрудник](/ai-employees/features/new-ai-employees)
### Задача
#### Выбор AI-сотрудника
#### Выбор ИИ-сотрудника
Выберите AI-сотрудника, который будет отвечать за выполнение задачи в этом узле. В выпадающем списке выберите включённого в системе встроенного AI-сотрудника или AI-сотрудника, созданного вами самостоятельно.
Выберите ИИ-сотрудника, который будет отвечать за выполнение задачи в этом узле. В выпадающем списке выберите включённого в системе встроенного ИИ-сотрудника или ИИ-сотрудника, созданного вами самостоятельно.
![20260420143554](https://static-docs.nocobase.com/20260420143554.png)
#### Выбор модели
Выберите большую языковую модель, которая будет управлять AI-сотрудником. В выпадающем списке выберите модель, предоставляемую настроенным в системе LLM-сервисом.
Выберите языковую модель, которая будет управлять ИИ-сотрудником. В выпадающем списке выберите модель, предоставляемую настроенной в системе службой языковой модели.
![20260420145057](https://static-docs.nocobase.com/20260420145057.png)
#### Выбор оператора
Выберите пользователя в системе, который будет предоставлять AI-сотруднику права доступа к данным. При запросе данных AI-сотрудник будет ограничен правами этого пользователя.
Выберите пользователя в системе, который будет предоставлять ИИ-сотруднику права доступа к данным. При запросе данных ИИ-сотрудник будет ограничен правами этого пользователя.
Если триггер предоставляет оператора (например, `Custom action event`), то приоритетно используются права этого оператора.
Если триггер предоставляет оператора (например, `Пользовательское событие действия`), то приоритетно используются права этого оператора.
![20260420145244](https://static-docs.nocobase.com/20260420145244.png)
#### Промпты и описание задачи
`Background` отправляется ИИ как системный промпт и обычно используется для описания фоновой информации задачи и ограничений.
`Описание` отправляется ИИ как системный промпт и обычно используется для описания задачи и ограничений.
`Default user message` — это пользовательский промпт, отправляемый ИИ; обычно описывает содержание задачи и сообщает ИИ, что нужно сделать.
`Сообщение пользователя по умолчанию` — это пользовательский промпт, отправляемый ИИ; обычно описывает содержание задачи и сообщает ИИ, что нужно сделать.
![20260420174515](https://static-docs.nocobase.com/20260420174515.png)
#### Вложения
`Attachments` отправляются ИИ вместе с `Default user message`. Обычно это документы или изображения, которые необходимы для выполнения задачи.
`Вложения` отправляются ИИ вместе с `Сообщение пользователя по умолчанию`. Обычно это документы или изображения, которые необходимы для выполнения задачи.
Вложения поддерживают два типа:
1. `File(load via Files collection)` — использование первичного ключа для получения данных из указанной таблицы файлов и использования их в качестве вложения, отправляемого ИИ.
1. `Файл (загрузка через коллекцию файлов)` — использование первичного ключа для получения данных из указанной коллекции файлов и использования их в качестве вложения, отправляемого ИИ.
![20260420150933](https://static-docs.nocobase.com/20260420150933.png)
2. `File via URL` — получение файла по указанному URL и использование его в качестве вложения, отправляемого ИИ.
2. `Файл (загрузка по URL)` — получение файла по указанному URL и использование его в качестве вложения, отправляемого ИИ.
![20260420151702](https://static-docs.nocobase.com/20260420151702.png)
#### Навыки и инструменты
Обычно к AI-сотруднику привязано несколько навыков и инструментов; здесь можно ограничить использование лишь некоторых из них в текущей задаче.
Обычно к ИИ-сотруднику привязано несколько навыков и инструментов; здесь можно ограничить использование лишь некоторых из них в текущей задаче.
По умолчанию установлен режим `Preset`, при котором используются предустановленные навыки и инструменты AI-сотрудника. При установке `Customer` можно выбрать только некоторые навыки или инструменты AI-сотрудника.
По умолчанию установлен режим `Предустановленный`, при котором используются предустановленные навыки и инструменты ИИ-сотрудника. При установке `Пользовательский` можно выбрать только некоторые навыки или инструменты ИИ-сотрудника.
![20260426231701](https://static-docs.nocobase.com/20260426231701.png)
#### Поиск в интернете
#### Веб-поиск
Переключатель `Web search` управляет тем, использует ли ИИ в текущем узле возможность поиска в интернете. О поиске в интернете для AI-сотрудника см.: [Поиск в интернете](/ai-employees/features/web-search)
Переключатель `Веб-поиск` управляет тем, использует ли ИИ в текущем узле возможность веб-поиска. О веб-поиске для ИИ-сотрудника см.: [Веб-поиск](/ai-employees/features/web-search)
![20260426231945](https://static-docs.nocobase.com/20260426231945.png)
### Обратная связь и уведомления
### Вывод и уведомления
#### Структурированный вывод
Пользователь может в соответствии со спецификацией [JSON Schema](https://json-schema.org/) определить структуру данных, которую в итоге выводит узел AI-сотрудника.
Пользователь может в соответствии со спецификацией [Схема JSON](https://json-schema.org/) определить структуру данных, которую в итоге выводит узел ИИ-сотрудника.
![20260426232117](https://static-docs.nocobase.com/20260426232117.png)
При получении данных узла AI-сотрудника другими узлами рабочего процесса варианты также будут формироваться в соответствии с этим `JSON Schema`.
При получении данных узла ИИ-сотрудника другими узлами рабочего процесса варианты также будут формироваться в соответствии с этой схемой JSON.
![20260426232509](https://static-docs.nocobase.com/20260426232509.png)
##### Значение по умолчанию
По умолчанию предоставляется следующее определение `JSON Schema`, которое описывает объект, содержащий свойство с именем result строкового типа. Свойству также задан заголовок: Result.
По умолчанию предоставляется следующее определение схемы JSON, которое описывает объект, содержащий свойство с именем result строкового типа. Свойству также задан заголовок: Result.
```json
{
@@ -104,7 +104,7 @@
}
```
Согласно этому определению, узел AI-сотрудника выводит JSON-данные, соответствующие описанной структуре.
Согласно этому определению, узел ИИ-сотрудника выводит JSON-данные, соответствующие описанной структуре.
```json
{
@@ -116,14 +116,14 @@
Узел поддерживает три режима согласования:
- `No required` — выводимое ИИ содержимое не требует ручной проверки. После завершения вывода ИИ рабочий процесс автоматически продолжается.
- `Human decision` — выводимое ИИ содержимое обязательно отправляется на ручную проверку проверяющему; рабочий процесс продолжается только после ручной проверки.
- `AI decision` — ИИ сам решает, отправлять ли выводимое содержимое на ручную проверку проверяющему.
- `Не требуется` — выводимое ИИ содержимое не требует ручной проверки. После завершения вывода ИИ рабочий процесс автоматически продолжается.
- `Решение человека` — выводимое ИИ содержимое обязательно отправляется на ручную проверку проверяющему; рабочий процесс продолжается только после ручной проверки.
- `Решение ИИ` — ИИ сам решает, отправлять ли выводимое содержимое на ручную проверку проверяющему.
![20260426232232](https://static-docs.nocobase.com/20260426232232.png)
Если режим согласования отличается от `No required`, для узла обязательно нужно настроить одного или нескольких проверяющих.
Если режим согласования отличается от `Не требуется`, для узла обязательно нужно настроить одного или нескольких проверяющих.
После того как ИИ в узле AI-сотрудника завершит вывод всего содержимого, всем настроенным для узла проверяющим будет отправлено уведомление. Достаточно, чтобы кто-то один из уведомлённых проверяющих выполнил действие согласования, и рабочий процесс сможет продолжиться.
После того как ИИ в узле ИИ-сотрудника завершит вывод всего содержимого, всем настроенным для узла проверяющим будет отправлено уведомление. Достаточно, чтобы кто-то один из уведомлённых проверяющих выполнил действие согласования, и рабочий процесс сможет продолжиться.
![20260426232319](https://static-docs.nocobase.com/20260426232319.png)
docs/docs/ru/ai/install-upgrade-migration.mdx
+407
View File
@@ -0,0 +1,407 @@
---
title: "Руководство по установке, обновлению и миграции с использованием NocoBase CLI"
description: "Переход со старых способов установки и обновления (Docker, create-nocobase-app, Git) на новый рабочий процесс через NocoBase CLI."
keywords: "NocoBase CLI,миграция установки,миграция обновления,nb init,nb app upgrade,Docker,create-nocobase-app,исходный код Git"
---
# Руководство по установке, обновлению и миграции с использованием NocoBase CLI
:::danger
Возможности CLI по установке и сопровождению приложений всё ещё находятся в активной разработке. На текущий момент они больше подходят для локальной разработки, тестовых окружений и сценариев подключения AI Agent. Не рекомендуется использовать их напрямую для установки, обновления и эксплуатации в продуктивных средах.
:::
Новый NocoBase CLI (`nb`) объединяет установку, подключение, запуск, остановку, просмотр логов, обновление и очистку в единый набор команд. По сравнению со старой документацией, где для Docker, create-nocobase-app и установки из исходников Git поддерживались отдельные процессы, CLI лучше подходит для локальной разработки, сопровождения тестовых окружений, а также для подключения и совместной работы с AI Agent.
Эта статья применима к следующим сценариям:
- Вы устанавливаете или обновляете NocoBase по старой документации и хотите перейти на новый способ через CLI.
- У Вас уже есть NocoBase, развёрнутый старым способом, и Вы хотите, чтобы CLI управлял им или подключался к нему.
- Вам нужно подготовить для AI Agent окружение NocoBase, к которому можно подключаться и которое можно сопровождать.
## Различия между старым и новым способами
Старый способ разделял документацию по источнику установки — для каждого источника требовалось отдельно выполнять команды загрузки, настройки, установки, запуска и обновления.
**Старая документация по установке**
- [Установка через Docker](/get-started/installation/docker)
- [Установка через create-nocobase-app](/get-started/installation/create-nocobase-app)
- [Установка из исходного кода Git](/get-started/installation/git)
**Старая документация по обновлению**
- [Обновление установки через Docker](/get-started/upgrading/docker)
- [Обновление установки через create-nocobase-app](/get-started/upgrading/create-nocobase-app)
- [Обновление установки из исходного кода Git](/get-started/upgrading/git)
Новый способ имеет единую точку входа — `nb init`, и использует один env CLI для записи источника приложения, рабочего каталога, каталога хранения, настроек базы данных и параметров подключения к API. После этого, независимо от того, используется Docker, npm или Git как источник, по возможности применяется единый набор команд `nb app`, `nb source`, `nb db`.
| Сценарий | Старый способ | Новый способ через CLI |
| --- | --- | --- |
| Точка входа установки | `docker compose`, `create-nocobase-app`, `git clone` | `nb init` или `nb init --ui` |
| Управление приложением | переход в каталог, правка compose, выполнение yarn/pm2 | `nb app start/stop/restart/logs/down` |
| Обновление | свой набор команд для каждого способа установки | `nb app upgrade -e <env>` |
| Режим разработки | `yarn dev` | `nb source dev -e <env>` |
| Состояние БД | вручную смотреть контейнер или сервис БД | `nb db ps -e <env>` |
| Просмотр статуса и деталей окружения | вручную записывать пути, порты и адреса | `nb env list`, `nb env info <env>` |
| Подключение к существующему приложению | в старой документации единого подхода не было | `nb init --ui` или `nb init --api-base-url` |
## Установка CLI
```bash
npm install -g @nocobase/cli@beta
nb --version
```
После установки можно посмотреть справку:
```bash
nb --help
nb init --help
```
## Установка NocoBase новым способом
### Рекомендуется: визуальный мастер
```bash
nb init --ui
```
Мастер проведёт Вас по следующим шагам:
- Создать новое приложение или подключить существующее
- Выбрать источник установки: Docker, npm, Git
- Выбрать версию NocoBase
- Использовать встроенную базу данных или внешнюю
- Создать учётную запись и пароль администратора
### Терминальный интерактивный мастер
```bash
nb init
```
### Неинтерактивные команды
По умолчанию используется установка через Docker и встроенный PostgreSQL:
```bash
nb init --yes --env app1
```
Установка указанной версии через Docker:
```bash
nb init --yes --env app1 --source docker --version beta
```
Установка через npm:
```bash
nb init --yes --env app1 --source npm --version beta --app-port 13080
```
Установка из исходного кода Git:
```bash
nb init --yes --env app1 --source git --version beta
```
Установка из исходного кода Git с указанием типа встроенной базы данных:
```bash
nb init --yes --env app1 --source git --version beta --db-dialect mysql
```
Подключение к существующему приложению NocoBase:
```bash
# По умолчанию используется аутентификация OAuth
nb init --yes --env app1 --api-base-url=http://next.v2.test.nocobase.com/nocobase/api
# Аутентификация по token
nb init --yes --env app1 \
--api-base-url=http://next.v2.test.nocobase.com/nocobase/api \
--auth-type=token \
--access-token=<token>
```
:::tip
`--env` — это имя окружения в CLI. Все последующие команды запуска, обновления, просмотра логов и т. д. могут использовать его через `-e app1`.
:::
## Обновление новым способом
В старом подходе команды обновления для Docker, create-nocobase-app и Git исходников отличаются. В новом CLI они объединены:
```bash
nb app upgrade -e app1
```
Если Вы хотите выполнить обновление, используя уже загруженный исходный код или образ, без подтягивания новой версии:
```bash
nb app upgrade -e app1 --skip-code-update
```
Или сокращённый вариант:
```bash
nb app upgrade -e app1 -s
```
## Часто используемые команды сопровождения
| Действие | Команда |
| --- | --- |
| Запустить приложение | `nb app start -e app1` |
| Остановить приложение | `nb app stop -e app1` |
| Перезапустить приложение | `nb app restart -e app1` |
| Просмотреть логи | `nb app logs -e app1` |
| Посмотреть env и статус аутентификации API | `nb env list` |
| Посмотреть детали env | `nb env info app1` |
| Посмотреть статус встроенной БД | `nb db ps -e app1` |
| Обновить приложение | `nb app upgrade -e app1` |
| Остановить и очистить ресурсы | `nb app down -e app1` |
`nb app down` по умолчанию останавливает приложение и удаляет контейнеры, управляемые CLI, а также локальные файлы приложения, но сохраняет данные `storage` и конфигурацию env. Удалить всё содержимое можно только с явным подтверждением:
```bash
nb app down -e app1 --all --yes
```
:::warning
`--all --yes` удалит данные `storage` и конфигурацию env CLI для этого окружения. Используйте только после того, как убедитесь, что у Вас есть резервная копия и окружение больше не нужно.
:::
## Команды для повседневной разработки
`nb source` управляет локальным проектом исходников и применяется в основном для env с источниками npm и Git.
| Действие | Команда |
| --- | --- |
| Запуск приложения в режиме разработки | `nb source dev -e app1` |
| Сборка исходников | `nb source build --cwd /your/workspace/app1/source` |
| Запуск тестов | `nb source test --cwd /your/workspace/app1/source` |
| Загрузка или обновление исходников/образа | `nb source download --source git --version beta` |
:::tip
Для Docker-окружения обычно используются `nb app start`, `nb app logs` и `nb app upgrade`, а `nb source dev` не применяется.
:::
## NB_CLI_ROOT и структура каталогов
CLI сохраняет глобальную конфигурацию и локальные файлы приложений в каталоге, на который указывает `NB_CLI_ROOT`.
По умолчанию `NB_CLI_ROOT` равен домашнему каталогу текущего пользователя — пути, который возвращает `os.homedir()` в Node.js. Например, на macOS это обычно `/Users/<user>`. Поэтому без дополнительной настройки файлы, создаваемые `nb init --yes --env app1`, как правило, окажутся здесь:
```text
~
├── .nocobase
│ └── config.json
└── app1
├── source
└── storage
```
Вы также можете явно задать `NB_CLI_ROOT`:
```bash
export NB_CLI_ROOT=/your/workspace
```
После этого файлы конфигурации и каталог приложения по умолчанию будут располагаться внутри указанного каталога:
```text
/your/workspace
├── .nocobase
│ └── config.json
└── app1
├── source
└── storage
```
Где:
- `.nocobase/config.json` хранит env, текущее окружение, адрес API, путь к исходникам, путь к storage, настройки БД и т. д.
- `<envName>/source` — управляемый CLI каталог исходного кода или приложения.
- `<envName>/storage` — управляемый CLI каталог хранения приложения.
:::warning
После инициализации одного и того же приложения используйте один и тот же `NB_CLI_ROOT`. Если позже Вы измените `NB_CLI_ROOT`, CLI начнёт искать `.nocobase/config.json` в новом каталоге, а относительные пути `appRootPath` и `storagePath` будут разрешаться относительно нового каталога — это может привести к тому, что приложение не будет найдено или произойдёт чтение/запись в неправильный каталог.
:::
В настоящее время CLI использует только глобальный scope конфигурации. Если Вам нужно изменить расположение конфигурации и локальных файлов приложений, задавайте `NB_CLI_ROOT`.
При просмотре и поиске приложений отдавайте предпочтение командам `nb env list` и `nb env info`:
```bash
# Посмотреть настроенные env и статус аутентификации API
nb env list
# Посмотреть подробную информацию о конкретном env
nb env info app1
```
`nb env list` ориентирован на быстрый общий обзор. В нём `App Status` — это статус аутентификации, полученный после обращения к API приложения по сохранённым Token/OAuth-учётным данным. Состояние базы данных в этом списке больше не отображается. Для просмотра состояния встроенной базы данных используйте:
```bash
nb db ps -e app1
```
Менять env по умолчанию следует только при необходимости:
```bash
nb env use app1
```
## Миграция со старого способа на CLI
Существуют две стратегии миграции: **подключение к существующему приложению** или **передача каталога локального приложения под управление CLI**. Если Ваше старое приложение уже стабильно работает, рекомендуем сначала использовать «подключение к существующему приложению» — это наименее рискованный путь.
### Способ 1. Подключение к существующему приложению
Подходит для NocoBase, развёрнутого через Docker, create-nocobase-app, исходники Git или серверное развёртывание.
```bash
# По умолчанию используется аутентификация OAuth
nb init --yes --env app1 --api-base-url=http://next.v2.test.nocobase.com/nocobase/api
# Аутентификация по token
nb init --yes --env "app$RANDOM" \
--api-base-url=http://next.v2.test.nocobase.com/nocobase/api \
--auth-type=token \
--access-token=<token>
```
При таком способе сохраняется только подключение по API. CLI не берёт на себя запуск, остановку, обновление, каталоги исходников или storage старого приложения. Подходит для подключения AI Agent или команд `nb api` к существующему приложению.
Если нужно обновить аутентификацию:
```bash
nb env auth app1
```
### Способ 2. Создание нового env CLI и миграция файлов
Подходит, если в дальнейшем Вы планируете управлять локальным приложением через `nb app` и `nb source`.
Перед миграцией обязательно выполните:
1. Остановите старое приложение.
2. Сделайте резервную копию старой базы данных.
3. Сделайте резервную копию старого каталога `storage`.
4. Зафиксируйте ключевые переменные окружения старого приложения, например `APP_KEY`, `TZ`, `DB_*`, `DB_UNDERSCORED`.
#### Миграция со старой Docker-установки
Старая Docker-установка обычно хранит данные приложения в каталоге `storage` внутри проекта:
```text
/old-docker-project
├── docker-compose.yml
└── storage
```
Рекомендуется сначала определить новый `NB_CLI_ROOT`, а затем создать новое Docker-env через CLI. В примере ниже предполагается, что `NB_CLI_ROOT` равен `/your/workspace`.
```bash
export NB_CLI_ROOT=/your/workspace
nb init --yes --env app2 --source docker --version beta
nb app stop -e app2
```
Новый env по умолчанию будет использовать следующие каталоги:
```text
/your/workspace
└── app2
├── source
└── storage
```
Затем скопируйте старый `storage` в `/your/workspace/app2/storage` и убедитесь, что параметры подключения к БД и значения `APP_KEY` и т. п. совпадают со старым окружением.
После копирования и проверки настроек БД запустите приложение:
```bash
nb app start -e app2
nb app logs -e app2
```
#### Миграция с create-nocobase-app или установки из исходников Git
В старом способе через npm/Git исходный код, файл `.env` и `storage` обычно находятся в одном каталоге проекта:
```text
/old-nocobase
├── .env
├── package.json
├── packages
└── storage
```
Рекомендуется сначала определить новый `NB_CLI_ROOT`, а затем создать новое npm- или Git-env. В примере ниже предполагается, что `NB_CLI_ROOT` равен `/your/workspace`.
```bash
export NB_CLI_ROOT=/your/workspace
nb init --yes --env app3 --source git --version beta
nb app stop -e app3
```
Затем выполните миграцию по необходимости:
- Перенесите исходный код собственных плагинов из старого проекта в соответствующий каталог `/your/workspace/app3/source`.
- Скопируйте старый каталог `storage` в `/your/workspace/app3/storage`.
- Перенесите ключевые настройки из старого `.env` в конфигурацию env CLI или в параметры инициализации.
- При использовании прежней БД отключите встроенную базу данных при инициализации и укажите параметры подключения к старой БД.
Пример инициализации с внешней базой данных:
```bash
nb init --yes --env app3 --source git --version beta \
--no-builtin-db \
--db-dialect postgres \
--db-host 127.0.0.1 \
--db-port 5432 \
--db-database nocobase \
--db-user nocobase \
--db-password nocobase
```
После миграции запустите приложение и просмотрите логи:
```bash
nb app start -e app3
nb app logs -e app3
```
:::warning
Не перезаписывайте `source`, `storage` и не запускайте обновление с подключением к продуктивной базе данных без резервной копии. Перед реальной миграцией рекомендуется полностью отрепетировать процедуру в тестовом окружении.
:::
## Шпаргалка по миграции старых команд
| Старая команда | Новая команда CLI |
| --- | --- |
| `docker compose up -d app` | `nb app start -e app1` |
| `docker compose stop app` | `nb app stop -e app1` |
| `docker compose logs -f app` | `nb app logs -e app1` |
| `docker compose pull app && docker compose up -d app` | `nb app upgrade -e app1` |
| `yarn create nocobase-app my-nocobase-app ...` | `nb init --yes --env app1 --source npm --version beta` |
| `npx create-nocobase-app@beta my-nocobase-app ...` | `nb init --yes --env app1 --source npm --version beta` |
| `git clone ... -b next --depth=1 my-nocobase` | `nb init --yes --env app1 --source git --version beta` |
| `git clone ... -b develop --depth=1 my-nocobase` | `nb init --yes --env app1 --source git --version alpha` |
| `yarn dev` | `nb source dev -e app1` |
| `yarn nocobase upgrade` | `nb app upgrade -e app1` |
| `yarn nocobase upgrade --skip-code-update` | `nb app upgrade -e app1 -s` |
| Ручное ведение списка адресов нескольких приложений | `nb env list`, `nb env info app1` |
| Ручное подключение к существующему приложению | `nb init --yes --env app1 --api-base-url=http://next.v2.test.nocobase.com/nocobase/api` |
## Связанные материалы
- [Руководство по подключению AI Agent](/ai/quick-start)
- [Справочник команд NocoBase CLI](/api/cli)
- [Сравнение способов установки и версий](/get-started/quickstart)
- [Установка и обновление плагинов](/get-started/install-upgrade-plugins)
docs/docs/ru/api/app/env.md
+50 -50
View File
@@ -8,19 +8,19 @@ keywords: "переменные окружения,APP_KEY,TZ,конфигура
## TZ
Используется для установки часового пояса приложения. По умолчанию используется часовой пояс операционной системы.
Используется для задания часового пояса приложения; по умолчанию используется часовой пояс системы.
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
:::warning
Все операции, связанные со временем, обрабатываются с учётом этого часового пояса. Изменение TZ может повлиять на значения дат в базе данных. Подробнее см. «[Обзор даты и времени](#)».
Операции, связанные со временем, будут выполняться в соответствии с этим часовым поясом. Изменение TZ может повлиять на значения дат в базе данных. Для получения подробностей см. [Обзор даты и времени](/data-sources/data-modeling/collection-fields/datetime).
:::
## APP_ENV
Окружение приложения. Значение по умолчанию `development`. Доступные варианты:
Окружение приложения; по умолчанию — `development`. Доступные варианты:
- `production` — продакшн-окружение
- `production` — производственное окружение
- `development` — окружение разработки
```bash
@@ -29,10 +29,10 @@ APP_ENV=production
## APP_KEY
Секретный ключ приложения, используется для генерации пользовательских токенов и т. п. Замените его на собственный ключ и не передавайте его третьим лицам.
Секретный ключ приложения, используемый для генерации токенов пользователей и т. д. Замените его на ваш собственный ключ приложения и убедитесь, что он не раскрыт.
:::warning
Если значение APP_KEY изменено, ранее выпущенные токены становятся недействительными.
Если `APP_KEY` будет изменён, старые токены станут недействительными.
:::
```bash
@@ -41,7 +41,7 @@ APP_KEY=app-key-test
## APP_PORT
Порт приложения. Значение по умолчанию `13000`.
Порт приложения; по умолчанию — `13000`.
```bash
APP_PORT=13000
@@ -49,7 +49,7 @@ APP_PORT=13000
## API_BASE_PATH
Префикс адресов API NocoBase. Значение по умолчанию `/api/`.
Префикс адреса API NocoBase; по умолчанию — `/api/`.
```bash
API_BASE_PATH=/api/
@@ -88,37 +88,37 @@ SERVER_REQUEST_WHITELIST=api.example.com,*.trusted.com,10.0.0.0/8,127.0.0.1
> `v1.6.0+`
Режим многоядерного (кластерного) запуска. Если переменная задана, её значение передаётся в команду `pm2 start` в качестве параметра `-i <instances>`. Доступные варианты совпадают с параметром `-i` PM2 (см. [PM2: Cluster Mode](https://pm2.keymetrics.io/docs/usage/cluster-mode/)):
Режим запуска приложения с несколькими ядрами (режим кластера). Если эта переменная задана, она будет передана в команду `pm2 start` как параметр `-i <instances>`. Варианты соответствуют параметру pm2 `-i` (см. [PM2: режим кластера](https://pm2.keymetrics.io/docs/usage/cluster-mode/)), включая:
- `max` — использовать максимальное количество ядер CPU
- `-1` — максимальное количество ядер CPU минус 1
- `<number>` — указанное количество ядер
- `<number>` — указать количество ядер
По умолчанию переменная пуста, что означает выключенный режим.
Значение по умолчанию пустое, то есть режим не включён.
:::warning{title="Внимание"}
Этот режим требует использования соответствующих плагинов кластерного режима, иначе функциональность приложения может работать некорректно.
Для этого режима требуются плагины, связанные с режимом кластера. В противном случае функциональность приложения может работать некорректно.
:::
Подробнее: [Кластерный режим](#).
Для получения дополнительной информации см. [Режим кластера](/cluster-mode).
## PLUGIN_PACKAGE_PREFIX
Префикс имён пакетов плагинов. Значение по умолчанию: `@nocobase/plugin-,@nocobase/preset-`.
Префикс пакета плагинов; по умолчанию: `@nocobase/plugin-,@nocobase/preset-`.
Например, при добавлении плагина `hello` в проект `my-nocobase-app` полное имя пакета плагина будет `@my-nocobase-app/plugin-hello`.
Например, чтобы добавить плагин `hello` в проект `my-nocobase-app`, полное имя пакета плагина будет `@my-nocobase-app/plugin-hello`.
Значение PLUGIN_PACKAGE_PREFIX можно настроить так:
`PLUGIN_PACKAGE_PREFIX` можно настроить так:
```bash
PLUGIN_PACKAGE_PREFIX=@nocobase/plugin-,@nocobase-preset-,@my-nocobase-app/plugin-
```
В этом случае соответствие имён плагинов и пакетов будет таким:
Соответствие между именем плагина и именем пакета следующее:
- Плагин `users` имеет имя пакета `@nocobase/plugin-users`
- Плагин `nocobase` имеет имя пакета `@nocobase/preset-nocobase`
- Плагин `hello` имеет имя пакета `@my-nocobase-app/plugin-hello`
- `users` — имя пакета плагина: `@nocobase/plugin-users`
- `nocobase` — имя пакета плагина: `@nocobase/preset-nocobase`
- `hello` — имя пакета плагина: `@my-nocobase-app/plugin-hello`
## DB_DIALECT
@@ -134,9 +134,9 @@ DB_DIALECT=mysql
## DB_HOST
Хост базы данных (требуется при использовании MySQL или PostgreSQL).
Хост базы данных (обязателен при использовании базы данных MySQL или PostgreSQL).
Значение по умолчанию `localhost`.
Значение по умолчанию — `localhost`.
```bash
DB_HOST=localhost
@@ -144,7 +144,7 @@ DB_HOST=localhost
## DB_PORT
Порт базы данных (требуется при использовании MySQL или PostgreSQL).
Порт базы данных (обязателен при использовании базы данных MySQL или PostgreSQL).
- Порт по умолчанию для MySQL и MariaDB — 3306
- Порт по умолчанию для PostgreSQL — 5432
@@ -155,7 +155,7 @@ DB_PORT=3306
## DB_DATABASE
Имя базы данных (требуется при использовании MySQL или PostgreSQL).
Имя базы данных (обязательно при использовании базы данных MySQL или PostgreSQL).
```bash
DB_DATABASE=nocobase
@@ -163,7 +163,7 @@ DB_DATABASE=nocobase
## DB_USER
Пользователь базы данных (требуется при использовании MySQL или PostgreSQL).
Пользователь базы данных (обязателен при использовании базы данных MySQL или PostgreSQL).
```bash
DB_USER=nocobase
@@ -171,7 +171,7 @@ DB_USER=nocobase
## DB_PASSWORD
Пароль базы данных (требуется при использовании MySQL или PostgreSQL).
Пароль базы данных (обязателен при использовании базы данных MySQL или PostgreSQL).
```bash
DB_PASSWORD=nocobase
@@ -179,7 +179,7 @@ DB_PASSWORD=nocobase
## DB_TABLE_PREFIX
Префикс имён таблиц.
Префикс таблиц.
```bash
DB_TABLE_PREFIX=nocobase_
@@ -187,18 +187,18 @@ DB_TABLE_PREFIX=nocobase_
## DB_UNDERSCORED
Преобразовывать ли имена таблиц и полей базы данных в стиль snake_case. По умолчанию `false`. Если используется база данных MySQL (MariaDB) с настройкой `lower_case_table_names=1`, значение DB_UNDERSCORED должно быть `true`.
Преобразовывать ли имена таблиц и полей базы данных в стиль snake_case. По умолчанию — `false`. Если используется база данных MySQL (MariaDB) с настройкой `lower_case_table_names=1`, значение `DB_UNDERSCORED` должно быть `true`.
:::warning
Когда `DB_UNDERSCORED=true`, фактические имена таблиц и полей в базе данных не совпадают с теми, которые отображаются в интерфейсе. Например, `orderDetails` в базе хранится как `order_details`.
Когда `DB_UNDERSCORED=true`, фактические имена таблиц и полей в базе данных не совпадают с теми, которые отображаются в интерфейсе. Например, `orderDetails` в базе данных хранится как `order_details`.
:::
## DB_LOGGING
Переключатель логирования базы данных. Значение по умолчанию `off`. Доступные варианты:
Переключатель логирования базы данных. По умолчанию — `off`. Доступные варианты:
- `on` — включить
- `off` — выключить
- `on` — включено
- `off` — выключено
```bash
DB_LOGGING=on
@@ -206,12 +206,12 @@ DB_LOGGING=on
## LOGGER_TRANSPORT
Способ вывода логов. Несколько значений разделяются `,`. По умолчанию в окружении разработки — `console`, в продакшн-окружении — `console,dailyRotateFile`.
Метод вывода логов; несколько значений разделяются `,`. По умолчанию: `console` в окружении разработки и `console,dailyRotateFile` в производственном окружении.
Доступные варианты:
- `console` — `console.log`
- `file` — файл
- `dailyRotateFile` — файл с ежедневной ротацией
- `file` — вывод в файл
- `dailyRotateFile` — вывод в файлы с ежедневной ротацией
```bash
LOGGER_TRANSPORT=console,dailyRotateFile
@@ -219,7 +219,7 @@ LOGGER_TRANSPORT=console,dailyRotateFile
## LOGGER_LEVEL
Уровень вывода логов. По умолчанию в окружении разработки — `debug`, в продакшн-окружении — `info`. Доступные варианты:
Уровень вывода логов. По умолчанию — `debug` в окружении разработки и `info` в производственном окружении. Доступные варианты:
- `error`
- `warn`
@@ -231,14 +231,14 @@ LOGGER_TRANSPORT=console,dailyRotateFile
LOGGER_LEVEL=info
```
Уровень логов базы данных — `debug`. Их вывод управляется параметром `DB_LOGGING` и не зависит от `LOGGER_LEVEL`.
Уровень вывода логов базы данных всегда — `debug`; он контролируется параметром `DB_LOGGING` и не зависит от `LOGGER_LEVEL`.
## LOGGER_MAX_FILES
Максимальное количество сохраняемых лог-файлов.
Максимальное количество файлов логов для хранения.
- Когда `LOGGER_TRANSPORT` равен `file`, значение по умолчанию — `10`.
- Когда `LOGGER_TRANSPORT` равен `dailyRotateFile`, используется формат `[n]d` для указания количества дней. Значение по умолчанию — `14d`.
- Когда `LOGGER_TRANSPORT` равно `file`, по умолчанию — `10`.
- Когда `LOGGER_TRANSPORT` равно `dailyRotateFile`, используйте `[n]d` для обозначения дней. По умолчанию — `14d`.
```bash
LOGGER_MAX_FILES=14d
@@ -248,8 +248,8 @@ LOGGER_MAX_FILES=14d
Ротация логов по размеру.
- Когда `LOGGER_TRANSPORT` равен `file`, единица измерения — `byte`. Значение по умолчанию — `20971520 (20 * 1024 * 1024)`.
- Когда `LOGGER_TRANSPORT` равен `dailyRotateFile`, можно использовать `[n]k`, `[n]m`, `[n]g`. По умолчанию не задано.
- Когда `LOGGER_TRANSPORT` равно `file`, единица измерения — `byte`. По умолчанию — `20971520 (20 * 1024 * 1024)`.
- Когда `LOGGER_TRANSPORT` равно `dailyRotateFile`, можно использовать `[n]k`, `[n]m`, `[n]g`. По умолчанию не задано.
```bash
LOGGER_MAX_SIZE=20971520
@@ -257,7 +257,7 @@ LOGGER_MAX_SIZE=20971520
## LOGGER_FORMAT
Формат вывода логов. По умолчанию в окружении разработки — `console`, в продакшн-окружении — `json`. Доступные варианты:
Формат вывода логов. По умолчанию — `console` в окружении разработки и `json` в производственном окружении. Доступные варианты:
- `console`
- `json`
@@ -268,11 +268,11 @@ LOGGER_MAX_SIZE=20971520
LOGGER_FORMAT=json
```
См.: [Форматы логов](#)
Справка: [Формат логов](/log-and-monitor/logger/index.md#log-format)
## CACHE_DEFAULT_STORE
Уникальный идентификатор используемого способа кэширования. Задаёт способ кэширования по умолчанию на серверной стороне. Значение по умолчанию `memory`. Встроенные варианты:
Уникальный идентификатор хранилища кэша, определяющий хранилище кэша по умолчанию на стороне сервера. По умолчанию — `memory`. Встроенные варианты:
- `memory`
- `redis`
@@ -283,7 +283,7 @@ CACHE_DEFAULT_STORE=memory
## CACHE_MEMORY_MAX
Максимальное количество элементов в кэше в памяти. Значение по умолчанию `2000`.
Максимальное количество элементов в кэше в памяти. По умолчанию — `2000`.
```bash
CACHE_MEMORY_MAX=2000
@@ -291,7 +291,7 @@ CACHE_MEMORY_MAX=2000
## CACHE_REDIS_URL
Подключение к Redis. Опционально. Пример: `redis://localhost:6379`.
URL подключения к Redis (необязательно). Пример: `redis://localhost:6379`.
```bash
CACHE_REDIS_URL=redis://localhost:6379
@@ -299,7 +299,7 @@ CACHE_REDIS_URL=redis://localhost:6379
## TELEMETRY_ENABLED
Включение сбора телеметрических данных. По умолчанию `off`.
Включить сбор данных телеметрии. По умолчанию — `off`.
```bash
TELEMETRY_ENABLED=on
@@ -307,7 +307,7 @@ TELEMETRY_ENABLED=on
## TELEMETRY_METRIC_READER
Используемые сборщики метрик мониторинга. По умолчанию `console`. Другие значения соответствуют именам, под которыми зарегистрированы плагины-сборщики, например `prometheus`. Несколько значений разделяются `,`.
Включённые сборщики метрик мониторинга. По умолчанию — `console`. Остальные значения должны соответствовать именам, под которыми зарегистрированы соответствующие плагины-сборщики, например `prometheus`. Несколько значений разделяются `,`.
```bash
TELEMETRY_METRIC_READER=console,prometheus
@@ -315,7 +315,7 @@ TELEMETRY_METRIC_READER=console,prometheus
## TELEMETRY_TRACE_PROCESSOR
Используемые обработчики данных трассировки. По умолчанию `console`. Другие значения соответствуют именам, под которыми зарегистрированы плагины-обработчики. Несколько значений разделяются `,`.
Включённые обработчики данных трассировки. По умолчанию — `console`. Остальные значения должны соответствовать именам, под которыми зарегистрированы соответствующие плагины-обработчики. Несколько значений разделяются `,`.
```bash
TELEMETRY_TRACE_PROCESSOR=console
docs/docs/ru/api/cli/api/dynamic.md
+7 -7
View File
@@ -12,16 +12,16 @@ keywords: "nb api динамические команды,NocoBase CLI,OpenAPI,s
| Группа команд | Описание |
| --- | --- |
| `nb api acl` | Управление правами: роли, права на ресурсы и операции |
| `nb api api-keys` | Управление API Key |
| `nb api acl` | Контроль доступа: роли, права на ресурсы и права действий |
| `nb api api-keys` | Управление ключами API |
| `nb api app` | Управление приложением |
| `nb api authenticators` | Управление аутентификацией: пароль, SMS, SSO и др. |
| `nb api data-modeling` | Моделирование данных: источники данных, таблицы и поля |
| `nb api data-modeling` | Моделирование данных: источники данных, коллекции и поля |
| `nb api file-manager` | Управление файлами: сервисы хранения и вложения |
| `nb api flow-surfaces` | Оркестрация страниц: страницы, блоки, поля и действия |
| `nb api system-settings` | Системные настройки: заголовок, логотип, язык и др. |
| `nb api theme-editor` | Управление темами: цвета, размеры и переключение тем |
| `nb api workflow` | Workflow: управление автоматизированными процессами |
| `nb api workflow` | Рабочий процесс: управление автоматизированными процессами |
Реальные доступные группы и команды зависят от версии подключённого приложения NocoBase и включённых плагинов. Запустите следующие команды, чтобы посмотреть, какие команды поддерживает текущее приложение:
@@ -43,10 +43,10 @@ nb api <topic> --help
Динамические команды API также поддерживают:
- `--env`, `-e`: имя CLI env, в которую отправляется запрос; если параметр не указан, используется текущая env
- `--yes`, `-y`: если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение
- `--env`, `-e`: имя CLI-окружения, в которое отправляется запрос; если параметр не указан, используется текущее окружение
- `--yes`, `-y`: если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/api/index.md
+2 -2
View File
@@ -19,7 +19,7 @@ nb api <command>
| Команда | Описание |
| --- | --- |
| [`nb api resource`](./resource/index.md) | Выполнение универсальных CRUD-операций и агрегатных запросов на любых ресурсах NocoBase |
| [`nb api Динамические команды`](./dynamic.md) | Команды topic и operation, генерируемые на основе OpenAPI Schema приложения |
| [`Динамические команды nb api`](./dynamic.md) | Команды topic и operation, генерируемые на основе OpenAPI Schema |
## Общие параметры
@@ -29,7 +29,7 @@ nb api <command>
| --- | --- | --- |
| `--api-base-url` | string | Адрес API NocoBase, например `http://localhost:13000/api` |
| `--env`, `-e` | string | Имя окружения |
| `--token`, `-t` | string | Переопределение API key |
| `--token`, `-t` | string | Переопределение ключа API |
| `--role` | string | Переопределение роли, отправляется как HTTP-заголовок `X-Role` |
| `--verbose` | boolean | Показать подробный прогресс |
| `--json-output`, `-j` / `--no-json-output` | boolean | Выводить ли исходный JSON, по умолчанию включено |
docs/docs/ru/api/cli/api/resource/create.md
+5 -5
View File
@@ -6,7 +6,7 @@ keywords: "nb api resource create,NocoBase CLI,создание записи,CRU
# nb api resource create
Создание записи указанного ресурса. Содержимое записи передаётся через `--values` в виде JSON-объекта.
Создание записи в выбранном ресурсе. Данные записи передаются через `--values` в виде JSON-объекта.
## Использование
@@ -20,10 +20,10 @@ nb api resource create --resource <resource> --values <json> [flags]
| --- | --- | --- |
| `--resource` | string | Имя ресурса, обязательно |
| `--data-source` | string | Ключ источника данных, по умолчанию `main` |
| `--source-id` | string | ID исходной записи связанного ресурса |
| `--values` | string | Данные создаваемой записи, JSON-объект, обязательно |
| `--whitelist` | string[] | Поля, разрешённые для записи, можно передавать несколько раз или JSON-массивом |
| `--blacklist` | string[] | Поля, запрещённые для записи, можно передавать несколько раз или JSON-массивом |
| `--source-id` | string | ID исходной записи для ресурсов связи |
| `--values` | string | Данные новой записи в виде JSON-объекта, обязательно |
| `--whitelist` | string[] | Поля из белого списка, разрешённые для записи; можно передавать несколько раз или JSON-массивом |
| `--blacklist` | string[] | Поля из чёрного списка, запрещённые для записи; можно передавать несколько раз или JSON-массивом |
Также поддерживаются общие параметры подключения [`nb api resource`](./index.md).
docs/docs/ru/api/cli/api/resource/destroy.md
+1 -1
View File
@@ -6,7 +6,7 @@ keywords: "nb api resource destroy,NocoBase CLI,удаление записи,CR
# nb api resource destroy
Удаление записи указанного ресурса. Для определения записи можно использовать `--filter-by-tk` или `--filter`.
Удаление записей из выбранного ресурса. Для поиска записей можно использовать `--filter-by-tk` или `--filter`.
## Использование
docs/docs/ru/api/cli/api/resource/get.md
+6 -6
View File
@@ -6,7 +6,7 @@ keywords: "nb api resource get,NocoBase CLI,получение записи,пе
# nb api resource get
Получение одной записи указанного ресурса. Обычно для указания первичного ключа используется `--filter-by-tk`.
Получение одной записи из выбранного ресурса. Обычно для указания первичного ключа используется `--filter-by-tk`.
## Использование
@@ -20,11 +20,11 @@ nb api resource get --resource <resource> [flags]
| --- | --- | --- |
| `--resource` | string | Имя ресурса, обязательно |
| `--data-source` | string | Ключ источника данных, по умолчанию `main` |
| `--source-id` | string | ID исходной записи связанного ресурса |
| `--filter-by-tk` | string | Значение первичного ключа; для составных или нескольких ключей можно передать JSON-массив |
| `--fields` | string[] | Запрашиваемые поля, можно передавать несколько раз или JSON-массивом |
| `--appends` | string[] | Добавляемые связанные поля, можно передавать несколько раз или JSON-массивом |
| `--except` | string[] | Исключаемые поля, можно передавать несколько раз или JSON-массивом |
| `--source-id` | string | ID исходной записи для ресурсов связи |
| `--filter-by-tk` | string | Значение первичного ключа; для составного или нескольких ключей можно передать JSON-массив |
| `--fields` | string[] | Запрашиваемые поля; можно передавать несколько раз или JSON-массивом |
| `--appends` | string[] | Связанные поля для подгрузки; можно передавать несколько раз или JSON-массивом |
| `--except` | string[] | Исключаемые поля; можно передавать несколько раз или JSON-массивом |
Также поддерживаются общие параметры подключения [`nb api resource`](./index.md).
docs/docs/ru/api/cli/api/resource/index.md
+7 -7
View File
@@ -1,12 +1,12 @@
---
title: "nb api resource"
description: "Справочник по команде nb api resource: универсальные CRUD-операции и агрегатные запросы для любых ресурсов NocoBase."
keywords: "nb api resource,NocoBase CLI,CRUD,ресурс,таблица"
keywords: "nb api resource,NocoBase CLI,CRUD,ресурс,коллекция"
---
# nb api resource
Выполнение универсальных CRUD-операций и агрегатных запросов для любых ресурсов NocoBase. Имя ресурса может быть как обычным ресурсом, например `users`, так и связанным ресурсом, например `posts.comments`.
Выполнение универсальных CRUD-операций и агрегатных запросов для любых ресурсов NocoBase. Ресурсом может быть обычный ресурс, например `users`, или ресурс связи, например `posts.comments`.
## Использование
@@ -21,8 +21,8 @@ nb api resource <command>
| [`nb api resource list`](./list.md) | Список записей ресурса |
| [`nb api resource get`](./get.md) | Получение одной записи ресурса |
| [`nb api resource create`](./create.md) | Создание записи ресурса |
| [`nb api resource update`](./update.md) | Обновление записи ресурса |
| [`nb api resource destroy`](./destroy.md) | Удаление записи ресурса |
| [`nb api resource update`](./update.md) | Обновление записей ресурса |
| [`nb api resource destroy`](./destroy.md) | Удаление записей ресурса |
| [`nb api resource query`](./query.md) | Выполнение агрегатных запросов |
## Общие параметры
@@ -32,9 +32,9 @@ nb api resource <command>
| `--api-base-url` | string | Адрес API NocoBase, например `http://localhost:13000/api` |
| `--verbose` | boolean | Показать подробный прогресс |
| `--env`, `-e` | string | Имя окружения |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--role` | string | Переопределение роли, отправляется как HTTP-заголовок `X-Role` |
| `--token`, `-t` | string | Переопределение API key |
| `--token`, `-t` | string | Переопределение ключа API |
| `--json-output`, `-j` / `--no-json-output` | boolean | Выводить ли исходный JSON, по умолчанию включено |
| `--resource` | string | Имя ресурса, обязательно, например `users`, `orders`, `posts.comments` |
| `--data-source` | string | Ключ источника данных, по умолчанию `main` |
@@ -50,7 +50,7 @@ nb api resource create --resource users --values '{"nickname":"Ada"}'
nb api resource list --resource posts.comments --source-id 1 --fields id --fields content
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/api/resource/list.md
+7 -7
View File
@@ -6,7 +6,7 @@ keywords: "nb api resource list,NocoBase CLI,список,ресурс"
# nb api resource list
Вывод списка записей указанного ресурса. Для управления запросом можно использовать параметры `--filter`, `--fields`, `--sort`, `--page` и др.
Вывод списка записей выбранного ресурса. Для управления запросом можно использовать `--filter`, `--fields`, `--sort`, `--page` и связанные параметры.
## Использование
@@ -20,12 +20,12 @@ nb api resource list --resource <resource> [flags]
| --- | --- | --- |
| `--resource` | string | Имя ресурса, обязательно |
| `--data-source` | string | Ключ источника данных, по умолчанию `main` |
| `--source-id` | string | ID исходной записи связанного ресурса |
| `--filter` | string | Условие фильтрации в виде JSON-объекта |
| `--fields` | string[] | Запрашиваемые поля, можно передавать несколько раз или JSON-массивом |
| `--appends` | string[] | Добавляемые связанные поля, можно передавать несколько раз или JSON-массивом |
| `--except` | string[] | Исключаемые поля, можно передавать несколько раз или JSON-массивом |
| `--sort` | string[] | Поля сортировки, например `-createdAt`, можно передавать несколько раз или JSON-массивом |
| `--source-id` | string | ID исходной записи для ресурсов связи |
| `--filter` | string | Условия фильтрации в виде JSON-объекта |
| `--fields` | string[] | Запрашиваемые поля; можно передавать несколько раз или JSON-массивом |
| `--appends` | string[] | Связанные поля для подгрузки; можно передавать несколько раз или JSON-массивом |
| `--except` | string[] | Исключаемые поля; можно передавать несколько раз или JSON-массивом |
| `--sort` | string[] | Поля сортировки, например `-createdAt`; можно передавать несколько раз или JSON-массивом |
| `--page` | integer | Номер страницы |
| `--page-size` | integer | Количество записей на странице |
| `--paginate` / `--no-paginate` | boolean | Использовать ли постраничный вывод |
docs/docs/ru/api/cli/api/resource/query.md
+6 -6
View File
@@ -6,7 +6,7 @@ keywords: "nb api resource query,NocoBase CLI,агрегатный запрос,
# nb api resource query
Выполнение агрегатных запросов к указанному ресурсу. `--measures`, `--dimensions` и `--orders` используют формат JSON-массива.
Выполнение агрегатных запросов к выбранному ресурсу. Параметры `--measures`, `--dimensions` и `--orders` используют формат JSON-массива.
## Использование
@@ -20,14 +20,14 @@ nb api resource query --resource <resource> [flags]
| --- | --- | --- |
| `--resource` | string | Имя ресурса, обязательно |
| `--data-source` | string | Ключ источника данных, по умолчанию `main` |
| `--measures` | string | Определения мер в виде JSON-массива |
| `--measures` | string | Определения показателей в виде JSON-массива |
| `--dimensions` | string | Определения измерений в виде JSON-массива |
| `--orders` | string | Определения сортировки в виде JSON-массива |
| `--filter` | string | Условие фильтрации в виде JSON-объекта |
| `--having` | string | Условие фильтрации после группировки в виде JSON-объекта |
| `--filter` | string | Условия фильтрации в виде JSON-объекта |
| `--having` | string | Условия фильтрации после агрегации в виде JSON-объекта |
| `--limit` | integer | Максимальное количество возвращаемых строк |
| `--offset` | integer | Количество пропускаемых строк |
| `--timezone` | string | Часовой пояс для форматирования запроса |
| `--timezone` | string | Часовой пояс, используемый для форматирования запроса |
Также поддерживаются общие параметры подключения [`nb api resource`](./index.md).
@@ -41,4 +41,4 @@ nb api resource query --resource orders --dimensions '[{"field":["status"],"alia
## Связанные команды
- [`nb api resource list`](./list.md)
- [`nb api Динамические команды`](../dynamic.md)
- [`Динамические команды nb api`](../dynamic.md)
docs/docs/ru/api/cli/api/resource/update.md
+9 -9
View File
@@ -6,7 +6,7 @@ keywords: "nb api resource update,NocoBase CLI,обновление записи
# nb api resource update
Обновление записи указанного ресурса. Для определения записи можно использовать `--filter-by-tk` или `--filter`, а содержимое обновления передаётся через `--values`.
Обновление записей в выбранном ресурсе. Для поиска записей можно использовать `--filter-by-tk` или `--filter`, а данные обновления передаются через `--values`.
## Использование
@@ -20,14 +20,14 @@ nb api resource update --resource <resource> --values <json> [flags]
| --- | --- | --- |
| `--resource` | string | Имя ресурса, обязательно |
| `--data-source` | string | Ключ источника данных, по умолчанию `main` |
| `--source-id` | string | ID исходной записи связанного ресурса |
| `--filter-by-tk` | string | Значение первичного ключа; для составных или нескольких ключей можно передать JSON-массив |
| `--filter` | string | Условие фильтрации в виде JSON-объекта |
| `--values` | string | Данные обновления записи, JSON-объект, обязательно |
| `--whitelist` | string[] | Поля, разрешённые для записи, можно передавать несколько раз или JSON-массивом |
| `--blacklist` | string[] | Поля, запрещённые для записи, можно передавать несколько раз или JSON-массивом |
| `--update-association-values` | string[] | Связанные поля, которые также должны обновляться, можно передавать несколько раз или JSON-массивом |
| `--force-update` / `--no-force-update` | boolean | Принудительно записывать ли значения, которые не изменились |
| `--source-id` | string | ID исходной записи для ресурсов связи |
| `--filter-by-tk` | string | Значение первичного ключа; для составного или нескольких ключей можно передать JSON-массив |
| `--filter` | string | Условия фильтрации в виде JSON-объекта |
| `--values` | string | Данные обновления в виде JSON-объекта, обязательно |
| `--whitelist` | string[] | Поля из белого списка, разрешённые для записи; можно передавать несколько раз или JSON-массивом |
| `--blacklist` | string[] | Поля из чёрного списка, запрещённые для записи; можно передавать несколько раз или JSON-массивом |
| `--update-association-values` | string[] | Связанные поля, которые также нужно обновить; можно передавать несколько раз или JSON-массивом |
| `--force-update` / `--no-force-update` | boolean | Принудительно ли записывать значения, которые не изменились |
Также поддерживаются общие параметры подключения [`nb api resource`](./index.md).
docs/docs/ru/api/cli/app/autostart/disable.md
+8 -8
View File
@@ -1,14 +1,14 @@
---
title: "nb app autostart disable"
description: "Справочник по nb app autostart disable: отключите автозапуск приложения для одного env."
keywords: "nb app autostart disable,NocoBase CLI,autostart,env"
description: "Справочник по команде nb app autostart disable: отключение автозапуска приложения для одного окружения."
keywords: "nb app autostart disable,NocoBase CLI,autostart,окружение"
---
# nb app autostart disable
Отключает флаг автозапуска приложения для одного env.
Отключает флаг автозапуска приложения для одного окружения.
После отключения этот env больше не будет участвовать в `nb app autostart run`. Эта команда сама по себе не останавливает уже работающее приложение. Если вы также хотите остановить текущий runtime, отдельно используйте `nb app stop`.
После отключения это окружение больше не будет участвовать в `nb app autostart run`. Эта команда сама по себе не останавливает уже работающее приложение. Если вы также хотите остановить текущую среду выполнения, отдельно используйте `nb app stop`.
## Использование
@@ -20,8 +20,8 @@ nb app autostart disable [flags]
| Флаг | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env, который будет удален из автозапуска. Если флаг не указан, используется текущий env |
| `--yes`, `-y` | boolean | Пропускает интерактивное подтверждение, когда явный `--env` указывает на env, отличный от текущего |
| `--env`, `-e` | string | Имя CLI-окружения, которое будет удалено из автозапуска; если флаг не указан, используется текущее окружение |
| `--yes`, `-y` | boolean | Пропускает интерактивное подтверждение, когда явный `--env` указывает на окружение, отличное от текущего |
## Примеры
@@ -33,9 +33,9 @@ nb app autostart disable --env app1 --yes
## Примечания
Эта команда меняет только сохраненный флаг автозапуска. Она не останавливает приложение напрямую. Если для env автозапуск и так не был включен, команда просто оставит его в отключенном состоянии.
Эта команда меняет только сохранённый флаг автозапуска. Она не останавливает приложение напрямую. Если для окружения автозапуск и так не был включён, команда просто оставит его в отключённом состоянии.
Как и в случае с `enable`, CLI проверяет меж-env подтверждение только при явной передаче `--env`. В неинтерактивных терминалах или потоках с AI-агентом при необходимости добавляйте `--yes` самостоятельно.
Как и в случае с `enable`, CLI запрашивает подтверждение операции с другим окружением только при явной передаче `--env`. В неинтерактивных терминалах или сессиях ИИ-агента при необходимости добавляйте `--yes` самостоятельно.
## Связанные команды
docs/docs/ru/api/cli/app/autostart/enable.md
+8 -8
View File
@@ -1,14 +1,14 @@
---
title: "nb app autostart enable"
description: "Справочник по nb app autostart enable: включите автозапуск приложения для одного локального или Docker env."
keywords: "nb app autostart enable,NocoBase CLI,autostart,env"
description: "Справочник по команде nb app autostart enable: включение автозапуска приложения для одного локального или Docker-окружения."
keywords: "nb app autostart enable,NocoBase CLI,autostart,окружение"
---
# nb app autostart enable
Включает флаг автозапуска приложения для одного env.
Включает флаг автозапуска приложения для одного окружения.
Этот флаг применяется только к `local` или `docker` env, чей runtime управляется CLI на текущей машине. Он не запускает приложение немедленно. Вместо этого env добавляется в набор, который позже может быть запущен через `nb app autostart run`.
Этот флаг применяется только к окружениям `local` или `docker`, чья среда выполнения управляется CLI на текущей машине. Он не запускает приложение немедленно. Вместо этого окружение добавляется в набор, который позже может быть запущен через `nb app autostart run`.
## Использование
@@ -20,8 +20,8 @@ nb app autostart enable [flags]
| Флаг | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env, который будет добавлен в автозапуск. Если флаг не указан, используется текущий env |
| `--yes`, `-y` | boolean | Пропускает интерактивное подтверждение, когда явный `--env` указывает на env, отличный от текущего |
| `--env`, `-e` | string | Имя CLI-окружения, которое будет добавлено в автозапуск; если флаг не указан, используется текущее окружение |
| `--yes`, `-y` | boolean | Пропускает интерактивное подтверждение, когда явный `--env` указывает на окружение, отличное от текущего |
## Примеры
@@ -33,9 +33,9 @@ nb app autostart enable --env app1 --yes
## Примечания
CLI проверяет, отличается ли целевой env от текущего, только если вы явно передали `--env`. В интерактивных терминалах сначала будет подтверждение. В неинтерактивных терминалах или потоках с AI-агентом вам нужно самостоятельно добавить `--yes` или сначала переключиться на нужный env через `nb env use <name>`.
CLI проверяет, отличается ли целевое окружение от текущего, только если вы явно передали `--env`. В интерактивных терминалах сначала будет подтверждение. В неинтерактивных терминалах или сессиях ИИ-агента вам нужно самостоятельно добавить `--yes` или сначала переключиться на нужное окружение через `nb env use <name>`.
Если целевой env не является управляемым CLI `local` или `docker` runtime на текущей машине, команда завершится ошибкой и не сохранит флаг автозапуска.
Если целевое окружение не является управляемой CLI средой выполнения `local` или `docker` на текущей машине, команда завершится ошибкой и не сохранит флаг автозапуска.
## Связанные команды
docs/docs/ru/api/cli/app/autostart/index.md
+11 -11
View File
@@ -1,19 +1,19 @@
---
title: "nb app autostart"
description: "Справочник по группе команд nb app autostart: включайте или отключайте автозапуск для локальных или Docker env и запускайте все включенные env одним действием."
description: "Справочник по группе команд nb app autostart: включение или отключение автозапуска для локальных или Docker-окружений и запуск всех включённых окружений одним действием."
keywords: "nb app autostart,NocoBase CLI,autostart,local,docker"
---
# nb app autostart
Управляет настройками автозапуска приложения.
Управление настройками автозапуска приложения.
Эта группа команд охватывает два типа задач:
- включение или отключение флага автозапуска для одного env
- запуск всех env, для которых автозапуск уже включен
- включение или отключение флага автозапуска для одного окружения
- запуск всех окружений, для которых автозапуск уже включён
`nb app autostart` применяется только к env с runtime, управляемым CLI на текущей машине, то есть `local` и `docker`. Если env — это только удаленное API-подключение, или это не управляемый CLI runtime приложения, который можно запустить на этой машине, он не может участвовать в этом процессе автозапуска.
`nb app autostart` применяется только к окружениям со средой выполнения, управляемой CLI на текущей машине, то есть `local` и `docker`. Если окружение представляет собой только удалённое API-подключение или это не управляемая CLI среда выполнения приложения, которую можно запустить на этой машине, оно не может участвовать в этом процессе автозапуска.
## Использование
@@ -25,16 +25,16 @@ nb app autostart <command>
| Команда | Описание |
| --- | --- |
| [`nb app autostart enable`](./enable.md) | Включает флаг автозапуска для одного env |
| [`nb app autostart disable`](./disable.md) | Отключает флаг автозапуска для одного env |
| [`nb app autostart list`](./list.md) | Показывает состояние автозапуска всех env |
| [`nb app autostart run`](./run.md) | Запускает все env с включенным автозапуском |
| [`nb app autostart enable`](./enable.md) | Включает флаг автозапуска для одного окружения |
| [`nb app autostart disable`](./disable.md) | Отключает флаг автозапуска для одного окружения |
| [`nb app autostart list`](./list.md) | Показывает состояние автозапуска всех окружений |
| [`nb app autostart run`](./run.md) | Запускает все окружения с включённым автозапуском |
## Примечания
`nb app autostart enable` только помечает env как разрешенный для автоматического запуска. Сам по себе этот флаг не встраивает env в системный процесс загрузки. В реальной production-конфигурации обычно все равно нужно вызывать `nb app autostart run` из собственного механизма запуска хоста, например через `systemd`, стартовый скрипт контейнерной платформы или другой уже используемый boot-процесс.
`nb app autostart enable` только помечает окружение как разрешённое для автоматического запуска. Сам по себе этот флаг не встраивает окружение в системный процесс загрузки. В реальной производственной конфигурации обычно всё равно нужно вызывать `nb app autostart run` из собственного механизма запуска хоста, например через `systemd`, стартовый скрипт контейнерной платформы или другой уже используемый процесс загрузки.
Кроме того, `nb app autostart run` проверяет каждый включенный env по очереди. Env, которые можно запустить, продолжают работу через `nb app start --env <name> --yes`. Env, которые не должны автоматически запускаться на текущей машине, появятся в таблице результатов как `skipped` или `failed`.
Кроме того, `nb app autostart run` проверяет каждое включённое окружение по очереди. Окружения, которые можно запустить, продолжают работу через `nb app start --env <name> --yes`. Окружения, которые не должны автоматически запускаться на текущей машине, появятся в таблице результатов как `skipped` или `failed`.
## Примеры
docs/docs/ru/api/cli/app/autostart/list.md
+9 -9
View File
@@ -1,20 +1,20 @@
---
title: "nb app autostart list"
description: "Справочник по nb app autostart list: покажите состояние автозапуска для всех настроенных env."
keywords: "nb app autostart list,NocoBase CLI,autostart,список env"
description: "Справочник по команде nb app autostart list: вывод состояния автозапуска для всех настроенных окружений."
keywords: "nb app autostart list,NocoBase CLI,autostart,список окружений"
---
# nb app autostart list
Показывает состояние автозапуска для всех настроенных env.
Вывод состояния автозапуска для всех настроенных окружений.
Выходная таблица включает:
- `Current`: помечает текущий env знаком `*`
- `Env`: имя env
- `Kind`: тип env
- `Current`: помечает текущее окружение знаком `*`
- `Env`: имя окружения
- `Kind`: тип окружения
- `Source`: тип установки или источник
- `Autostart`: включен ли автозапуск
- `Autostart`: включён ли автозапуск
## Использование
@@ -30,9 +30,9 @@ nb app autostart list
## Примечания
Если пока нет ни одного сохраненного env, команда выведет `No environments are configured.`.
Если пока нет ни одного сохранённого окружения, команда выведет `No environments are configured.`.
Эта команда показывает только сохраненное состояние CLI. Она не проверяет, запущено ли приложение в данный момент, и не проверяет, вызывает ли уже системный процесс запуска `nb app autostart run`. Ее основная цель — показать, какие env помечены для автозапуска в конфигурации CLI.
Эта команда показывает только сохранённое состояние CLI. Она не проверяет, запущено ли приложение в данный момент, и не проверяет, вызывает ли уже системный процесс загрузки `nb app autostart run`. Её основная цель — показать, какие окружения помечены для автозапуска в конфигурации CLI.
## Связанные команды
docs/docs/ru/api/cli/app/autostart/run.md
+9 -9
View File
@@ -1,14 +1,14 @@
---
title: "nb app autostart run"
description: "Справочник по nb app autostart run: запускайте все env, для которых включен автозапуск приложения."
description: "Справочник по команде nb app autostart run: запуск всех окружений, для которых включён автозапуск приложения."
keywords: "nb app autostart run,NocoBase CLI,autostart,пакетный запуск"
---
# nb app autostart run
Запускает все env, для которых включен автозапуск приложения.
Запускает все окружения, для которых включён автозапуск приложения.
Эта команда обычно вызывается после загрузки хост-системы через ваш собственный механизм запуска. CLI читает все сохраненные env, отбирает те, у которых включен автозапуск, и затем пытается запустить их по одному.
Эта команда обычно вызывается после загрузки хост-системы через ваш собственный механизм запуска. CLI читает все сохранённые окружения, отбирает те, у которых включён автозапуск, и затем пытается запустить их по одному.
## Использование
@@ -20,7 +20,7 @@ nb app autostart run [flags]
| Флаг | Тип | Описание |
| --- | --- | --- |
| `--verbose` | boolean | Показывает необработанный вывод запуска от нижележащих local или Docker-команд |
| `--verbose` | boolean | Показывает исходный вывод запуска от нижележащих локальных или Docker-команд |
## Примеры
@@ -31,13 +31,13 @@ nb app autostart run --verbose
## Примечания
Если ни у одного env не включен автозапуск, команда выведет `No environments have app autostart enabled.`.
Если ни у одного окружения не включён автозапуск, команда выведет `No environments have app autostart enabled.`.
Во время выполнения CLI обрабатывает каждый включенный env по очереди:
Во время выполнения CLI обрабатывает каждое включённое окружение по очереди:
- env, которые можно запустить, отображаются как `started`
- env, которые не должны автоматически запускаться на текущей машине, отображаются как `skipped`
- env, которые завершаются ошибкой при запуске, отображаются как `failed`
- окружения, которые можно запустить, отображаются как `started`
- окружения, которые не должны автоматически запускаться на текущей машине, отображаются как `skipped`
- окружения, которые завершаются ошибкой при запуске, отображаются как `failed`
Внутри команда вызывает `nb app start --env <name> --yes`. Если вы передали `--verbose`, этот флаг также будет передан в нижележащий процесс запуска.
docs/docs/ru/api/cli/app/index.md
+6 -6
View File
@@ -1,12 +1,12 @@
---
title: 'nb app'
description: 'Справочник по команде nb app: управление средой выполнения приложения NocoBase, включая запуск, остановку, перезапуск, журналы и обновление.'
keywords: 'nb app,NocoBase CLI,запуск,остановка,перезапуск,журналы,обновление'
description: 'Справочник по команде nb app: управление средой выполнения приложения NocoBase, включая запуск, остановку, перезапуск, логи и обновление.'
keywords: 'nb app,NocoBase CLI,запуск,остановка,перезапуск,логи,обновление'
---
# nb app
Управляет средой выполнения приложения NocoBase. В npm/Git env команды приложения выполняются в локальном каталоге исходного кода; в Docker env контейнеры приложения управляются на основе сохраненной конфигурации.
Управление средой выполнения приложения NocoBase. В npm/Git-окружениях команды приложения выполняются в локальном каталоге исходного кода; в Docker-окружениях контейнеры приложения управляются на основе сохранённой конфигурации.
## Использование
@@ -18,11 +18,11 @@ nb app <command>
| Команда | Описание |
| -------------------------------- | ------------------------------------------------------------------------------------ |
| [`nb app start`](./start.md) | Запускает приложение или пересоздает Docker-контейнер |
| [`nb app start`](./start.md) | Запускает приложение или пересоздаёт Docker-контейнер |
| [`nb app stop`](./stop.md) | Останавливает приложение или очищает Docker-контейнер |
| [`nb app restart`](./restart.md) | Сначала останавливает, затем запускает приложение |
| [`nb app autostart`](./autostart/index.md) | Управляет пометками автозапуска и запускает все включенные env |
| [`nb app logs`](./logs.md) | Просматривает журналы приложения |
| [`nb app autostart`](./autostart/index.md) | Управляет флагами автозапуска и запускает все включённые окружения |
| [`nb app logs`](./logs.md) | Просматривает логи приложения |
| [`nb app upgrade`](./upgrade.md) | Останавливает приложение, заменяет исходный код или образ, затем снова запускает его |
## Примеры
docs/docs/ru/api/cli/app/logs.md
+5 -5
View File
@@ -1,6 +1,6 @@
---
title: "nb app logs"
description: "Справочник по команде nb app logs: просмотр логов приложения NocoBase указанного env."
description: "Справочник по команде nb app logs: просмотр логов приложения NocoBase выбранного окружения."
keywords: "nb app logs,NocoBase CLI,логи приложения,Docker logs,pm2 logs"
---
@@ -18,9 +18,9 @@ nb app logs [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env для просмотра логов; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--tail` | integer | Количество последних строк логов, отображаемых перед началом отслеживания, по умолчанию `100` |
| `--env`, `-e` | string | Имя CLI-окружения для просмотра логов; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--tail` | integer | Количество последних строк логов, отображаемых перед началом отслеживания; по умолчанию `100` |
| `--follow`, `-f` / `--no-follow` | boolean | Отслеживать ли новые логи в реальном времени |
## Примеры
@@ -32,7 +32,7 @@ nb app logs --env app1 --tail 200
nb app logs --env app1 --no-follow
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/app/restart.md
+6 -6
View File
@@ -1,12 +1,12 @@
---
title: "nb app restart"
description: "Справочник по команде nb app restart: перезапуск приложения NocoBase указанного env; при необходимости CLI сначала синхронизирует коммерческие плагины, разрешённые текущей лицензией, затем локальные env автоматически выполняют необходимую подготовку установки или обновления во время перезапуска, а для Docker env контейнер приложения пересоздаётся из сохранённой конфигурации."
description: "Справочник по команде nb app restart: перезапуск приложения NocoBase выбранного окружения; при необходимости CLI сначала синхронизирует коммерческие плагины, разрешённые текущей лицензией, затем локальные окружения автоматически выполняют необходимую подготовку установки или обновления во время перезапуска, а для Docker-окружений контейнер приложения пересоздаётся из сохранённой конфигурации."
keywords: "nb app restart,NocoBase CLI,перезапуск приложения,Docker"
---
# nb app restart
Остановка и повторный запуск приложения NocoBase указанного env. Если это применимо, CLI сначала синхронизирует коммерческие плагины, разрешённые текущей лицензией. Затем локальные env повторно используют поток `nb app stop` и `nb app start` и по умолчанию автоматически выполняют необходимую подготовку установки или обновления перед повторным запуском; Docker env сначала удаляют текущий контейнер, а затем пересоздают контейнер приложения на основе сохранённой конфигурации env.
Остановка и повторный запуск приложения NocoBase выбранного окружения. Если это применимо, CLI сначала синхронизирует коммерческие плагины, разрешённые текущей лицензией. Затем локальные окружения повторно используют поток `nb app stop` и `nb app start` и по умолчанию автоматически выполняют необходимую подготовку установки или обновления перед повторным запуском; Docker-окружения сначала удаляют текущий контейнер, а затем пересоздают контейнер приложения на основе сохранённой конфигурации окружения.
## Использование
@@ -18,8 +18,8 @@ nb app restart [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env для перезапуска; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--env`, `-e` | string | Имя CLI-окружения для перезапуска; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--verbose` | boolean | Показать вывод низкоуровневых команд остановки и запуска |
## Примеры
@@ -31,9 +31,9 @@ nb app restart --env local --verbose
nb app restart --env local-docker
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
По умолчанию, если это применимо, CLI сначала выполняет `nb license plugins sync --skip-if-no-license`, чтобы синхронизировать коммерческие плагины, разрешённые текущей лицензией. Затем локальные env автоматически выполняют необходимую подготовку установки или обновления перед повторным запуском, а Docker env завершают этот шаг до пересоздания контейнера. Каждый раз, когда CLI нужно дождаться готовности приложения, она проверяет `__health_check`: сначала выводит одну строку ожидания, а затем одну строку прогресса каждые 10 секунд, пока приложение не станет доступно или не истечёт время ожидания.
По умолчанию, если это применимо, CLI сначала выполняет `nb license plugins sync --skip-if-no-license`, чтобы синхронизировать коммерческие плагины, разрешённые текущей лицензией. Затем локальные окружения автоматически выполняют необходимую подготовку установки или обновления перед повторным запуском, а Docker-окружения завершают этот шаг до пересоздания контейнера. Каждый раз, когда CLI нужно дождаться готовности приложения, она проверяет `__health_check`: сначала выводит одну строку ожидания, а затем одну строку прогресса каждые 10 секунд, пока приложение не станет доступно или не истечёт время ожидания.
## Hook-скрипты
docs/docs/ru/api/cli/app/start.md
+7 -5
View File
@@ -1,12 +1,12 @@
---
title: "nb app start"
description: "Справочник по команде nb app start: запуск приложения NocoBase указанного env; при необходимости CLI сначала синхронизирует коммерческие плагины, разрешённые текущей лицензией, затем локальные env автоматически выполняют необходимую подготовку установки или обновления перед запуском, а для Docker env контейнер приложения пересоздаётся из сохранённой конфигурации."
description: "Справочник по команде nb app start: запуск приложения NocoBase выбранного окружения; при необходимости CLI сначала синхронизирует коммерческие плагины, разрешённые текущей лицензией, затем локальные окружения автоматически выполняют необходимую подготовку установки или обновления перед запуском, а для Docker-окружений контейнер приложения пересоздаётся из сохранённой конфигурации."
keywords: "nb app start,NocoBase CLI,запуск приложения,Docker,pm2"
---
# nb app start
Запуск приложения NocoBase указанного env. Если это применимо, CLI сначала синхронизирует коммерческие плагины, разрешённые текущей лицензией. Затем установки npm/Git автоматически выполняют необходимую подготовку установки или обновления перед запуском локальных команд приложения, а установки Docker пересоздают контейнер приложения из сохранённой конфигурации env.
Запуск приложения NocoBase выбранного окружения. Если это применимо, CLI сначала синхронизирует коммерческие плагины, разрешённые текущей лицензией. Затем установки npm/Git автоматически выполняют необходимую подготовку установки или обновления перед запуском локальных команд приложения, а установки Docker пересоздают контейнер приложения из сохранённой конфигурации окружения.
## Использование
@@ -18,8 +18,8 @@ nb app start [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env для запуска; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--env`, `-e` | string | Имя CLI-окружения для запуска; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--verbose` | boolean | Показать вывод низкоуровневых локальных или Docker-команд |
## Примеры
@@ -31,7 +31,9 @@ nb app start --env local --verbose
nb app start --env local-docker
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
По умолчанию, если это применимо, CLI сначала выполняет `nb license plugins sync --skip-if-no-license`, чтобы синхронизировать коммерческие плагины, разрешённые текущей лицензией. Затем локальные окружения автоматически выполняют необходимую подготовку установки или обновления перед запуском, а Docker-окружения пересоздают контейнер приложения из сохранённой конфигурации окружения. Каждый раз, когда CLI нужно дождаться готовности приложения, она проверяет `__health_check`: сначала выводит одну строку ожидания, а затем одну строку прогресса каждые 10 секунд, пока приложение не станет доступно или не истечёт время ожидания.
По умолчанию, если это применимо, CLI сначала выполняет `nb license plugins sync --skip-if-no-license`, чтобы синхронизировать коммерческие плагины, разрешённые текущей лицензией. Затем локальные env автоматически выполняют необходимую подготовку установки или обновления перед запуском в фоне, а Docker env пересоздают контейнер приложения из сохранённой конфигурации env. Каждый раз, когда CLI нужно дождаться готовности приложения, она проверяет `__health_check`: сначала выводит одну строку ожидания, а затем одну строку прогресса каждые 10 секунд, пока приложение не станет доступно или не истечёт время ожидания.
docs/docs/ru/api/cli/app/stop.md
+11 -11
View File
@@ -1,14 +1,14 @@
---
title: 'nb app stop'
description: 'Справка по команде nb app stop: останавливает приложение NocoBase для указанного env и при необходимости также очищает контейнер встроенной базы данных, управляемый CLI.'
keywords: 'nb app stop,NocoBase CLI,остановить приложение,Docker,with-db,встроенная база данных'
description: 'Справочник по команде nb app stop: останавливает приложение NocoBase для указанного окружения и при необходимости также очищает контейнер встроенной базы данных, управляемой CLI.'
keywords: 'nb app stop,NocoBase CLI,остановка приложения,Docker,with-db,встроенная база данных'
---
# nb app stop
Останавливает приложение NocoBase для указанного env. При установке через npm/Git команда останавливает локальный процесс приложения, а при установке через Docker очищает сохраненный контейнер приложения.
Останавливает приложение NocoBase для указанного окружения. При установке через npm/Git команда останавливает локальный процесс приложения, а при установке через Docker очищает сохранённый контейнер приложения.
Если вы передадите `--with-db` и этот env использует встроенную базу данных, управляемую CLI, команда также очистит контейнер базы данных. Если этот env использует внешнюю базу данных, ресурсы базы данных затронуты не будут.
Если вы передадите `--with-db` и это окружение использует встроенную базу данных, управляемую CLI, команда также очистит контейнер базы данных. Если это окружение использует внешнюю базу данных, ресурсы базы данных затронуты не будут.
## Использование
@@ -20,10 +20,10 @@ nb app stop [flags]
| Параметр | Тип | Описание |
| ------------- | ------- | ----------------------------------------------------------------------------------------------------------- |
| `--env`, `-e` | string | Имя CLI env, который нужно остановить; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Пропустить интерактивное подтверждение, когда env, явно указанный через `--env`, отличается от текущего env |
| `--env`, `-e` | string | Имя CLI-окружения, которое нужно остановить; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Пропустить интерактивное подтверждение, когда окружение, явно указанное через `--env`, отличается от текущего |
| `--with-db` | boolean | Также очищает контейнер базы данных, если существует встроенная база данных, управляемая CLI |
| `--verbose` | boolean | Показывает вывод базовых локальных или Docker-команд |
| `--verbose` | boolean | Показывает вывод низкоуровневых локальных или Docker-команд |
## Примеры
@@ -35,13 +35,13 @@ nb app stop --env local --verbose
nb app stop --env local-docker
```
## Описание
## Примечания
CLI проверяет, совпадает ли указанный env с текущим env, только если вы явно передаете `--env`. Если явно указан другой env, в интерактивном терминале сначала будет запрошено подтверждение; в неинтерактивном терминале или в сценарии AI-агента вам нужно самостоятельно явно добавить `--yes` либо сначала выполнить `nb env use <name>`, а затем повторить попытку.
CLI проверяет, совпадает ли указанное окружение с текущим, только если вы явно передаёте `--env`. Если явно указано другое окружение, в интерактивном терминале сначала будет запрошено подтверждение; в неинтерактивном терминале или в сессии ИИ-агента вам нужно самостоятельно явно добавить `--yes` либо сначала выполнить `nb env use <name>`, а затем повторить попытку.
`--with-db` влияет только на контейнеры встроенной базы данных, управляемые CLI. Обычно, если вы хотите просто остановить само приложение, этот параметр не нужен; добавляйте его только если вы также хотите остановить runtime встроенной базы данных на текущей машине.
`--with-db` влияет только на контейнеры встроенной базы данных, управляемые CLI. Обычно, если вы хотите просто остановить само приложение, этот параметр не нужен; добавляйте его только если вы также хотите остановить среду выполнения встроенной базы данных на текущей машине.
Эта команда может работать только с локальным или Docker runtime на текущей машине. Если env представляет собой только подключение к HTTP API или является зарезервированным SSH env, `nb app stop` не сможет удаленно остановить его за вас.
Эта команда может работать только с локальной или Docker-средой выполнения на текущей машине. Если окружение представляет собой только подключение к HTTP API или является зарезервированным SSH-окружением, `nb app stop` не сможет удалённо остановить его за вас.
## Связанные команды
docs/docs/ru/api/cli/app/upgrade.md
+9 -9
View File
@@ -1,12 +1,12 @@
---
title: "nb app upgrade"
description: "Справочник по команде nb app upgrade: остановка приложения, замена сохранённых исходников или образа, а затем выполнение обновления и запуска выбранного приложения NocoBase."
keywords: "nb app upgrade,NocoBase CLI,обновление,апгрейд,Docker-образ"
keywords: "nb app upgrade,NocoBase CLI,обновление,Docker-образ"
---
# nb app upgrade
Обновление выбранного приложения NocoBase. CLI сначала останавливает текущее приложение, по умолчанию заменяет сохранённые исходники или образ, синхронизирует коммерческие плагины, выполняет обновление и запуск приложения, а в конце обновляет runtime env. Docker env во время запуска пересоздают контейнер приложения из сохранённой конфигурации env.
Обновление выбранного приложения NocoBase. CLI сначала останавливает текущее приложение, по умолчанию заменяет сохранённые исходники или образ, синхронизирует коммерческие плагины, выполняет обновление и запуск приложения, а в конце обновляет среду выполнения окружения. Docker-окружения во время запуска пересоздают контейнер приложения из сохранённой конфигурации окружения.
## Использование
@@ -18,11 +18,11 @@ nb app upgrade [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env для обновления; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--force`, `-f` | boolean | Пропускает подтверждение обновления. В неинтерактивных терминалах и сессиях AI-агента этот флаг нужно передавать явно |
| `--env`, `-e` | string | Имя CLI-окружения для обновления; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--force`, `-f` | boolean | Пропускает подтверждение обновления. В неинтерактивных терминалах и сессиях ИИ-агента этот флаг нужно передавать явно |
| `--skip-download`, `-s` | boolean | Пропустить загрузку исходников или образа и выполнить поток обновления и запуска на основе уже сохранённых локальных исходников или Docker-образа; также пропускает `nb license plugins sync` |
| `--version` | string | Переопределяет целевую версию этого обновления; после успешного выполнения новая версия будет записана в `downloadVersion` конфигурации env |
| `--version` | string | Переопределяет целевую версию этого обновления; после успешного выполнения новая версия будет записана в `downloadVersion` конфигурации окружения |
| `--verbose` | boolean | Показать вывод низкоуровневых команд обновления и перезапуска |
## Примеры
@@ -39,9 +39,9 @@ nb app upgrade --env local --verbose
nb app upgrade --env local-docker --skip-download
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Перед фактическим началом обновления интерактивный терминал также запросит дополнительное подтверждение обновления, если только вы явно не передали `--force`. В неинтерактивных терминалах и сессиях AI-агента `nb app upgrade` откажется продолжать без `--force` и выведет команду для повторного запуска, которую можно сразу скопировать. Если это ещё и cross-env операция, понадобятся и `--yes`, и `--force`.
Перед фактическим началом обновления интерактивный терминал также запросит дополнительное подтверждение обновления, если только вы явно не передали `--force`. В неинтерактивных терминалах и сессиях ИИ-агента `nb app upgrade` откажется продолжать без `--force` и выведет команду для повторного запуска, которую можно сразу скопировать. Если это ещё и операция с другим окружением, понадобятся и `--yes`, и `--force`.
По умолчанию `nb app upgrade` выполняет следующие шаги:
@@ -54,7 +54,7 @@ nb app upgrade --env local-docker --skip-download
Если передан `--skip-download`, CLI пропускает шаги 2 и 3 и сразу выполняет поток обновления и запуска на основе текущих сохранённых исходников или образа. Если также передан `--version`, CLI не будет загружать эту версию в рамках этого запуска, а только сохранит её как новую `downloadVersion` после успешного запуска, чтобы будущие обновления могли её использовать.
На шаге 4 CLI автоматически выполнит необходимую подготовку обновления для текущего состояния кода, а затем будет ждать, пока приложение не пройдёт `__health_check`. Во время ожидания CLI сначала выводит одну строку ожидания, а затем одну строку прогресса каждые 10 секунд, пока приложение не будет готово или пока health check не достигнет таймаута.
На шаге 4 CLI автоматически выполнит необходимую подготовку обновления для текущего состояния кода, а затем будет ждать, пока приложение не пройдёт `__health_check`. Во время ожидания CLI сначала выводит одну строку ожидания, а затем одну строку прогресса каждые 10 секунд, пока приложение не будет готово или пока проверка работоспособности не достигнет таймаута.
Если последний шаг `nb env update` завершится ошибкой, обновление всё равно считается успешным. CLI выведет предупреждение и попросит затем вручную выполнить `nb env update <envName>`.
docs/docs/ru/api/cli/backup/create.md
+9 -9
View File
@@ -1,12 +1,12 @@
---
title: 'nb backup create'
description: 'Справка по команде nb backup create: создать резервную копию через выбранный env и скачать файл резервной копии локально.'
description: 'Справочник по команде nb backup create: создание резервной копии через выбранное окружение и локальная загрузка файла резервной копии.'
keywords: 'nb backup create,NocoBase CLI,создать резервную копию,скачать резервную копию,nbdata'
---
# nb backup create
Создаёт резервную копию через выбранный env и скачивает файл резервной копии локально. Если `--output` опущен, CLI сохранит файл в текущем рабочем каталоге и использует имя файла резервной копии, возвращённое удалённой стороной — обычно это `backup_*.nbdata`.
Создаёт резервную копию через выбранное окружение и скачивает файл резервной копии локально. Если `--output` не указан, CLI сохранит файл в текущем рабочем каталоге и использует имя файла резервной копии, возвращённое удалённой стороной — обычно это `backup_*.nbdata`.
## Использование
@@ -18,10 +18,10 @@ nb backup create [flags]
| Параметр | Тип | Описание |
| --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--env`, `-e` | string | Имя CLI env, для которого нужно создать резервную копию; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Пропустить интерактивное подтверждение, если env, явно указанный через `--env`, отличается от текущего env |
| `--env`, `-e` | string | Имя CLI-окружения, для которого нужно создать резервную копию; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Пропускает интерактивное подтверждение, если окружение, явно указанное через `--env`, отличается от текущего |
| `--output`, `-o` | string | Целевой путь для загрузки. Если не указан, сохраняется в текущий каталог; если указывает на существующий каталог, имя файла резервной копии с удалённой стороны будет добавлено автоматически |
| `--json-output`, `-j` | boolean | Вывести итоговый результат в формате JSON, включая поля `env`, `name` и `output` |
| `--json-output`, `-j` | boolean | Выводит итоговый результат в формате JSON, включая поля `env`, `name` и `output` |
## Примеры
@@ -33,15 +33,15 @@ nb backup create --env e2e --output ./backups --yes
nb backup create --env e2e --json-output
```
## Описание
## Примечания
CLI проверяет, совпадает ли `--env` с текущим env, только если вы явно передали `--env`. Если явно указан другой env, в интерактивном терминале сначала будет запрошено подтверждение; в неинтерактивном терминале или в сценарии AI agent вам нужно самостоятельно явно добавить `--yes` либо сначала выполнить `nb env use <name>`, а затем повторить попытку.
CLI проверяет, совпадает ли `--env` с текущим окружением, только если вы явно передали `--env`. Если явно указано другое окружение, в интерактивном терминале сначала будет запрошено подтверждение; в неинтерактивном терминале или в сессии ИИ-агента вам нужно самостоятельно явно добавить `--yes` либо сначала выполнить `nb env use <name>`, а затем повторить попытку.
Процесс создания делится на два этапа: сначала вызывается backup API целевого env для создания удалённой резервной копии, затем каждые 2 секунды выполняется опрос статуса; после завершения резервного копирования файл скачивается локально. Если спустя 600 секунд удалённая сторона всё ещё возвращает `inProgress: true`, команда завершится по тайм-ауту.
Процесс создания делится на два этапа: сначала вызывается API резервного копирования целевого окружения для создания удалённой резервной копии, затем каждые 2 секунды выполняется опрос статуса; после завершения резервного копирования файл скачивается локально. Если спустя 600 секунд удалённая сторона всё ещё возвращает `inProgress: true`, команда завершится по таймауту.
`--output` может быть как путём к файлу, так и путём к существующему каталогу. CLI распознаёт как каталог только уже существующий путь; если путь не существует, он будет обработан как путь к целевому файлу.
После передачи `--json-output` CLI больше не выводит текст прогресса, а сразу печатает итоговый JSON-результат. Этот режим лучше подходит для дальнейшего использования в скриптах и цепочках agent.
После передачи `--json-output` CLI больше не выводит текст прогресса, а сразу печатает итоговый JSON-результат. Этот режим лучше подходит для дальнейшего использования в скриптах и сценариях ИИ-агента.
## Связанные команды
docs/docs/ru/api/cli/backup/index.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: 'nb backup'
description: 'Справка по команде nb backup: создайте резервную копию NocoBase и скачайте её локально или восстановите локальный файл резервной копии в целевой env.'
description: 'Справочник по команде nb backup: создание резервной копии NocoBase с локальной загрузкой или восстановление локального файла резервной копии в целевое окружение.'
keywords: 'nb backup,NocoBase CLI,резервная копия,восстановление,nbdata'
---
# nb backup
Создаёт или восстанавливает резервную копию NocoBase. `nb backup create` создаёт удалённую резервную копию в целевом env, а затем скачивает файл резервной копии локально; `nb backup restore` загружает локальный файл резервной копии в целевой env и ждёт, пока приложение снова станет готово.
Создание или восстановление резервной копии NocoBase. `nb backup create` создаёт удалённую резервную копию в целевом окружении, а затем скачивает файл резервной копии локально; `nb backup restore` загружает локальный файл резервной копии в целевое окружение и ждёт, пока приложение снова станет готово.
## Использование
@@ -19,7 +19,7 @@ nb backup <command>
| Команда | Описание |
| ----------------------------------- | --------------------------------------------------------- |
| [`nb backup create`](./create.md) | Создать резервную копию и скачать её локально |
| [`nb backup restore`](./restore.md) | Восстановить локальный файл резервной копии в целевой env |
| [`nb backup restore`](./restore.md) | Восстановить локальный файл резервной копии в целевое окружение |
## Примеры
@@ -32,7 +32,7 @@ nb backup restore --env app1 --file ./backups/backup_20260520_190408_8397.nbdata
## Примечания
Перед выполнением CLI сначала проверяет, предоставляет ли целевой env runtime-команды, связанные с резервным копированием. Если каких-то команд не хватает, runtime-кеш автоматически обновляется один раз; если после обновления возможность `nb api backup ...` всё ещё отсутствует, это означает, что в целевом env ещё не включены или не синхронизированы возможности backup/restore, и в таком случае сначала нужно разобраться с самим целевым приложением.
Перед выполнением CLI сначала проверяет, предоставляет ли целевое окружение команды среды выполнения, связанные с резервным копированием. Если каких-то команд не хватает, кэш среды выполнения автоматически обновляется один раз; если после обновления возможность `nb api backup ...` всё ещё отсутствует, это означает, что в целевом окружении ещё не включены или не синхронизированы возможности резервного копирования и восстановления, и в таком случае сначала нужно разобраться с самим целевым приложением.
А именно:
docs/docs/ru/api/cli/backup/restore.md
+9 -9
View File
@@ -1,12 +1,12 @@
---
title: 'nb backup restore'
description: 'Справка по команде nb backup restore: восстанавливает локальный файл резервной копии в целевой env.'
description: 'Справочник по команде nb backup restore: восстановление локального файла резервной копии в целевое окружение.'
keywords: 'nb backup restore,NocoBase CLI,восстановить резервную копию,восстановление,nbdata'
---
# nb backup restore
Восстанавливает локальный файл резервной копии в целевой env. Обычно здесь используется файл `*.nbdata`. Восстановление перезапишет данные целевого приложения, поэтому CLI по умолчанию запрашивает дополнительное подтверждение.
Восстанавливает локальный файл резервной копии в целевое окружение. Обычно здесь используется файл `*.nbdata`. Восстановление перезапишет данные целевого приложения, поэтому CLI по умолчанию запрашивает дополнительное подтверждение.
## Использование
@@ -18,10 +18,10 @@ nb backup restore --file <path> [flags]
| Параметр | Тип | Описание |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `--env`, `-e` | string | Имя CLI env, в который нужно восстановить данные; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Пропускает интерактивное подтверждение, если env, явно указанный через `--env`, отличается от текущего env |
| `--env`, `-e` | string | Имя CLI-окружения, в которое нужно восстановить данные; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Пропускает интерактивное подтверждение, если окружение, явно указанное через `--env`, отличается от текущего |
| `--file`, `-f` | string | Путь к локальному файлу резервной копии; обязательно |
| `--force` | boolean | Подтверждает перезапись данных приложения; должен быть явно указан в неинтерактивных терминалах и сессиях AI agent |
| `--force` | boolean | Подтверждает перезапись данных приложения; должен быть явно указан в неинтерактивных терминалах и сессиях ИИ-агента |
## Примеры
@@ -30,15 +30,15 @@ nb backup restore --file ./backups/base.nbdata --force
nb backup restore --env e2e --file ./backups/base.nbdata --yes --force
```
## Описание
## Примечания
CLI проверяет, совпадает ли `--env` с текущим env, только если вы явно передали `--env`. Если явно указан другой env, в интерактивном терминале сначала будет запрошено подтверждение; в неинтерактивных терминалах или в сценариях AI agent вам нужно явно добавить `--yes` самостоятельно либо сначала выполнить `nb env use <name>`, а затем повторить попытку.
CLI проверяет, совпадает ли `--env` с текущим окружением, только если вы явно передали `--env`. Если явно указано другое окружение, в интерактивном терминале сначала будет запрошено подтверждение; в неинтерактивных терминалах или в сессиях ИИ-агента вам нужно явно добавить `--yes` самостоятельно либо сначала выполнить `nb env use <name>`, а затем повторить попытку.
Перед выполнением CLI сначала проверяет, существует ли путь, указанный в `--file`, и подтверждает, что это обычный файл. Если путь не существует или указывает на каталог, команда немедленно завершится ошибкой.
Если `--force` не передан, в интерактивном терминале появится еще одно подтверждение с явным указанием, что это восстановление перезапишет данные приложения. В неинтерактивных терминалах и сессиях AI agent при отсутствии `--force` CLI сразу откажется выполнять команду и выдаст подсказку для повторного запуска, которую можно сразу скопировать. Если при этом операция выполняется между разными env, обычно нужно передать и `--yes`, и `--force`.
Если `--force` не передан, в интерактивном терминале появится ещё одно подтверждение с явным указанием, что это восстановление перезапишет данные приложения. В неинтерактивных терминалах и сессиях ИИ-агента при отсутствии `--force` CLI сразу откажется выполнять команду и выдаст подсказку для повторного запуска, которую можно сразу скопировать. Если при этом это ещё и операция с другим окружением, обычно нужно передать и `--yes`, и `--force`.
После успешной загрузки CLI продолжит ждать, пока целевое приложение снова не пройдет `__health_check`. Иными словами, к моменту успешного завершения команды приложение обычно уже восстановлено до доступного состояния.
После успешной загрузки CLI продолжит ждать, пока целевое приложение снова не пройдёт `__health_check`. Иными словами, к моменту успешного завершения команды приложение обычно уже восстановлено до доступного состояния.
## Связанные команды
docs/docs/ru/api/cli/config/delete.md
+3 -1
View File
@@ -1,6 +1,6 @@
---
title: "nb config delete"
description: "Справка по команде nb config delete: удалить явно заданный параметр конфигурации CLI."
description: "Справочник по команде nb config delete: удаление явно заданного параметра конфигурации CLI."
keywords: "nb config delete,NocoBase CLI,удалить конфигурацию"
---
@@ -29,6 +29,8 @@ nb config delete docker.network
nb config delete docker.container-prefix
nb config delete proxy.nb-cli-root
nb config delete proxy.upstream-host
nb config delete proxy.nginx-driver
nb config delete proxy.caddy-driver
nb config delete bin.nginx
nb config delete bin.git
nb config delete bin.pnpm
docs/docs/ru/api/cli/config/get.md
+4 -2
View File
@@ -1,12 +1,12 @@
---
title: "nb config get"
description: "Справка по команде nb config get: прочитать фактическое значение параметра конфигурации CLI."
description: "Справочник по команде nb config get: чтение эффективного значения параметра конфигурации CLI."
keywords: "nb config get,NocoBase CLI,читать конфигурацию"
---
# nb config get
Читает фактическое значение указанного параметра конфигурации CLI. Если он не был задан явно, будет возвращено значение по умолчанию.
Читает эффективное значение указанного параметра конфигурации CLI. Если он не был задан явно, будет возвращено значение по умолчанию.
## Использование
@@ -30,6 +30,8 @@ nb config get docker.network
nb config get docker.container-prefix
nb config get proxy.nb-cli-root
nb config get proxy.upstream-host
nb config get proxy.nginx-driver
nb config get proxy.caddy-driver
nb config get bin.nginx
nb config get bin.git
```
docs/docs/ru/api/cli/config/index.md
+13 -13
View File
@@ -1,7 +1,7 @@
---
title: "nb config"
description: "Справка по nb config: управление значениями конфигурации CLI NocoBase по умолчанию."
keywords: "nb config,NocoBase CLI,configuration,default configuration"
description: "Справочник по команде nb config: управление значениями конфигурации CLI NocoBase по умолчанию."
keywords: "nb config,NocoBase CLI,конфигурация,конфигурация по умолчанию"
---
# nb config
@@ -9,9 +9,9 @@ keywords: "nb config,NocoBase CLI,configuration,default configuration"
Управляет значениями конфигурации CLI по умолчанию. Поддерживаемые сейчас ключи в основном делятся на такие группы:
- Сама CLI: `locale`, `update.policy`, `license.pkg-url`
- Docker runtime: `docker.network`, `docker.container-prefix`
- Внешние исполняемые файлы: `bin.docker`, `bin.caddy`, `bin.git`, `bin.nginx`, `bin.pnpm`, `bin.yarn`
- Генерация proxy: `proxy.nb-cli-root`, `proxy.upstream-host`, `proxy.nginx-driver`, `proxy.caddy-driver`
- Среда выполнения Docker: `docker.network`, `docker.container-prefix`
- Внешние исполняемые файлы: `bin.docker`, `bin.caddy`, `bin.git`, `bin.nginx`, `bin.yarn`
- Генерация прокси: `proxy.nb-cli-root`, `proxy.upstream-host`, `proxy.nginx-driver`, `proxy.caddy-driver`
Большинству проектов нужна только часть этих ключей. На практике чаще всего используются:
@@ -27,7 +27,7 @@ keywords: "nb config,NocoBase CLI,configuration,default configuration"
| --- | --- | --- |
| `locale` | определяется по текущим правилам CLI | Переопределяет язык, используемый CLI |
| `update.policy` | `prompt` | Политика обновления при запуске: `prompt`, `auto` или `off` |
| `license.pkg-url` | `https://pkg.nocobase.com/` | Переопределяет URL загрузки пакетов коммерческих расширений |
| `license.pkg-url` | `https://pkg.nocobase.com/` | Переопределяет URL загрузки коммерческих плагинов |
| `docker.network` | `nocobase` | Сеть по умолчанию для Docker-приложений, управляемых CLI |
| `docker.container-prefix` | `nb` | Префикс по умолчанию для Docker-контейнеров, управляемых CLI |
| `bin.docker` | `docker` | Переопределяет путь к исполняемому файлу Docker |
@@ -36,10 +36,10 @@ keywords: "nb config,NocoBase CLI,configuration,default configuration"
| `bin.nginx` | `nginx` | Переопределяет путь к исполняемому файлу Nginx |
| `bin.pnpm` | `pnpm` | Переопределяет путь к исполняемому файлу pnpm |
| `bin.yarn` | `yarn` | Переопределяет путь к исполняемому файлу Yarn |
| `proxy.nb-cli-root` | корень CLI, обычно домашний каталог текущего пользователя | Переопределяет корневой путь, который видит сгенерированная proxy-конфигурация, когда proxy-процесс и CLI не видят один и тот же корень файловой системы |
| `proxy.upstream-host` | `127.0.0.1` | Переопределяет хост, который proxy использует для пересылки трафика обратно в приложение NocoBase |
| `proxy.nginx-driver` | `local` | Драйвер runtime по умолчанию для `nb proxy nginx` |
| `proxy.caddy-driver` | `local` | Драйвер runtime по умолчанию для `nb proxy caddy` |
| `proxy.nb-cli-root` | корень CLI, обычно домашний каталог текущего пользователя | Переопределяет корневой путь, который видит сгенерированная конфигурация прокси, когда процесс прокси и CLI не видят один и тот же корень файловой системы |
| `proxy.upstream-host` | `127.0.0.1` | Переопределяет хост, который прокси использует для пересылки трафика обратно в приложение NocoBase |
| `proxy.nginx-driver` | `local` | Драйвер среды выполнения по умолчанию для `nb proxy nginx` |
| `proxy.caddy-driver` | `local` | Драйвер среды выполнения по умолчанию для `nb proxy caddy` |
## Использование
@@ -79,9 +79,9 @@ nb config delete docker.container-prefix
- `bin.nginx` и `bin.caddy` влияют только на драйвер `local` для `nb proxy nginx` и `nb proxy caddy`
- `bin.pnpm` используется, когда командам нужно запускать pnpm напрямую, например при обновлении глобальной установки CLI, управляемой pnpm, через `nb self update`
- `proxy.nginx-driver` и `proxy.caddy-driver` хранят драйвер по умолчанию для каждого provider
- `proxy.nb-cli-root` и `proxy.upstream-host` — это расширенные proxy-override-настройки. Для большинства CLI-managed env типов `local` и `docker` достаточно значений по умолчанию
- Если вам нужно только переключить активный proxy-драйвер, обычно понятнее использовать `nb proxy nginx use` или `nb proxy caddy use`, чем вручную менять ключ конфигурации
- `proxy.nginx-driver` и `proxy.caddy-driver` хранят драйвер по умолчанию для каждого провайдера
- `proxy.nb-cli-root` и `proxy.upstream-host` — это расширенные настройки прокси. Для большинства окружений типов `local` и `docker`, управляемых CLI, достаточно значений по умолчанию
- Если вам нужно только переключить активный драйвер прокси, обычно понятнее использовать `nb proxy nginx use` или `nb proxy caddy use`, чем вручную менять ключ конфигурации
## Связанные команды
docs/docs/ru/api/cli/config/list.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: "nb config list"
description: "Справочник по команде nb config list: список явно заданных настроек CLI."
keywords: "nb config list,NocoBase CLI,configuration"
description: "Справочник по команде nb config list: список явно заданных параметров конфигурации CLI."
keywords: "nb config list,NocoBase CLI,конфигурация"
---
# nb config list
Показывает явно заданные настройки CLI. Значения по умолчанию, которые никогда не задавались явно, не отображаются.
Показывает явно заданные параметры конфигурации CLI. Значения по умолчанию, которые никогда не задавались явно, не отображаются.
## Использование
@@ -22,7 +22,7 @@ nb config list
## Примечания
Если значения конфигурации не заданы, CLI выведет `No CLI config values are set.`.
Если параметры конфигурации не заданы, CLI выведет `No CLI config values are set.`.
## Связанные команды
docs/docs/ru/api/cli/config/set.md
+3 -1
View File
@@ -1,6 +1,6 @@
---
title: "nb config set"
description: "Справка по команде nb config set: задать параметр конфигурации CLI."
description: "Справочник по команде nb config set: задание параметра конфигурации CLI."
keywords: "nb config set,NocoBase CLI,задать конфигурацию"
---
@@ -36,6 +36,8 @@ nb config set bin.nginx /usr/sbin/nginx
nb config set bin.pnpm /usr/local/bin/pnpm
nb config set proxy.nb-cli-root /workspace
nb config set proxy.upstream-host host.docker.internal
nb config set proxy.nginx-driver docker
nb config set proxy.caddy-driver local
nb config set bin.yarn yarn
```
docs/docs/ru/api/cli/db/check.md
+5 -5
View File
@@ -1,12 +1,12 @@
---
title: "nb db check"
description: "Справочник по команде nb db check: проверка доступности базы данных через текущий env или явные флаги базы данных."
keywords: "nb db check,NocoBase CLI,database connection"
description: "Справочник по команде nb db check: проверка доступности базы данных через текущее окружение или явные флаги базы данных."
keywords: "nb db check,NocoBase CLI,подключение к базе данных,доступность"
---
# nb db check
Проверяет, доступна ли база данных. Можно использовать сохранённые настройки базы данных из env или передать явные флаги `--db-*`.
Проверяет, доступна ли база данных. Можно использовать сохранённые настройки базы данных из окружения или передать явные флаги `--db-*`.
## Использование
@@ -18,7 +18,7 @@ nb db check [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Считать настройки базы данных из CLI env; если не указано, нужно передать все обязательные флаги `--db-*` |
| `--env`, `-e` | string | Считать настройки базы данных из CLI-окружения; если не указано, нужно передать все обязательные флаги `--db-*` |
| `--db-dialect` | string | Диалект базы данных: `postgres`, `kingbase`, `mysql` или `mariadb` |
| `--db-host` | string | Имя хоста или IP-адрес базы данных |
| `--db-port` | string | TCP-порт базы данных |
@@ -37,7 +37,7 @@ nb db check --db-dialect postgres --db-host 127.0.0.1 --db-port 5432 --db-databa
## Примечания
Если выбранный env использует встроенную базу данных, управляемую CLI, CLI сначала определит фактический адрес подключения, а затем выполнит проверку.
Если выбранное окружение использует встроенную базу данных, управляемую CLI, CLI сначала определит фактический адрес подключения, а затем выполнит проверку.
## Связанные команды
docs/docs/ru/api/cli/db/index.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: "nb db"
description: "Справочник по команде nb db: просмотр или управление состоянием встроенной базы данных выбранного env."
description: "Справочник по команде nb db: просмотр или управление состоянием среды выполнения встроенной базы данных выбранного окружения."
keywords: "nb db,NocoBase CLI,встроенная база данных,Docker,состояние базы данных"
---
# nb db
Просмотр или управление встроенной базой данных, которой управляет CLI. Для env, не имеющих контейнера базы данных под управлением CLI, команда `nb db ps` также отобразит такие статусы, как `external` или `remote`.
Просмотр или управление встроенными базами данных, которыми управляет CLI. Для окружений без контейнера базы данных под управлением CLI команда `nb db ps` также отобразит такие статусы, как `external` или `remote`.
## Использование
@@ -18,8 +18,8 @@ nb db <command>
| Команда | Описание |
| --- | --- |
| [`nb db check`](./check.md) | Проверить доступность подключения к базе данных. |
| [`nb db ps`](./ps.md) | Просмотр состояния встроенной базы данных |
| [`nb db check`](./check.md) | Проверить доступность подключения к базе данных |
| [`nb db ps`](./ps.md) | Просмотр состояния среды выполнения встроенной базы данных |
| [`nb db start`](./start.md) | Запуск контейнера встроенной базы данных |
| [`nb db stop`](./stop.md) | Остановка контейнера встроенной базы данных |
| [`nb db logs`](./logs.md) | Просмотр логов контейнера встроенной базы данных |
docs/docs/ru/api/cli/db/logs.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: "nb db logs"
description: "Справочник по команде nb db logs: просмотр логов контейнера встроенной базы данных указанного env."
description: "Справочник по команде nb db logs: просмотр логов контейнера встроенной базы данных выбранного окружения."
keywords: "nb db logs,NocoBase CLI,логи базы данных,Docker logs"
---
# nb db logs
Просмотр логов контейнера встроенной базы данных указанного env. Эта команда применима только к env, в которых включена встроенная база данных под управлением CLI.
Просмотр логов контейнера встроенной базы данных выбранного окружения. Эта команда применима только к окружениям, созданным со встроенной базой данных, управляемой CLI.
## Использование
@@ -18,8 +18,8 @@ nb db logs [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env, для которого просматриваются логи встроенной базы данных; если не указано, используется текущий env |
| `--tail` | integer | Количество последних строк логов, отображаемых перед началом отслеживания, по умолчанию `100` |
| `--env`, `-e` | string | Имя CLI-окружения, для которого просматриваются логи встроенной базы данных; если не указано, используется текущее окружение |
| `--tail` | integer | Количество последних строк логов, отображаемых перед началом отслеживания; по умолчанию `100` |
| `--follow`, `-f` / `--no-follow` | boolean | Отслеживать ли новые логи в реальном времени |
## Примеры
docs/docs/ru/api/cli/db/ps.md
+3 -3
View File
@@ -1,12 +1,12 @@
---
title: "nb db ps"
description: "Справочник по команде nb db ps: просмотр состояния встроенной базы данных настроенных env."
description: "Справочник по команде nb db ps: просмотр состояния среды выполнения встроенной базы данных для настроенных окружений."
keywords: "nb db ps,NocoBase CLI,состояние базы данных"
---
# nb db ps
Просмотр состояния встроенной базы данных без запуска или остановки каких-либо ресурсов. Если параметр `--env` не указан, отображается состояние базы данных всех настроенных env.
Просмотр состояния среды выполнения встроенной базы данных без запуска или остановки каких-либо ресурсов. Если параметр `--env` не указан, отображается состояние базы данных всех настроенных окружений.
## Использование
@@ -18,7 +18,7 @@ nb db ps [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env для просмотра; если не указано, отображаются все env |
| `--env`, `-e` | string | Имя CLI-окружения для просмотра; если не указано, отображаются все окружения |
## Примеры
docs/docs/ru/api/cli/db/start.md
+3 -3
View File
@@ -1,12 +1,12 @@
---
title: "nb db start"
description: "Справочник по команде nb db start: запуск контейнера встроенной базы данных указанного env."
description: "Справочник по команде nb db start: запуск контейнера встроенной базы данных выбранного окружения."
keywords: "nb db start,NocoBase CLI,запуск базы данных,Docker"
---
# nb db start
Запуск контейнера встроенной базы данных указанного env. Эта команда применима только к env, в которых включена встроенная база данных под управлением CLI.
Запуск контейнера встроенной базы данных выбранного окружения. Эта команда применима только к окружениям, созданным со встроенной базой данных, управляемой CLI.
## Использование
@@ -18,7 +18,7 @@ nb db start [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env, для которого запускается встроенная база данных; если не указано, используется текущий env |
| `--env`, `-e` | string | Имя CLI-окружения, для которого запускается встроенная база данных; если не указано, используется текущее окружение |
| `--verbose` | boolean | Показать вывод низкоуровневых Docker-команд |
## Примеры
docs/docs/ru/api/cli/db/stop.md
+5 -5
View File
@@ -1,12 +1,12 @@
---
title: 'nb db stop'
description: 'Справка по команде nb db stop: останавливает встроенный контейнер базы данных для указанного env.'
keywords: 'nb db stop,NocoBase CLI,остановить базу данных,Docker'
description: 'Справочник по команде nb db stop: остановка контейнера встроенной базы данных для указанного окружения.'
keywords: 'nb db stop,NocoBase CLI,остановка базы данных,Docker'
---
# nb db stop
Останавливает встроенный контейнер базы данных для указанного env. Эта команда применяется только к env, в которых включена встроенная база данных, управляемая CLI.
Останавливает контейнер встроенной базы данных для указанного окружения. Эта команда применяется только к окружениям со встроенной базой данных, управляемой CLI.
## Использование
@@ -18,8 +18,8 @@ nb db stop [flags]
| Параметр | Тип | Описание |
| ------------- | ------- | -------------------------------------------------------------------------------------------------------- |
| `--env`, `-e` | string | Имя CLI env, встроенную базу данных которого нужно остановить; если не указано, используется текущий env |
| `--verbose` | boolean | Показывает вывод базовой команды Docker |
| `--env`, `-e` | string | Имя CLI-окружения, встроенную базу данных которого нужно остановить; если не указано, используется текущее окружение |
| `--verbose` | boolean | Показывает вывод низкоуровневых Docker-команд |
## Примеры
docs/docs/ru/api/cli/env/add.md
Vendored
+10 -2
View File
@@ -1,12 +1,19 @@
---
title: "nb env add"
description: "Справочник по команде nb env add: сохранение URL API NocoBase и способа аутентификации с последующим переключением на этот env."
description: "Справочник по команде nb env add: сохранение URL API NocoBase и способа аутентификации с последующим переключением на это окружение."
keywords: "nb env add,NocoBase CLI,добавить окружение,API Base URL,аутентификация"
---
# nb env add
Сохранение именованного endpoint API NocoBase и переключение CLI на использование этого env. При выборе способа аутентификации `oauth` автоматически запускается процесс входа [`nb env auth`](./auth.md).
Сохраняет именованный адрес API NocoBase и переключает CLI на использование этого окружения. При выборе способа аутентификации `oauth` автоматически запускается [`nb env auth`](./auth.md).
Команда выполняет две операции:
- сохраняет конфигурацию окружения;
- переключает текущее окружение на только что добавленное.
Если для текущей оболочки или среды выполнения включён режим сессии, обновляется `current env` сессии. Также обновляется глобальный `last env` как запасной вариант для оболочек и сред выполнения без режима сессии.
## Использование
@@ -37,5 +44,6 @@ nb env add local --api-base-url http://localhost:13000/api --auth-type token --a
## Связанные команды
- [`nb env auth`](./auth.md)
- [`nb env current`](./current.md)
- [`nb env update`](./update.md)
- [`nb env list`](./list.md)
docs/docs/ru/api/cli/env/auth.md
Vendored
+10 -10
View File
@@ -1,14 +1,14 @@
---
title: "nb env auth"
description: "Справочник по команде nb env auth: аутентификация сохранённого env NocoBase через basic, token или OAuth."
keywords: "nb env auth,NocoBase CLI,basic,token,OAuth,вход,аутентификация"
description: "Справочник по команде nb env auth: выполнение OAuth-входа для сохранённого окружения NocoBase."
keywords: "nb env auth,NocoBase CLI,OAuth,вход,аутентификация"
---
# nb env auth
Повторно аутентифицирует сохранённый env NocoBase или обновляет сохранённые для него данные аутентификации. Если имя окружения не указано, используется текущий env.
Повторно аутентифицирует сохранённыое коружение NocoBase или обновляет сохранённые для него данные аутентификации. Если имя окружения не указано, используется текущее окружение.
`nb env auth` поддерживает три метода аутентификации: `basic`, `token` и `oauth`. Если `--auth-type` не указан, CLI сначала определяет метод по переданным параметрам аутентификации. Если метод всё ещё нельзя определить, используется метод аутентификации, уже сохранённый в env.
`nb env auth` поддерживает три метода аутентификации: `basic`, `token` и `oauth`. Если `--auth-type` не указан, CLI сначала определяет метод по переданным параметрам аутентификации. Если метод всё ещё нельзя определить, используется метод аутентификации, уже сохранённый в окружении.
## Использование
@@ -20,11 +20,11 @@ nb env auth [name] [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `[name]` | string | Имя настроенного env, в который нужно войти; если не указано, используется текущий env |
| `--auth-type`, `-a` | string | Метод аутентификации: `basic`, `token` или `oauth` |
| `--access-token`, `-t` | string | API key или access token для аутентификации `token` |
| `--username` | string | Имя пользователя для аутентификации `basic`; в TTY запрашивается при отсутствии |
| `--password` | string | Пароль для аутентификации `basic`; в TTY запрашивается при отсутствии |
| `[name]` | string | Имя настроенного окружения, в которое нужно войти; если не указано, используется текущее окружение |
| `--auth-type`, `-a` | string | Способ аутентификации: `basic`, `token` или `oauth` |
| `--access-token`, `-t` | string | Ключ API или токен доступа для способа аутентификации `token` |
| `--username` | string | Имя пользователя для способа аутентификации `basic`; в TTY запрашивается при отсутствии |
| `--password` | string | Пароль для способа аутентификации `basic`; в TTY запрашивается при отсутствии |
## Параметры совместимости
@@ -32,7 +32,7 @@ nb env auth [name] [flags]
| --- | --- | --- |
| `--env`, `-e` | string | Имя окружения, эквивалентно `[name]`. Этот скрытый параметр сохранён для совместимости с другими командами; обычно достаточно позиционного аргумента |
## Описание
## Примечания
Методы аутентификации работают так:
docs/docs/ru/api/cli/env/current.md
Vendored
+8 -6
View File
@@ -1,24 +1,26 @@
---
title: "nb env current"
description: "Справочник по команде nb env current: показать текущий фактически используемый env NocoBase CLI."
keywords: "nb env current,NocoBase CLI,текущий env,session env"
description: "Справочник по команде nb env current: показать текущее фактически используемое окружение NocoBase CLI."
keywords: "nb env current,NocoBase CLI,текущее окружение,current env"
---
# nb env current
Показывает имя текущего фактически используемого env.
Показывает имя текущего фактически используемого окружения.
По умолчанию команда сначала читает session env для текущего `NB_SESSION_ID`. Если session mode не включён для текущей shell или runtime, используется глобальный `last env` как fallback.
По умолчанию команда сначала читает окружение сессии для текущего `NB_SESSION_ID`. Если режим сессии не включён для текущей оболочки или среды выполнения, используется глобальный `last env` как запасной вариант.
## Использование
```bash
nb env current
```
## Примеры
```bash
nb env current
```
## Связанные команды
docs/docs/ru/api/cli/env/index.md
Vendored
+17 -17
View File
@@ -1,17 +1,17 @@
---
title: "nb env"
description: "Справка по команде nb env: управлять сохранёнными env в NocoBase CLI, включая добавление, просмотр текущего env, проверку статуса, переключение, обновление, аутентификацию и удаление."
keywords: "nb env,NocoBase CLI,управление окружениями,env,current env,аутентификация,OpenAPI"
description: "Справочник по команде nb env: управление сохранёнными окружениями NocoBase CLI, включая добавление, просмотр текущего окружения, проверку статуса, переключение, обновление, аутентификацию и удаление."
keywords: "nb env,NocoBase CLI,управление окружениями,окружение,current env,аутентификация,OpenAPI"
---
# nb env
Управляет сохранёнными env в NocoBase CLI. Env хранит сведения о подключении и локальной среде выполнения, такие как адрес API, данные аутентификации, путь к локальному приложению и конфигурация базы данных.
Управляет сохранёнными окружениями NocoBase CLI. Окружение хранит сведения о подключении и локальной среде выполнения, такие как адрес API, данные аутентификации, путь к локальному приложению и конфигурация базы данных.
Начиная с этой версии CLI разделяет два понятия:
- `current env`: env, который сейчас использует активная оболочка или runtime агента; по возможности он изолируется через `NB_SESSION_ID`
- `last env`: env, который использовался последним глобально; он применяется как fallback, если mode session не включён
- `current env`: окружение, которое сейчас использует активная оболочка или среда выполнения агента; по возможности оно изолируется через `NB_SESSION_ID`
- `last env`: окружение, которое использовалось последним глобально; применяется как запасной вариант, если режим сессии не включён
## Использование
@@ -23,15 +23,15 @@ nb env <command>
| Команда | Описание |
| --- | --- |
| [`nb env add`](./add.md) | Сохранить endpoint API NocoBase и переключиться на этот env |
| [`nb env current`](./current.md) | Показать env, который сейчас действует |
| [`nb env update`](./update.md) | Обновить конфигурацию сохранённого env и при необходимости автоматически выполнить последующую синхронизацию |
| [`nb env list`](./list.md) | Показать список настроенных env |
| [`nb env status`](./status.md) | Показать статус текущего env, указанного env или всех env |
| [`nb env info`](./info.md) | Показать подробную информацию об одном env |
| [`nb env remove`](./remove.md) | Удалить конфигурацию env после остановки управляемого runtime |
| [`nb env auth`](./auth.md) | Выполнить OAuth-вход для сохранённого env |
| [`nb env use`](./use.md) | Переключить текущий env |
| [`nb env add`](./add.md) | Сохранить адрес API NocoBase и переключиться на это окружение |
| [`nb env current`](./current.md) | Показать окружение, которое сейчас действует |
| [`nb env update`](./update.md) | Обновить конфигурацию сохранённого окружения и при необходимости автоматически выполнить последующую синхронизацию |
| [`nb env list`](./list.md) | Показать список настроенных окружений |
| [`nb env status`](./status.md) | Показать статус текущего окружения, указанного окружения или всех окружений |
| [`nb env info`](./info.md) | Показать подробную информацию об одном окружении |
| [`nb env remove`](./remove.md) | Удалить конфигурацию окружения после остановки управляемой среды выполнения |
| [`nb env auth`](./auth.md) | Выполнить OAuth-вход для сохранённого окружения |
| [`nb env use`](./use.md) | Переключить текущее окружение |
## Примеры
@@ -46,11 +46,11 @@ nb env use app1
nb env auth app1
```
## Mode session
## Режим сессии
По умолчанию рекомендуется включить mode session. Это позволяет `current env` в разных терминалах, оболочках или runtime агентов оставаться изолированными и не влиять друг на друга параллельно.
По умолчанию рекомендуется включить режим сессии. Это позволяет `current env` в разных терминалах, оболочках или средах выполнения агентов оставаться изолированными и не влиять друг на друга при параллельной работе.
Если mode session не включён, `nb env use` обновляет глобальный `last env`, и другие сессии без session-изоляции тоже будут затронуты.
Если режим сессии не включён, `nb env use` обновляет глобальный `last env`, и другие сессии без изоляции сессий тоже будут затронуты.
Как включить этот режим, см. в [`nb session setup`](../session/setup.md).
docs/docs/ru/api/cli/env/info.md
Vendored
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: 'nb env info'
description: 'Справка по команде nb env info: просмотр конфигурации приложения, базы данных, API и аутентификации для указанного env в NocoBase CLI.'
description: 'Справочник по команде nb env info: просмотр конфигурации приложения, базы данных, API и аутентификации для указанного окружения NocoBase CLI.'
keywords: 'nb env info,NocoBase CLI,сведения об окружении,конфигурация'
---
# nb env info
Просмотр подробной информации об одном env, включая конфигурацию приложения, базы данных, API и аутентификации.
Просмотр подробной информации об одном окружении, включая конфигурацию приложения, базы данных, API и аутентификации.
## Использование
@@ -18,8 +18,8 @@ nb env info [name] [flags]
| Параметр | Тип | Описание |
| ---------------- | ------- | -------------------------------------------------------------------------------------------------------------- |
| `[name]` | string | Имя настроенного окружения для просмотра; если не указано, используется текущий env |
| `--json` | boolean | Вывод в формате JSON |
| `[name]` | string | Имя настроенного окружения для просмотра; если не указано, используется текущее окружение |
| `--json` | boolean | Вывод JSON |
| `--field` | string | Возвращает только одно поле, используя путь через точку, например `app.url`, `app.appPath` или `api.auth.type` |
| `--show-secrets` | boolean | Показывает токены, пароли и другие секреты в открытом виде |
docs/docs/ru/api/cli/env/list.md
Vendored
+10 -8
View File
@@ -1,32 +1,34 @@
---
title: "nb env list"
description: "Справочник по команде nb env list: список настроенных env NocoBase CLI."
description: "Справочник по команде nb env list: список настроенных окружений NocoBase CLI."
keywords: "nb env list,NocoBase CLI,список окружений,API Base URL"
---
# nb env list
Показывает все настроенные env.
Показывает все настроенные окружения.
Эта команда показывает только сохранённую конфигурацию. Когда нужно проверить статус, используйте [`nb env status`](./status.md).
Эта команда показывает только сохранённую конфигурацию. Чтобы проверить текущую среду выполнения или статус API, используйте [`nb env status`](./status.md).
## Использование
```bash
nb env list
```
## Вывод
Таблица вывода включает маркер текущего окружения, имя, тип, `API Base URL`, тип аутентификации и версию runtime.
Таблица вывода включает маркер текущего окружения, имя, тип, `API Base URL`, тип аутентификации и версию среды выполнения.
- `Current` помечает фактически активный env символом `*`
- `Current` помечает фактически активное окружение символом `*`
- `API Base URL` показывает сохранённый исходный адрес API
- `Runtime` показывает кэшированную информацию о версии runtime
- `Runtime` показывает кэшированную информацию о версии среды выполнения
## Примеры
```bash
nb env list
```
## Связанные команды
docs/docs/ru/api/cli/env/remove.md
Vendored
+5 -5
View File
@@ -1,18 +1,18 @@
---
title: 'nb env remove'
description: 'Справка по команде nb env remove: останавливает управляемые среды выполнения перед удалением конфигурации env или при необходимости полностью очищает локальные управляемые ресурсы.'
description: 'Справочник по команде nb env remove: останавливает управляемые среды выполнения перед удалением конфигурации окружения или при необходимости полностью очищает локальные управляемые ресурсы.'
keywords: 'nb env remove,NocoBase CLI,удалить окружение,удалить конфигурацию,purge'
---
# nb env remove
Удаляет настроенный env. Для env типов local/docker эта команда сначала останавливает среду выполнения приложения и встроенной базы данных, управляемые CLI на текущей машине, а затем удаляет сохраненную конфигурацию CLI env. Для env типов http/ssh эта команда только удаляет сохраненную конфигурацию CLI env.
Удаляет настроенное окружение. Для окружений типов `local`/`docker` команда сначала останавливает среду выполнения приложения и среду выполнения встроенной базы данных, управляемые CLI на текущей машине, а затем удаляет сохранённую конфигурацию CLI-окружения. Для окружений типов `http`/`ssh` команда только удаляет сохранённую конфигурацию CLI-окружения.
Если удаляемый env является текущим env, CLI автоматически выберет новый current env из оставшихся env; если доступных env больше нет, current env будет очищен.
Если удаляемое окружение является текущим, CLI автоматически выберет новое `current env` из оставшихся окружений; если доступных окружений больше нет, `current env` будет очищен.
По умолчанию команда требует подтверждения. В неинтерактивном режиме для выполнения необходимо явно передать `--force`.
Если нужно максимально очистить управляемые CLI ресурсы на текущей машине, можно передать `--purge`. Для env типов local/docker `--purge` дополнительно очищает управляемые ресурсы выполнения, данные storage и, если применимо, загруженные файлы локального app; для env типов http/ssh `--purge` не затрагивает внешние сервисы и только удаляет сохраненную конфигурацию CLI env.
Чтобы максимально очистить ресурсы, управляемые CLI, на текущей машине, передайте `--purge`. Для окружений типов `local`/`docker` флаг `--purge` дополнительно очищает управляемые ресурсы среды выполнения, данные хранилища и, если применимо, загруженные файлы локального приложения; для окружений типов `http`/`ssh` `--purge` не затрагивает внешние сервисы и только удаляет сохранённую конфигурацию CLI-окружения.
## Использование
@@ -26,7 +26,7 @@ nb env remove <name> [flags]
| --------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<name>` | string | Имя настроенного окружения, которое нужно удалить |
| `--force`, `-f` | boolean | Пропускает подтверждение для текущего режима remove; обязательно в неинтерактивном режиме |
| `--purge` | boolean | Дополнительно очищает управляемые CLI ресурсы, данные storage и, если применимо, загруженные файлы локального app на текущей машине; для env удаленного API удаляется только сохраненная конфигурация env |
| `--purge` | boolean | Дополнительно очищает ресурсы, управляемые CLI, данные хранилища и, если применимо, загруженные файлы локального приложения на текущей машине; для окружений удалённого API удаляется только сохранённая конфигурация окружения |
| `--verbose` | boolean | Показывает подробный ход выполнения |
## Примеры
docs/docs/ru/api/cli/env/status.md
Vendored
+13 -11
View File
@@ -1,47 +1,49 @@
---
title: "nb env status"
description: "Справочник по команде nb env status: показать статус текущего env, одного env или всех env."
description: "Справочник по команде nb env status: показать статус текущего окружения, одного окружения или всех окружений."
keywords: "nb env status,NocoBase CLI,статус окружения,API Base URL"
---
# nb env status
Показывает статус env. По умолчанию проверяется текущий env. Также можно проверить один указанный env или использовать `--all` для всех env.
Показывает статус окружения. По умолчанию проверяется текущее окружение. Также можно проверить одно указанное окружение или использовать `--all` для всех окружений.
Эта команда выводит упрощённую таблицу статуса с `Env`, `Status` и `API Base URL`.
## Использование
```bash
nb env status [name] [flags]
```
## Параметры
| Параметр | Тип | Описание |
| --- | --- | --- |
| `[name]` | string | Имя настроенного env для просмотра; если не указано, используется текущий env и его нельзя использовать вместе с `--all` |
| `--all` | boolean | Показать статус всех настроенных env |
| `[name]` | string | Имя настроенного окружения для проверки; если не указано, используется текущее окружение; нельзя использовать вместе с `--all` |
| `--all` | boolean | Показать статус всех настроенных окружений |
| `--json-output` | boolean | Вывести результат в формате JSON |
`[name]` и `--all` нельзя использовать вместе.
## Status values
## Значения статуса
`Status` — это результат проверки целевого env со стороны CLI. Типичные значения:
`Status` — результат проверки целевого окружения со стороны CLI. Типичные значения:
- `ok`: env доступен и успешно аутентифицирован
- `ok`: окружение доступно и успешно аутентифицировано
- `auth failed`: API доступен, но аутентификация не прошла
- `unreachable`: не удалось обратиться к целевому адресу
- `unconfigured`: конфигурация env неполная
- `missing`: управляемое приложение для этого env больше не существует
- `unconfigured`: конфигурация окружения неполная
- `missing`: управляемое приложение для этого окружения больше не существует
## Примеры
```bash
nb env status
nb env status app1
nb env status --all
nb env status --all --json-output
```
## Связанные команды
docs/docs/ru/api/cli/env/update.md
Vendored
+13 -13
View File
@@ -1,14 +1,14 @@
---
title: "nb env update"
description: "Справка по команде nb env update: обновление сохранённой конфигурации API, аутентификации, исходного кода, приложения и базы данных."
keywords: "nb env update,NocoBase CLI,конфигурация env,аутентификация,база данных,исходный код"
description: "Справочник по команде nb env update: обновление сохранённой конфигурации API, аутентификации, исходного кода, приложения и базы данных."
keywords: "nb env update,NocoBase CLI,конфигурация окружения,аутентификация,база данных,исходный код"
---
# nb env update
`nb env update` обновляет конфигурацию сохранённого env. С его помощью можно изменить адрес API, способ аутентификации, источник исходного кода, локальный путь приложения, публичный путь, порт, параметры базы данных и многое другое. После завершения обновления CLI автоматически выполнит необходимые последующие действия в зависимости от изменений.
`nb env update` обновляет конфигурацию сохранённого окружения. С его помощью можно изменить адрес API, способ аутентификации, источник исходного кода, локальный путь приложения, публичный путь, порт, параметры базы данных и многое другое. После завершения обновления CLI автоматически выполнит необходимые последующие действия в зависимости от изменений.
Если вы не передадите никаких параметров конфигурации, CLI всё равно выполнит повторную синхронизацию на основе текущего состояния env.
Если вы не передадите никаких параметров конфигурации, CLI всё равно выполнит повторную синхронизацию на основе текущего состояния окружения.
## Использование
@@ -20,7 +20,7 @@ nb env update [name] [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `[name]` | string | Имя настроенного env, которое нужно обновить. Если не указано, используется текущее env |
| `[name]` | string | Имя настроенного окружения, которое нужно обновить; если не указано, используется текущее окружение |
| `--verbose` | boolean | Показывать подробный прогресс |
## Параметры API и аутентификации
@@ -30,7 +30,7 @@ nb env update [name] [flags]
| `--api-base-url`, `-u` | string | URL API NocoBase, включая префикс `/api` |
| `--auth-type` | string | Способ аутентификации: `basic`, `token` или `oauth` |
| `--access-token`, `--token`, `-t` | string | API key или access token для аутентификации `token`. При сохранении тип аутентификации также переключается на `token` |
| `--username` | string | Имя пользователя, сохраняемое для `basic`-аутентификации. Используйте его только если текущее env уже использует `basic`, или вместе с `--auth-type basic` |
| `--username` | string | Имя пользователя, сохраняемое для аутентификации `basic`. Используйте его только если текущее окружение уже использует `basic`, или вместе с `--auth-type basic` |
## Параметры источника и загрузки
@@ -69,7 +69,7 @@ nb env update [name] [flags]
| `--db-database` | string | Имя базы данных |
| `--db-user` | string | Имя пользователя базы данных |
| `--db-password` | string | Пароль базы данных |
| `--db-schema` | string | Схема базы данных. Обычно это используется только для PostgreSQL |
| `--db-schema` | string | Схема базы данных. Обычно используется только для PostgreSQL |
| `--db-table-prefix` | string | Префикс таблиц |
| `--db-underscored` / `--no-db-underscored` | boolean | Использовать ли стиль с подчёркиваниями в именах таблиц и полей |
@@ -83,14 +83,14 @@ nb env update [name] [flags]
:::tip
Если вам нужно только повторно синхронизировать CLI по последнему состоянию текущего env, просто выполните `nb env update` или `nb env update <name>` без дополнительных опций.
Если вам нужно только повторно синхронизировать CLI по последнему состоянию текущего окружения, просто выполните `nb env update` или `nb env update <name>` без дополнительных параметров.
:::
- После завершения обновления CLI автоматически выполнит всю необходимую последующую синхронизацию на основе внесённых на этот раз изменений
- Остальные параметры обновляют только сохранённую конфигурацию env. Они не перезапускают приложение автоматически и не заменяют локальный исходный код или Docker-образы
- Остальные параметры обновляют только сохранённую конфигурацию окружения; они не перезапускают приложение автоматически и не заменяют локальный исходный код или Docker-образы
- После изменения параметров вроде `app-path`, `app-port`, `timezone` или `db-*` CLI обычно предложит выполнить `nb app restart --env <name>`; если изменение связано со встроенной базой данных, управляемой CLI, будет предложено использовать `nb app restart --env <name> --with-db`
- После изменения параметров вроде `app-port`, `app-public-path` или `cdn-base-url`, которые влияют на результат reverse proxy, повторно выполните `nb proxy nginx generate` или `nb proxy caddy generate`, если вы уже используете сгенерированную proxy-конфигурацию
- После изменения параметров вроде `app-port`, `app-public-path` или `cdn-base-url`, которые влияют на вывод обратного прокси, повторно выполните `nb proxy nginx generate` или `nb proxy caddy generate`, если вы уже используете сгенерированную конфигурацию прокси
- При обновлении параметров источника, таких как `source`, `download-version`, `docker-registry`, `git-url` или `npm-registry`, меняются только сохранённые значения. Уже существующие локальный исходный код, зависимости и образы автоматически не заменяются
- `--access-token` нельзя использовать вместе с `--auth-type basic` или `--auth-type oauth`
- Одно и то же поле нельзя использовать одновременно с `--unset` и с явным значением. Например, не используйте `--unset git-url` вместе с `--git-url ...`
@@ -99,10 +99,10 @@ nb env update [name] [flags]
## Примеры
```bash
# Повторно синхронизировать текущее env по последнему сохранённому состоянию
# Повторно синхронизировать текущее окружение по последнему сохранённому состоянию
nb env update
# Повторно синхронизировать конкретное env
# Повторно синхронизировать конкретное окружение
nb env update prod
# Обновить URL API
@@ -120,7 +120,7 @@ nb env update local --source git --git-url git@github.com:nocobase/nocobase.git
# Изменить порт приложения и часовой пояс, а затем перезапустить позже
nb env update local --app-port 13080 --timezone Asia/Shanghai
# Изменить публичный путь и при необходимости затем пересоздать proxy
# Изменить публичный путь и при необходимости затем пересоздать прокси
nb env update local --app-public-path /nocobase/
# Сохранить базовый CDN URL для клиентских ресурсов
docs/docs/ru/api/cli/env/use.md
Vendored
+11 -5
View File
@@ -1,16 +1,16 @@
---
title: "nb env use"
description: "Справочник по команде nb env use: переключение текущего env NocoBase CLI."
description: "Справочник по команде nb env use: переключение текущего окружения NocoBase CLI."
keywords: "nb env use,NocoBase CLI,переключение окружения,current env"
---
# nb env use
Переключает текущий env CLI. После этого команды без флага `--env` будут по умолчанию использовать выбранный env.
Переключает текущее окружение CLI. После этого команды без флага `--env` по умолчанию будут использовать выбранное окружение.
Если session mode включён для текущей shell или runtime, это изменение затрагивает только текущую сессию.
Если для текущей оболочки или среды выполнения включён режим сессии, это изменение затрагивает только текущую сессию.
Если session mode не включён, команда откатывается к обновлению глобального `last env`. В этом случае могут быть затронуты и другие терминалы или runtime агентов без изоляции сессий.
Если режим сессии не включён, обновляется глобальный `last env` как запасной вариант. В этом случае могут быть затронуты и другие терминалы или среды выполнения агентов без изоляции сессий.
## Использование
@@ -22,7 +22,7 @@ nb env use <name>
| Параметр | Тип | Описание |
| --- | --- | --- |
| `<name>` | string | Имя настроенного env, на который нужно переключиться |
| `<name>` | string | Имя настроенного окружения, на которое нужно переключиться |
## Примеры
@@ -30,7 +30,13 @@ nb env use <name>
nb env use local
```
## Рекомендация
По умолчанию рекомендуется сначала один раз выполнить [`nb session setup`](../session/setup.md). Тогда `nb env use` работает ближе к `use dbname` в клиенте базы данных: сначала переключается контекст текущей сессии, а затем выполняются зависимые от окружения команды.
## Связанные команды
- [`nb env current`](./current.md)
- [`nb env status`](./status.md)
- [`nb env list`](./list.md)
- [`nb env info`](./info.md)
docs/docs/ru/api/cli/index.md
+21 -21
View File
@@ -1,6 +1,6 @@
---
title: 'NocoBase CLI'
description: 'Справочник по NocoBase CLI (команда nb): инициализация, резервное копирование и восстановление, конфигурация, управление окружением, запуск приложения, исходный код, база данных, плагины, коммерческая лицензия, API, самообновление CLI и управление Skills.'
description: 'Справочник по NocoBase CLI (команда nb): инициализация, резервное копирование и восстановление, конфигурация, управление окружением, среда выполнения приложения, исходный код, база данных, плагины, коммерческая лицензия, API, самообновление CLI и управление навыками.'
keywords: 'NocoBase CLI,nb,командная строка,справочник команд,резервное копирование,восстановление,управление окружением,управление плагинами,коммерческая лицензия,API'
---
@@ -8,14 +8,14 @@ keywords: 'NocoBase CLI,nb,командная строка,справочник
## Описание
NocoBase CLI (`nb`) — это точка входа командной строки NocoBase, используемая для инициализации, подключения и управления приложениями NocoBase в локальном рабочем пространстве.
NocoBase CLI (`nb`) — точка входа командной строки NocoBase, используемая для инициализации, подключения и управления приложениями NocoBase в локальном рабочем пространстве.
Он поддерживает два распространённых пути инициализации:
- Подключить существующее приложение NocoBase и сохранить его как CLI env
- Установить новое приложение NocoBase через Docker, npm или Git, а затем сохранить его как CLI env
- Подключить существующее приложение NocoBase и сохранить его как CLI-окружение
- Установить новое приложение NocoBase через Docker, npm или Git, а затем сохранить его как CLI-окружение
При создании нового локального приложения [`nb init`](./init.md) также может устанавливать или обновлять AI coding skills NocoBase. Если нужно пропустить этот шаг, можно использовать `--skip-skills`.
При создании нового локального приложения [`nb init`](./init.md) также может устанавливать или обновлять навыки ИИ-разработки NocoBase. Чтобы пропустить этот шаг, используйте `--skip-skills`.
## Использование
@@ -32,18 +32,18 @@ nb [command]
| Группа команд | Описание |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- |
| [`nb api`](./api/index.md) | Вызывать API NocoBase через CLI. |
| [`nb app`](./app/index.md) | Управлять состоянием работы приложения: запуск, остановка, перезапуск, журналы и обновление. |
| [`nb app`](./app/index.md) | Управлять средой выполнения приложения: запуск, остановка, перезапуск, логи и обновление. |
| [`nb backup`](./backup/index.md) | Создать резервную копию и скачать её локально либо восстановить локальный файл резервной копии в целевое окружение. |
| [`nb config`](./config/index.md) | Управлять конфигурацией CLI по умолчанию. |
| [`nb db`](./db/index.md) | Управлять встроенной базой данных выбранного окружения. |
| [`nb env`](./env/index.md) | Управлять окружениями проекта NocoBase, текущим env, состоянием, подробностями и runtime-командами. |
| [`nb env`](./env/index.md) | Управлять окружениями проекта NocoBase, текущим окружением, состоянием, сведениями и командами среды выполнения. |
| [`nb license`](./license/index.md) | Управлять коммерческой лицензией и лицензируемыми плагинами. |
| [`nb plugin`](./plugin/index.md) | Управлять плагинами выбранного окружения NocoBase. |
| [`nb scaffold`](./scaffold/index.md) | Генерировать scaffold для разработки плагинов NocoBase. |
| [`nb scaffold`](./scaffold/index.md) | Генерировать шаблоны для разработки плагинов NocoBase. |
| [`nb self`](./self/index.md) | Проверять или обновлять сам NocoBase CLI. |
| [`nb session`](./session/index.md) | Настраивать `NB_SESSION_ID`, чтобы current env изолировался по shell или agent runtime. |
| [`nb skills`](./skills/index.md) | Проверять или синхронизировать AI coding skills NocoBase в текущем рабочем пространстве. |
| [`nb source`](./source/index.md) | Управлять локальным проектом исходного кода: загрузка, разработка, сборка и тестирование. |
| [`nb session`](./session/index.md) | Настраивать `NB_SESSION_ID`, чтобы текущее окружение изолировалось по оболочке или среде выполнения агента. |
| [`nb skills`](./skills/index.md) | Проверять или синхронизировать навыки ИИ-разработки NocoBase в текущем рабочем пространстве. |
| [`nb source`](./source/index.md) | Управлять локальным проектом исходного кода: загрузка, разработка, сборка и тестирование. |
## Команды (Commands)
@@ -51,7 +51,7 @@ nb [command]
| Команда | Описание |
| ---------------------- | -------------------------------------------------------------------------- |
| [`nb init`](./init.md) | Инициализировать NocoBase, чтобы coding agent мог подключаться и работать. |
| [`nb init`](./init.md) | Инициализировать NocoBase, чтобы агент для разработки мог подключаться и работать. |
## Просмотр справки
@@ -100,7 +100,7 @@ nb env current
nb env status
```
Повторная синхронизация состояния env после запуска приложения:
Повторная синхронизация состояния окружения после запуска приложения:
```bash
nb app start -e app1
@@ -147,7 +147,7 @@ nb backup restore -e app1 --file ./backups/backup_20260520_190408_8397.nbdata --
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `NB_CLI_ROOT` | Корневой каталог, в котором CLI хранит конфигурацию `.nocobase` и файлы локальных приложений. По умолчанию это домашний каталог текущего пользователя. |
| `NB_LOCALE` | Язык подсказок CLI и язык локального UI инициализации; поддерживаются `en-US` и `zh-CN`. |
| `NB_SESSION_ID` | Идентификатор сессии текущего shell или agent runtime. После установки `nb env use` и `nb env current` изолируются по сессии. |
| `NB_SESSION_ID` | Идентификатор сессии текущей оболочки или среды выполнения агента. После установки `nb env use` и `nb env current` изолируются по сессии. |
Пример:
@@ -156,7 +156,7 @@ export NB_CLI_ROOT=/your/workspace
export NB_LOCALE=zh-CN
```
## Файл конфигурации
## Файлы конфигурации
Файл конфигурации по умолчанию:
@@ -170,27 +170,27 @@ export NB_LOCALE=zh-CN
/your/workspace/.nocobase/config.json
```
CLI также совместим с чтением старой конфигурации проекта из текущего рабочего каталога.
CLI также совместим с чтением унаследованной конфигурации проекта из текущего рабочего каталога.
Кэш уровня сессии для текущего env хранится в:
Кэш уровня сессии для текущего окружения хранится в:
```text
.nocobase/sessions/<NB_SESSION_ID>.json
```
Последний глобально использованный env хранится в поле `lastEnv` файла `config.json`. При отсутствии `NB_SESSION_ID` CLI возвращается к этому глобальному значению.
Последнее глобально использованное окружение хранится в поле `lastEnv` файла `config.json`. При отсутствии `NB_SESSION_ID` CLI использует это глобальное значение как запасной вариант.
Кэш runtime-команд хранится в:
Кэш команд среды выполнения хранится в:
```text
.nocobase/versions/<hash>/commands.json
```
Этот файл создаётся или обновляется командой [`nb env update`](./env/update.md) и используется для кэширования runtime-команд, синхронизированных с целевого приложения.
Этот файл создаётся или обновляется командой [`nb env update`](./env/update.md) и используется для кэширования команд среды выполнения, синхронизированных с целевого приложения.
## Связанные ссылки
- [Быстрый старт](../../ai/quick-start.mdx)
- [Глобальные переменные окружения](../app/env.md)
- [AI-конструктор](../../ai-builder/index.md)
- [Мастер ИИ-разработки](../../ai-builder/index.md)
- [Разработка плагинов](../../plugin-development/index.md)
docs/docs/ru/api/cli/init.md
+56 -56
View File
@@ -1,16 +1,16 @@
---
title: 'nb init'
description: 'Справка по команде nb init: новая установка, подключение уже существующего локального приложения или соединение с удалённым приложением и сохранение как CLI env.'
keywords: 'nb init,NocoBase CLI,инициализация,env,Docker,npm,Git,удалённое подключение'
description: 'Справочник по команде nb init: установка нового приложения, подключение существующего локального приложения или соединение с удалённым приложением и сохранение как CLI-окружение.'
keywords: 'nb init,NocoBase CLI,инициализация,окружение,Docker,npm,Git,удалённое подключение'
---
# nb init
Инициализирует текущее рабочее пространство, чтобы coding agent мог подключаться к NocoBase и использовать его.
Инициализирует текущее рабочее пространство, чтобы агент для разработки мог подключаться к NocoBase и использовать его.
`nb init` может установить новое локальное приложение NocoBase, а также сохранить параметры подключения уже существующего приложения.
Кроме того, `nb init` по умолчанию синхронизирует NocoBase AI coding skills. Добавлять `--skip-skills` нужно только если вы уже самостоятельно управляете skills либо запускаете команду в CI или офлайн-среде.
Кроме того, `nb init` по умолчанию синхронизирует навыки ИИ-разработки NocoBase. Добавлять `--skip-skills` нужно только если вы уже самостоятельно управляете навыками либо запускаете команду в CI или офлайн-среде.
## Использование
@@ -22,27 +22,27 @@ nb init [flags]
`nb init` поддерживает три интерактивных режима:
- `nb init`：пошаговое выполнение мастера в терминале
- `nb init --ui`：открывает форму в локальном браузере и завершает setup через визуальный мастер
- `nb init --yes --env app1`：пропускает подсказки и сразу использует flags; параметры, не переданные явно, обрабатываются со значениями по умолчанию
- `nb init`：пошаговое выполнение настройки в терминале
- `nb init --ui`：открывает форму в локальном браузере и завершает настройку через визуальный мастер
- `nb init --yes --env app1`：пропускает запросы и сразу использует флаги; параметры, не переданные явно, обрабатываются со значениями по умолчанию
Режим `--yes` подходит для скриптов, CI/CD и других неинтерактивных сценариев. В этом режиме `--env <envName>` обязателен. Как правило, по умолчанию будет установлено новое локальное приложение; если вы не укажете `--source`, источником установки по умолчанию будет `docker`.
## Возобновление прерванной инициализации
Для сценариев установки env-конфигурация сначала сохраняется, а затем выполняются загрузка, настройка базы данных и установка приложения. Если процесс прервался, можно продолжить:
Для сценариев установки конфигурация окружения сначала сохраняется, а затем выполняются загрузка, настройка базы данных и установка приложения. Если процесс прервался, можно продолжить:
```bash
nb init --env app1 --resume
```
`--resume` применим только к процессам инициализации, где env-конфигурация уже была сохранена, и требует явной передачи `--env`.
`--resume` применим только к процессам инициализации, где конфигурация окружения уже была сохранена, и требует явной передачи `--env`.
## Сначала подготовить env, а приложение установить позже
## Сначала подготовить окружение, а приложение установить позже
`--prepare-only` предназначен для сценариев, где сначала нужно подготовить env, затем активировать лицензию, и только после этого установить и запустить приложение.
`--prepare-only` предназначен для сценариев, где сначала нужно подготовить окружение, затем активировать лицензию, и только после этого установить и запустить приложение.
Если вы хотите сначала сохранить конфигурацию env и подготовить базу данных, но отложить скачивание зависимостей, фактическую установку приложения и первый запуск, можно использовать:
Если вы хотите сначала сохранить конфигурацию окружения и подготовить базу данных, но отложить загрузку зависимостей, фактическую установку приложения и первый запуск, можно использовать:
```bash
nb init --env app1 --prepare-only
@@ -50,16 +50,16 @@ nb init --env app1 --prepare-only --ui
nb init --env app1 --prepare-only --yes
```
Этот режим доступен для сценариев локальной установки, включая мастер `--ui`. Он недоступен для сценариев удалённого подключения. CLI сохранит текущий env в состоянии prepared, поэтому позже вы сможете продолжить с помощью такого сценария:
Этот режим доступен для сценариев локальной установки, включая мастер `--ui`. Он недоступен для сценариев удалённого подключения. CLI сохранит окружение как подготовленное, поэтому позже вы сможете продолжить с помощью такого сценария:
```bash
nb license activate --env app1
nb app start --env app1
```
После этого `nb app start` завершит первую установку и переведёт env из состояния prepared в обычное состояние installed.
После этого `nb app start` завершит первую установку и переведёт окружение из подготовленного состояния в обычное установленное состояние.
## О каталоге установки
## Структура каталога установки
Полный путь можно посмотреть через `nb env info app1 --field app.appPath`.
@@ -67,17 +67,17 @@ nb app start --env app1
```text
<app-path>/
├── .nb/ # Метаданные CLI для этого env, например hooks.mjs
├── source/ # Каталог по умолчанию для исходников приложения или загруженного содержимого
├── storage/ # Каталог данных времени выполнения
├── .nb/ # Метаданные CLI для этого окружения, например hooks.mjs
├── source/ # Каталог по умолчанию для исходного кода приложения или загруженного содержимого
├── storage/ # Каталог данных среды выполнения
└── .env # Необязательный файл переменных окружения приложения
```
Обычно:
- `.nb/` хранит метаданные, управляемые CLI. Скрипт, переданный через `--hook-script`, копируется в `<app-path>/.nb/hooks.mjs`, чтобы последующие `nb app upgrade` и локальное восстановление source могли использовать его повторно
- `source/` в основном соответствует локальному каталогу приложения для env типа npm / Git. Для Docker env CLI тоже сохраняет эту схему путей по умолчанию, но в большинстве случаев вам не нужно заботиться об этом вручную. При обновлении обратите особое внимание: каталог `source/` будет удален и загружен заново, поэтому не храните здесь файлы, которые нужно сохранить
- `storage/` используется для данных времени выполнения, например встроенной базы данных, плагинов, логов и т. д.
- `.nb/` хранит метаданные, управляемые CLI. Скрипт, переданный через `--hook-script`, копируется в `<app-path>/.nb/hooks.mjs`, чтобы последующие `nb app upgrade` и локальное восстановление исходного кода могли использовать его повторно
- `source/` в основном соответствует локальному каталогу приложения для окружений типов npm / Git. Для Docker-окружений CLI тоже сохраняет эту схему путей по умолчанию, но в большинстве случаев вам не нужно заботиться об этом вручную. При обновлении обратите особое внимание: каталог `source/` будет удалён и загружен заново, поэтому не храните здесь файлы, которые нужно сохранить
- `storage/` используется для данных среды выполнения, например встроенной базы данных, плагинов, логов и т. д.
- `.env` — необязательный файл переменных окружения приложения. Добавлять его в `<app-path>/.env` нужно только если вы хотите настроить свои переменные окружения; если файл существует, источники установки Docker, npm и Git по умолчанию будут его читать
Это соглашение CLI о каталогах по умолчанию. Для разных источников установки, плагинов и этапов выполнения фактически создаваемое содержимое каталогов может отличаться.
@@ -95,18 +95,18 @@ nb app start --env app1
## Быстрая навигация по Steps
В разных путях setup отображаются разные Steps. Например, при подключении к существующему приложению обычно используются только `Getting started` и `Remote connection`.
В разных путях настройки отображаются разные шаги. Например, при подключении к существующему приложению обычно используются только «Начало настройки» и «Удалённое подключение».
Если вы проходите локальный UI-мастер шаг за шагом, можете сначала воспользоваться таблицей ниже для быстрой навигации:
| Step | Параметры, на которые стоит обратить внимание |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Getting started` | `--env`、`--yes`、`--ui`、`--locale`、`--verbose`、`--skip-skills`、`--resume`、`--prepare-only` |
| `App environment` | `--lang`、`--app-path`、`--app-port`、`--force` |
| `App source and version` | `--source`、`--version`、`--skip-download`、`--git-url`、`--docker-registry`、`--docker-platform`、`--npm-registry`、`--replace`、`--dev-dependencies`、`--output-dir`、`--docker-save`、`--build`、`--build-dts`、`--hook-script` |
| `Configure the database` | `--builtin-db`、`--db-dialect`、`--builtin-db-image`、`--db-host`、`--db-port`、`--db-database`、`--db-user`、`--db-password`、`--db-schema`、`--db-table-prefix`、`--db-underscored` |
| `Create an admin account` | `--root-username`、`--root-email`、`--root-password`、`--root-nickname` |
| `Remote connection` | `--api-base-url`、`--auth-type`、`--access-token`、`--username`、`--password`、`--skip-auth` |
| Шаг | Параметры, на которые стоит обратить внимание |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Начало настройки | `--env`、`--yes`、`--ui`、`--locale`、`--verbose`、`--skip-skills`、`--resume` |
| Окружение приложения | `--lang`、`--app-path`、`--app-port`、`--force` |
| Источник и версия приложения | `--source`、`--version`、`--skip-download`、`--git-url`、`--docker-registry`、`--docker-platform`、`--npm-registry`、`--replace`、`--dev-dependencies`、`--output-dir`、`--docker-save`、`--build`、`--build-dts`、`--hook-script` |
| Настройка базы данных | `--builtin-db`、`--db-dialect`、`--builtin-db-image`、`--db-host`、`--db-port`、`--db-database`、`--db-user`、`--db-password`、`--db-schema`、`--db-table-prefix`、`--db-underscored` |
| Создание учётной записи администратора | `--root-username`、`--root-email`、`--root-password`、`--root-nickname` |
| Удалённое подключение | `--api-base-url`、`--auth-type`、`--access-token`、`--username`、`--password`、`--skip-auth` |
## Параметры
@@ -118,16 +118,16 @@ nb app start --env app1
| Параметр | Тип | Значение по умолчанию | Описание |
| --------------- | ------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `--yes`, `-y` | boolean | `false` | Пропустить подсказки и использовать flags и значения по умолчанию |
| `--env`, `-e` | string | Нет | Имя env, сохраняемого при этой инициализации; обязательно в режимах `--yes` и `--resume` |
| `--yes`, `-y` | boolean | `false` | Пропустить запросы и использовать флаги и значения по умолчанию |
| `--env`, `-e` | string | Нет | Имя окружения, сохраняемого при этой инициализации; обязательно в режимах `--yes` и `--resume` |
| `--ui` | boolean | `false` | Открыть мастер в локальном браузере; нельзя использовать вместе с `--yes` и `--resume` |
| `--verbose` | boolean | `false` | Показывать подробный вывод команд |
| `--skip-skills` | boolean | `false` | Пропустить синхронизацию NocoBase AI coding skills |
| `--ui-host` | string | `127.0.0.1` | Адрес привязки локального сервиса `--ui` |
| `--skip-skills` | boolean | `false` | Пропустить синхронизацию навыков ИИ-разработки NocoBase |
| `--ui-host` | string | `127.0.0.1` | Хост, доступный в браузере, который указывается в URL мастера `--ui`; локальный сервис всегда слушает `0.0.0.0` |
| `--ui-port` | integer | `0` | Порт локального сервиса `--ui`; `0` означает автоматическое назначение |
| `--locale` | string | Следует `NB_LOCALE`, настройке CLI или системной locale; окончательный fallback — `en-US` | Язык подсказок CLI и локального UI setup: `en-US` или `zh-CN` |
| `--resume` | boolean | `false` | Продолжить предыдущую незавершённую инициализацию с повторным использованием сохранённой workspace env config |
| `--prepare-only` | boolean | `false` | Сохранить и подготовить env для локальной установки, включая сценарии `--ui`, но пока не устанавливать и не запускать приложение |
| `--locale` | string | Следует `NB_LOCALE`, настройке CLI или системной locale; окончательный запасной вариант — `en-US` | Язык подсказок CLI и локального UI настройки: `en-US` или `zh-CN` |
| `--resume` | boolean | `false` | Продолжить предыдущую незавершённую инициализацию с повторным использованием сохранённой конфигурации окружения рабочего пространства |
| `--prepare-only` | boolean | `false` | Сохранить и подготовить окружение для локальной установки, включая сценарии `--ui`, но пока не устанавливать и не запускать приложение |
### Подключение существующего приложения
@@ -135,17 +135,17 @@ nb app start --env app1
| ---------------------- | ------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--api-base-url`, `-u` | string | Нет | Корневой адрес API, обязательно должен содержать префикс `/api` |
| `--auth-type`, `-a` | string | `oauth` | Способ аутентификации: `basic`, `token` или `oauth`. Обычно подходит `oauth` по умолчанию; в некоторых сценариях CI/CD также можно использовать `basic` |
| `--access-token`, `-t` | string | Нет | API key или access token для аутентификации `token` |
| `--access-token`, `-t` | string | Нет | Ключ API или токен доступа для аутентификации `token` |
| `--username` | string | Нет | Имя пользователя для аутентификации `basic` |
| `--password` | string | Нет | Пароль для аутентификации `basic` |
| `--skip-auth` | boolean | `false` | Сначала сохранить env и способ аутентификации, а затем завершить вход через `nb env auth` позже |
| `--skip-auth` | boolean | `false` | Сначала сохранить окружение и способ аутентификации, а затем завершить вход через `nb env auth` позже |
### Базовые параметры локальной установки
| Параметр | Тип | Значение по умолчанию | Описание |
| ----------------- | ------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `--lang`, `-l` | string | `en-US` | Язык интерфейса нового установленного приложения |
| `--force`, `-f` | boolean | `false` | Повторно настроить существующий env и при необходимости заменить конфликтующие ресурсы времени выполнения |
| `--force`, `-f` | boolean | `false` | Повторно настроить существующее окружение и при необходимости заменить конфликтующие ресурсы среды выполнения |
| `--app-path` | string | `./<envName>/` | Каталог локального приложения npm/Git |
| `--app-port` | string | `13000` | HTTP-порт локального приложения; в режиме `--yes` автоматически выбирается свободный порт |
| `--root-username` | string | `nocobase`（в режиме `--yes`） | Имя начального администратора |
@@ -174,19 +174,19 @@ nb app start --env app1
| Параметр | Тип | Значение по умолчанию | Описание |
| ---------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `--skip-download` | boolean | `false` | Пропустить загрузку и использовать существующий локальный каталог приложения или Docker-образ |
| `--source`, `-s` | string | `docker` | Способ получения NocoBase: `docker`、`npm` или `git` |
| `--version`, `-v` | string | `beta` | Параметр версии: версия npm-пакета, tag Docker-образа или Git ref |
| `--source`, `-s` | string | `docker` | Тип источника NocoBase: `docker`, `npm` или `git` |
| `--version`, `-v` | string | `beta` | Параметр версии: версия npm-пакета, тег Docker-образа или git ref |
| `--replace`, `-r` | boolean | `false` | Заменить, если целевой каталог уже существует |
| `--dev-dependencies`, `-D` / `--no-dev-dependencies` | boolean | `false` | Устанавливать ли devDependencies при установке через npm/Git |
| `--output-dir`, `-o` | string | Для npm/Git выводится из `--app-path`; для Docker + `--docker-save` — `./nocobase-<version>` | Целевой каталог загрузки или каталог сохранения tarball при включённом `--docker-save` |
| `--git-url` | string | `https://github.com/nocobase/nocobase.git` | Адрес Git-репозитория |
| `--docker-registry` | string | `nocobase/nocobase`; для locale `zh-CN` — `registry.cn-shanghai.aliyuncs.com/nocobase/nocobase` | Имя репозитория Docker-образа без tag |
| `--docker-registry` | string | `nocobase/nocobase`; для locale `zh-CN` — `registry.cn-shanghai.aliyuncs.com/nocobase/nocobase` | Имя репозитория Docker-образа без тега |
| `--docker-platform` | string | `auto` | Платформа Docker-образа: `auto`、`linux/amd64`、`linux/arm64` |
| `--docker-save` / `--no-docker-save` | boolean | `false` | Сохранять ли Docker-образ дополнительно как tarball после загрузки |
| `--npm-registry` | string | Пусто | Registry для загрузки npm/Git и установки зависимостей |
| `--npm-registry` | string | Пусто | Реестр для загрузки npm/Git и установки зависимостей |
| `--build` / `--no-build` | boolean | `true` | Выполнять ли сборку после установки зависимостей npm/Git |
| `--build-dts` | boolean | `false` | Генерировать ли объявления TypeScript при сборке npm/Git |
| `--hook-script` | string | Нет | Копирует указанный hook-модуль в `<app-path>/.nb/hooks.mjs` и сохраняет его в env config; поддерживает lifecycle hooks `beforeDependencyInstall`, `beforeAppInstall` и `afterAppStart` |
| `--hook-script` | string | Нет | Копирует указанный модуль хука в `<app-path>/.nb/hooks.mjs` и сохраняет его в конфигурации окружения; поддерживает хуки жизненного цикла `beforeDependencyInstall`, `beforeAppInstall` и `afterAppStart` |
## Примеры
@@ -236,7 +236,7 @@ nb init --env app1 --yes --source git --version latest \
--git-url https://gitee.com/nocobase/nocobase.git
```
### Расширение установки с помощью hook-скрипта
### Расширение процесса установки с помощью модуля хука
Если во время установки нужно подготовить дополнительные файлы, передайте локальный ESM-модуль через `--hook-script`:
@@ -244,31 +244,31 @@ nb init --env app1 --yes --source git --version latest \
nb init --env app1 --yes --source git --hook-script ./hooks.mjs
```
CLI копирует этот файл в `<app-path>/.nb/hooks.mjs` и сохраняет `hookScript: ".nb/hooks.mjs"` в env config. Последующие `nb app start`, `nb app restart` и `nb app upgrade` используют его из этого места.
CLI копирует этот файл в `<app-path>/.nb/hooks.mjs` и сохраняет `hookScript: ".nb/hooks.mjs"` в конфигурации окружения. Последующие `nb app start`, `nb app restart` и `nb app upgrade` используют его из этого места.
Файл hook должен экспортировать объект по умолчанию. Реализуйте только нужные методы:
Файл хука должен экспортировать объект по умолчанию. Реализуйте только нужные методы:
```js
export default {
beforeDependencyInstall: async (context) => {
// Runs after git clone / npm scaffold and before yarn install.
// Выполняется после git clone / npm-шаблона и перед yarn install.
},
beforeAppInstall: async (context) => {
// Runs before the app-level install or upgrade command.
// Выполняется перед командой установки или обновления на уровне приложения.
},
afterAppStart: async (context) => {
// Runs after the app actually starts and passes the health check.
// Выполняется после фактического запуска приложения и успешной проверки работоспособности.
},
};
```
- `beforeDependencyInstall` применяется только к source npm/Git и запускается прямо перед настоящим `yarn install`; Docker source его не запускает
- `beforeAppInstall` запускается перед командами install или upgrade уровня приложения и применяется к source npm/Git/Docker
- `beforeDependencyInstall` применяется только к источникам npm/Git и запускается прямо перед настоящим `yarn install`; источник Docker его не запускает
- `beforeAppInstall` запускается перед командами установки или обновления на уровне приложения и применяется к источникам npm/Git/Docker
- `afterAppStart` запускается после фактического старта приложения и успешного `__health_check`; его могут вызвать `nb app start`, `nb app restart` и `nb app upgrade`
`--prepare-only` только сохраняет env config и копирует файл hook. Hooks при этом не выполняются. Когда позже вы впервые запустите `nb app start`, CLI выполнит hooks первой установки с `context.phase` равным `init` и `context.command` равным `app:start`.
`--prepare-only` только сохраняет конфигурацию окружения и копирует файл хука. Хуки при этом не выполняются. Когда позже вы впервые запустите `nb app start`, CLI выполнит хуки первой установки с `context.phase` равным `init` и `context.command` равным `app:start`.
`context` содержит lifecycle-информацию, например `phase`, `command`, `source`, `version`, `appPath`, `sourcePath`, `storagePath`, `hookScript` и `envConfig`. Если hook выбросит ошибку, текущая CLI-команда завершится с ошибкой. Так как `afterAppStart` может выполняться повторно при start, restart и upgrade, сделайте его идемпотентным.
`context` содержит сведения о жизненном цикле, например `phase`, `command`, `source`, `version`, `appPath`, `sourcePath`, `storagePath`, `hookScript` и `envConfig`. Если хук выбросит ошибку, текущая CLI-команда завершится с ошибкой. Так как `afterAppStart` может выполняться повторно при start, restart и upgrade, сделайте его идемпотентным.
### Быстрая установка и использование аутентификации basic
@@ -293,7 +293,7 @@ nb init --env app1 --yes \
### Подключение существующего приложения
Обычно достаточно OAuth по умолчанию. Если в некоторых сценариях CI/CD неудобно открывать браузер, можно сразу сохранить аутентификацию `basic`; если у вас уже есть API token, можно сразу сохранить аутентификацию `token`.
Обычно достаточно OAuth по умолчанию. Если в некоторых сценариях CI/CD неудобно открывать браузер, можно сразу сохранить аутентификацию `basic`; если у вас уже есть токен API, можно сразу сохранить аутентификацию `token`.
```bash
nb init --env staging --yes \
docs/docs/ru/api/cli/license/activate.md
+10 -10
View File
@@ -1,12 +1,12 @@
---
title: "nb license activate"
description: "Справочник по команде nb license activate: активация существующего коммерческого license key NocoBase для выбранного env."
keywords: "nb license activate,NocoBase CLI,commercial licensing"
description: "Справочник по команде nb license activate: активация существующего коммерческого ключа лицензии NocoBase для выбранного окружения."
keywords: "nb license activate,NocoBase CLI,коммерческое лицензирование"
---
# nb license activate
Активирует существующий коммерческий license key для выбранного env. Его можно передать напрямую, прочитать из файла или вставить в интерактивном терминале.
Активирует существующий коммерческий ключ лицензии для выбранного окружения. Его можно передать напрямую, прочитать из файла или вставить в интерактивном терминале.
## Использование
@@ -18,10 +18,10 @@ nb license activate [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env; если не указано, используется текущий env |
| `--key` | string | Передать существующий коммерческий license key напрямую |
| `--key-file` | string | Считать существующий коммерческий license key из файла |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, используется текущее окружение |
| `--key` | string | Передать существующий коммерческий ключ лицензии напрямую |
| `--key-file` | string | Считать существующий коммерческий ключ лицензии из файла |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--json` | boolean | Вывод JSON |
## Примеры
@@ -35,15 +35,15 @@ nb license activate --env app1 --json --key-file ./license.txt
## Примечания
При интерактивном запуске CLI сначала показывает текущие Hostname и Instance ID, а затем предлагает вставить license key напрямую или указать путь к файлу с key. Эта информация помогает проверить, что лицензия привязывается к правильному экземпляру.
При интерактивном запуске CLI сначала показывает текущие `Hostname` и идентификатор экземпляра (`Instance ID`), а затем предлагает вставить ключ лицензии напрямую или указать путь к файлу ключа. Эта информация помогает проверить, что лицензия привязывается к правильному экземпляру.
После успешной активации перезапустите приложение, чтобы лицензия и состояние коммерческих плагинов действительно вступили в силу; перед перезапуском CLI автоматически синхронизирует коммерческие плагины, разрешённые текущей лицензией:
После успешной активации перезапустите приложение, чтобы лицензия и состояние коммерческих плагинов действительно вступили в силу. Перед перезапуском CLI автоматически синхронизирует коммерческие плагины, разрешённые текущей лицензией:
```bash
nb app restart
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/license/id.md
+7 -7
View File
@@ -1,12 +1,12 @@
---
title: "nb license id"
description: "Справочник по команде nb license id: отображение или повторная генерация instance ID коммерческой лицензии для выбранного env."
keywords: "nb license id,NocoBase CLI,instance id"
description: "Справочник по команде nb license id: отображение или повторная генерация идентификатора экземпляра (`Instance ID`) коммерческой лицензии для выбранного окружения."
keywords: "nb license id,NocoBase CLI,идентификатор экземпляра,Instance ID"
---
# nb license id
Показывает instance ID коммерческой лицензии для выбранного env. Если сохранённого instance ID ещё нет, CLI автоматически создаст и сохранит его.
Показывает идентификатор экземпляра (`Instance ID`) коммерческой лицензии для выбранного окружения. Если сохранённого идентификатора экземпляра ещё нет, CLI автоматически создаст и сохранит его.
## Использование
@@ -18,9 +18,9 @@ nb license id [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--force` | boolean | Принудительно пересоздать instance ID, даже если он уже сохранён |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--force` | boolean | Принудительно пересоздать идентификатор экземпляра, даже если он уже сохранён |
| `--json` | boolean | Вывод JSON |
## Примеры
@@ -33,7 +33,7 @@ nb license id --env app1 --force
nb license id --env app1 --json
```
`--force` только принудительно регенерирует ID экземпляра. Он не заменяет подтверждение при работе с другой env; если явно переданный `--env` указывает не на текущую env, вам всё равно потребуется подтверждение или `--yes`.
`--force` только принудительно пересоздаёт идентификатор экземпляра. Он не заменяет подтверждение операции с другим окружением: если явно переданный `--env` указывает на окружение, отличное от текущего, всё равно потребуется подтверждение или `--yes`.
## Связанные команды
docs/docs/ru/api/cli/license/index.md
+6 -6
View File
@@ -1,12 +1,12 @@
---
title: "nb license"
description: "Справочник по команде nb license: управление коммерческими лицензиями и лицензированными плагинами NocoBase."
keywords: "nb license,NocoBase CLI,commercial licensing"
description: "Справочник по команде nb license: управление коммерческим лицензированием и лицензированными плагинами NocoBase."
keywords: "nb license,NocoBase CLI,коммерческое лицензирование,лицензия"
---
# nb license
Управляет коммерческим лицензированием NocoBase, включая активацию с существующим license key, Instance ID, статус лицензии и лицензированные плагины.
Управляет коммерческим лицензированием NocoBase, включая активацию с существующим ключом лицензии, идентификатор экземпляра (`Instance ID`), статус лицензии и лицензированные плагины.
## Использование
@@ -18,9 +18,9 @@ nb license <command>
| Команда | Описание |
| --- | --- |
| [`nb license activate`](./activate.md) | Активировать коммерческую лицензию для текущего env с существующим license key |
| [`nb license id`](./id.md) | Показать или сгенерировать instance ID для текущего env |
| [`nb license status`](./status.md) | Показать статус коммерческой лицензии для текущего env |
| [`nb license activate`](./activate.md) | Активировать коммерческое лицензирование для текущего окружения с существующим ключом лицензии |
| [`nb license id`](./id.md) | Показать или сгенерировать идентификатор экземпляра для текущего окружения |
| [`nb license status`](./status.md) | Показать статус коммерческой лицензии для текущего окружения |
| [`nb license plugins`](./plugins/index.md) | Управлять коммерческими плагинами, разрешёнными текущей лицензией |
## Примеры
docs/docs/ru/api/cli/license/plugins/clean.md
+7 -7
View File
@@ -1,12 +1,12 @@
---
title: "nb license plugins clean"
description: "Справочник по команде nb license plugins clean: удаление загруженных коммерческих плагинов для выбранного env."
keywords: "nb license plugins clean,NocoBase CLI,commercial plugins"
description: "Справочник по команде nb license plugins clean: удаление загруженных коммерческих плагинов для выбранного окружения."
keywords: "nb license plugins clean,NocoBase CLI,коммерческие плагины"
---
# nb license plugins clean
Удаляет загруженные коммерческие плагины для выбранного env без изменения статуса активации лицензии.
Удаляет загруженные коммерческие плагины для выбранного окружения без изменения активации лицензии.
## Использование
@@ -18,10 +18,10 @@ nb license plugins clean [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--dry-run` | boolean | Предварительно показать, какие плагины будут удалены, ничего не удаляя |
| `--verbose` | boolean | Показывать подробные логи по каждому плагину |
| `--verbose` | boolean | Показывать подробные логи очистки по каждому плагину |
| `--json` | boolean | Вывод JSON |
## Примеры
@@ -35,7 +35,7 @@ nb license plugins clean --env app1 --verbose
nb license plugins clean --env app1 --json
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/license/plugins/index.md
+3 -3
View File
@@ -1,12 +1,12 @@
---
title: "nb license plugins"
description: "Справочник по команде nb license plugins: просмотр или синхронизация коммерческих плагинов, разрешённых текущей лицензией."
keywords: "nb license plugins,NocoBase CLI,commercial plugins"
keywords: "nb license plugins,NocoBase CLI,коммерческие плагины,лицензированные плагины"
---
# nb license plugins
Просматривает или синхронизирует коммерческие плагины, разрешённые текущей лицензией.
Просмотр или синхронизация коммерческих плагинов, разрешённых текущей лицензией.
## Использование
@@ -20,7 +20,7 @@ nb license plugins <command>
| --- | --- |
| [`nb license plugins list`](./list.md) | Показать коммерческие плагины, связанные с текущей лицензией |
| [`nb license plugins sync`](./sync.md) | Синхронизировать коммерческие плагины, разрешённые текущей лицензией |
| [`nb license plugins clean`](./clean.md) | Удалить загруженные коммерческие плагины для текущего env |
| [`nb license plugins clean`](./clean.md) | Удалить загруженные коммерческие плагины для текущего окружения |
## Примеры
docs/docs/ru/api/cli/license/plugins/list.md
+6 -6
View File
@@ -1,12 +1,12 @@
---
title: "nb license plugins list"
description: "Справочник по команде nb license plugins list: отображение коммерческих плагинов, связанных с текущей лицензией для выбранного env."
keywords: "nb license plugins list,NocoBase CLI,commercial plugins"
description: "Справочник по команде nb license plugins list: отображение коммерческих плагинов, связанных с текущей лицензией для выбранного окружения."
keywords: "nb license plugins list,NocoBase CLI,коммерческие плагины"
---
# nb license plugins list
Показывает коммерческие плагины, связанные с сохранённым license key для выбранного env.
Показывает коммерческие плагины, связанные с сохранённым ключом лицензии для выбранного окружения.
## Использование
@@ -18,8 +18,8 @@ nb license plugins list [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--json` | boolean | Вывод JSON |
## Примеры
@@ -31,7 +31,7 @@ nb license plugins list --env app1 --yes
nb license plugins list --env app1 --json
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/license/plugins/sync.md
+10 -10
View File
@@ -1,7 +1,7 @@
---
title: "nb license plugins sync"
description: "Справочник по команде nb license plugins sync: синхронизация коммерческих плагинов, разрешённых текущей лицензией для выбранного env."
keywords: "nb license plugins sync,NocoBase CLI,commercial plugins"
description: "Справочник по команде nb license plugins sync: синхронизация коммерческих плагинов, разрешённых текущей лицензией для выбранного окружения."
keywords: "nb license plugins sync,NocoBase CLI,коммерческие плагины"
---
# nb license plugins sync
@@ -18,12 +18,12 @@ nb license plugins sync [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--dry-run` | boolean | Предварительный просмотр изменений без установки, обновления или удаления плагинов |
| `--version` | string | Версия registry или dist-tag для синхронизации; по умолчанию используется текущая версия workspace |
| `--skip-if-no-license` | boolean | Пропустить без ошибки, если у текущего env ещё нет сохранённого лицензионного ключа |
| `--verbose` | boolean | Показывать подробные логи по каждому плагину |
| `--version` | string | Версия реестра или тег дистрибуции для синхронизации; по умолчанию используется текущая версия приложения |
| `--skip-if-no-license` | boolean | Пропустить без ошибки, если у текущего окружения ещё нет сохранённого ключа лицензии |
| `--verbose` | boolean | Показывать подробные логи синхронизации по каждому плагину |
| `--json` | boolean | Вывод JSON |
## Примеры
@@ -39,11 +39,11 @@ nb license plugins sync --env app1 --json
## Примечания
Если `--version` не указан, CLI автоматически определяет текущую версию приложения и использует её, чтобы решить, какую версию registry коммерческих плагинов нужно загрузить.
Если `--version` не указан, CLI автоматически определяет текущую версию приложения и использует её, чтобы решить, какую версию реестра коммерческих плагинов нужно загрузить.
`--skip-if-no-license` игнорирует только один случай: у текущего env ещё нет сохранённого лицензионного ключа. Другие ошибки, например отсутствие учётных данных registry в ключе, сбой входа в registry или ошибка загрузки плагинов, по-прежнему выводятся как обычно.
`--skip-if-no-license` игнорирует только один случай: у текущего окружения ещё нет сохранённого ключа лицензии. Другие ошибки, например отсутствие учётных данных реестра в ключе, сбой входа в реестр или ошибка загрузки плагинов, по-прежнему выводятся как обычно.
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/license/status.md
+7 -7
View File
@@ -1,12 +1,12 @@
---
title: "nb license status"
description: "Справочник по команде nb license status: отображение статуса коммерческой лицензии для выбранного env."
keywords: "nb license status,NocoBase CLI,license status"
description: "Справочник по команде nb license status: отображение статуса коммерческой лицензии для выбранного окружения."
keywords: "nb license status,NocoBase CLI,статус лицензии"
---
# nb license status
Показывает статус коммерческой лицензии для выбранного env.
Показывает статус коммерческой лицензии для выбранного окружения.
## Использование
@@ -18,8 +18,8 @@ nb license status [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя CLI env; если не указано, используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--doctor` | boolean | Запустить дополнительные диагностические проверки и подсказки |
| `--json` | boolean | Вывод JSON |
@@ -35,9 +35,9 @@ nb license status --env app1 --json
## Примечания
Новый CLI пока не полностью реализует backend-проверки статуса лицензии. Команда всё ещё может вернуть базовый контекст и диагностические заполнители, но не полный вердикт по лицензии.
Новый CLI пока не полностью реализует проверки статуса лицензии на серверной части. Команда всё ещё может вернуть базовый контекст и диагностические заполнители, но не полный вердикт по лицензии.
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/plugin/disable.md
+6 -6
View File
@@ -1,12 +1,12 @@
---
title: "nb plugin disable"
description: "Справочник по команде nb plugin disable: отключение одного или нескольких плагинов в выбранном env NocoBase."
description: "Справочник по команде nb plugin disable: отключение одного или нескольких плагинов в выбранном окружении NocoBase."
keywords: "nb plugin disable,NocoBase CLI,отключение плагинов"
---
# nb plugin disable
Отключает один или несколько плагинов в выбранном env.
Отключает один или несколько плагинов в выбранном окружении.
## Использование
@@ -18,9 +18,9 @@ nb plugin disable <packages...> [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `<packages...>` | string[] | Имена пакетов плагинов, обязательный параметр, поддерживает несколько значений |
| `--env`, `-e` | string | Имя env CLI, при пропуске используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `<packages...>` | string[] | Имена пакетов плагинов; обязательный параметр, поддерживает несколько значений |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
## Примеры
@@ -31,7 +31,7 @@ nb plugin disable -e local @nocobase/plugin-sample
nb plugin disable -e local --yes @nocobase/plugin-sample
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/plugin/enable.md
+6 -6
View File
@@ -1,12 +1,12 @@
---
title: "nb plugin enable"
description: "Справочник по команде nb plugin enable: включение одного или нескольких плагинов в выбранном env NocoBase."
description: "Справочник по команде nb plugin enable: включение одного или нескольких плагинов в выбранном окружении NocoBase."
keywords: "nb plugin enable,NocoBase CLI,включение плагинов"
---
# nb plugin enable
Включает один или несколько плагинов в выбранном env.
Включает один или несколько плагинов в выбранном окружении.
## Использование
@@ -18,9 +18,9 @@ nb plugin enable <packages...> [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `<packages...>` | string[] | Имена пакетов плагинов, обязательный параметр, поддерживает несколько значений |
| `--env`, `-e` | string | Имя env CLI, при пропуске используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `<packages...>` | string[] | Имена пакетов плагинов; обязательный параметр, поддерживает несколько значений |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
## Примеры
@@ -31,7 +31,7 @@ nb plugin enable -e local @nocobase/plugin-sample
nb plugin enable -e local --yes @nocobase/plugin-sample
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/plugin/import.md
+17 -17
View File
@@ -1,12 +1,12 @@
---
title: "nb plugin import"
description: "Справочник по команде nb plugin import: импортирует упакованный архив плагина или npm-пакет в каталог storage/plugins выбранного env NocoBase или в пользовательский путь storage."
description: "Справочник по команде nb plugin import: импорт упакованного архива плагина или npm-пакета в каталог storage/plugins выбранного окружения NocoBase или в пользовательский путь хранилища."
keywords: "nb plugin import,NocoBase CLI,импорт плагина,storage-path,npm-registry"
---
# nb plugin import
Импортирует упакованный архив плагина или npm-пакет в `storage/plugins`. Эта команда только помещает плагин в целевой каталог. Автоматически она его не включает.
Импортирует упакованный архив плагина или npm-пакет в `storage/plugins`. Команда только помещает плагин в целевой каталог и не включает его автоматически.
## Использование
@@ -18,11 +18,11 @@ nb plugin import <archive> [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `<archive>` | string | Источник плагина. Обязательный параметр. Поддерживается локальный путь `.tgz`, удалённый URL архива `http(s)` или имя / tag npm-пакета |
| `--env`, `-e` | string | Имя CLI env. Если параметр не указан, обычно используется текущий env. Если ты явно передаёшь `--storage-path`, `--env` можно не указывать |
| `--yes`, `-y` | boolean | Пропускает интерактивное подтверждение, если явно переданный `--env` указывает на env, отличный от текущего |
| `--storage-path` | string | Переопределяет корневой путь целевого storage. Фактический каталог импорта — `<storage-path>/plugins` |
| `--npm-registry` | string | Указывает, какой npm registry использовать, если источник — это имя или tag npm-пакета |
| `<archive>` | string | Источник плагина; обязательный параметр. Поддерживаются локальный путь `.tgz`, удалённый URL архива `http(s)` или имя npm-пакета / тег |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, обычно используется текущее окружение. Если явно передан `--storage-path`, `--env` можно не указывать |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
| `--storage-path` | string | Переопределяет корневой путь целевого хранилища; фактический каталог импорта — `<storage-path>/plugins` |
| `--npm-registry` | string | Указывает реестр npm, который нужно использовать, если источник — имя или тег npm-пакета |
## Примеры
@@ -33,28 +33,28 @@ nb plugin import https://github.com/nocobase/plugin-auth-cas/releases/download/v
# Локальный архив
nb plugin import /your/path/plugin-auth-cas-1.4.0.tgz
# npm-пакет или tag
# npm-пакет или тег
nb plugin import @my-scope/plugin-auth-cas@beta
# Приватный npm registry
# Приватный реестр npm
nb plugin import @my-scope/plugin-auth-cas@beta --npm-registry=https://registry.example.com
# Запись прямо в локальный путь storage без привязки к текущему env
# Запись напрямую в локальный путь хранилища без привязки к текущему окружению
nb plugin import ./plugin-auth-cas-1.4.0.tgz --storage-path ./storage
```
## Примечания
Если целевой env уже выбран, обычно достаточно импортировать плагин прямо в `storage/plugins` этого env.
Если целевое окружение уже выбрано, путь по умолчанию — `storage/plugins` этого окружения.
Если тебе нужно только записать плагин в локальный каталог storage, передай `--storage-path`. В этом случае `--env` можно опустить, и CLI запишет файлы прямо в `<storage-path>/plugins`.
Если нужно только записать плагин в локальный каталог хранилища, передайте `--storage-path`. В этом случае `--env` можно опустить, и CLI запишет файлы напрямую в `<storage-path>/plugins`.
После импорта следующим обычным шагом будет перезапуск приложения, а затем решение, нужно ли ещё и включать плагин. В большинстве случаев:
После завершения импорта обычно следует перезапустить приложение, а затем решить, нужно ли также включить плагин. В большинстве случаев:
- При первой установке сначала запусти [`nb app restart`](../app/restart.md), а потом [`nb plugin enable`](./enable.md)
- Если ты просто повторно импортировал более новую версию, сначала перезапусти приложение, а затем проверь, что новая версия уже загрузилась
- при первой установке сначала выполните [`nb app restart`](../app/restart.md), а затем [`nb plugin enable`](./enable.md);
- если вы только повторно импортировали более новый архив, сначала перезапустите приложение, а затем проверьте, что новая версия загрузилась.
Если источник находится в приватном npm registry, сначала выполни вход, а потом запускай импорт:
Если источник находится в приватном реестре npm, сначала выполните вход, а затем импортируйте пакет:
```bash
npm login --registry=https://registry.example.com
@@ -63,7 +63,7 @@ nb plugin import @my-scope/plugin-auth-cas@beta --npm-registry=https://registry.
:::warning Примечание
Тебе не нужно вручную распаковывать что-либо в `storage/plugins`. `nb plugin import` сам поместит плагин в правильный каталог.
Вручную распаковывать что-либо в `storage/plugins` не нужно: `nb plugin import` автоматически поместит плагин в правильный каталог.
:::
docs/docs/ru/api/cli/plugin/index.md
+6 -6
View File
@@ -1,12 +1,12 @@
---
title: "nb plugin"
description: "Справочник по команде nb plugin: управление плагинами выбранного env NocoBase и импорт упакованных плагинов в storage/plugins."
description: "Справочник по команде nb plugin: управление плагинами выбранного окружения NocoBase и импорт упакованных плагинов в storage/plugins."
keywords: "nb plugin,NocoBase CLI,управление плагинами,enable,disable,list,import"
---
# nb plugin
Управление плагинами выбранного env NocoBase. Для env типа npm/Git команды плагинов выполняются локально, для Docker env — в сохранённом контейнере приложения, а для HTTP env — через API при его доступности.
Управляет плагинами выбранного окружения NocoBase. Для окружений типов `npm`/`git` команды плагинов выполняются локально, для окружений типа `docker` — в сохранённом контейнере приложения, а для окружений типа `http` — через API, если это доступно.
## Использование
@@ -18,10 +18,10 @@ nb plugin <command>
| Команда | Описание |
| --- | --- |
| [`nb plugin import`](./import.md) | Импортирует упакованный архив плагина или npm-пакет |
| [`nb plugin list`](./list.md) | Перечисляет установленные плагины |
| [`nb plugin enable`](./enable.md) | Включает один или несколько плагинов |
| [`nb plugin disable`](./disable.md) | Отключает один или несколько плагинов |
| [`nb plugin import`](./import.md) | Импортировать упакованный архив плагина или npm-пакет |
| [`nb plugin list`](./list.md) | Показать список установленных плагинов |
| [`nb plugin enable`](./enable.md) | Включить один или несколько плагинов |
| [`nb plugin disable`](./disable.md) | Отключить один или несколько плагинов |
## Примеры
docs/docs/ru/api/cli/plugin/list.md
+5 -5
View File
@@ -1,12 +1,12 @@
---
title: "nb plugin list"
description: "Справочник по команде nb plugin list: список плагинов выбранного env NocoBase."
description: "Справочник по команде nb plugin list: список плагинов выбранного окружения NocoBase."
keywords: "nb plugin list,NocoBase CLI,список плагинов"
---
# nb plugin list
Перечисляет плагины, установленные в выбранном env.
Показывает список установленных плагинов для выбранного окружения.
## Использование
@@ -18,8 +18,8 @@ nb plugin list [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя env CLI, при пропуске используется текущий env |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение |
| `--env`, `-e` | string | Имя CLI-окружения; если не указано, используется текущее окружение |
| `--yes`, `-y` | boolean | Если явно переданный `--env` указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение |
## Примеры
@@ -30,7 +30,7 @@ nb plugin list -e local --yes
nb plugin list -e local-docker
```
Если вы явно передаёте `--env`, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
Если вы явно передаёте `--env`, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ агента добавьте `--yes` самостоятельно либо сначала выполните `nb env use <name>`, а затем повторите попытку.
## Связанные команды
docs/docs/ru/api/cli/proxy/caddy/current.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy caddy current"
description: "Справка по команде nb proxy caddy current: показывает текущий driver provider Caddy."
keywords: "nb proxy caddy current,NocoBase CLI,caddy,driver"
description: "Справочник по команде nb proxy caddy current: вывод текущего драйвера провайдера Caddy."
keywords: "nb proxy caddy current,NocoBase CLI,caddy,драйвер"
---
# nb proxy caddy current
Показывает текущий driver provider Caddy.
Выводит текущий драйвер провайдера Caddy.
## Использование
@@ -16,7 +16,7 @@ nb proxy caddy current
## Вывод
Команда выводит одно из двух значений:
Команда напрямую выводит одно значение:
- `local`
- `docker`
docs/docs/ru/api/cli/proxy/caddy/generate.md
+9 -9
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy caddy generate"
description: "Справка по команде nb proxy caddy generate: генерирует или обновляет конфигурацию Caddy для одного env, управляемого CLI."
keywords: "nb proxy caddy generate,NocoBase CLI,caddy,reverse proxy,proxy configuration"
description: "Справочник по команде nb proxy caddy generate: генерация или обновление конфигурации Caddy для одного окружения, управляемого CLI."
keywords: "nb proxy caddy generate,NocoBase CLI,caddy,обратный прокси,конфигурация прокси"
---
# nb proxy caddy generate
Генерирует или обновляет входную конфигурацию Caddy для одного env, управляемого CLI.
Генерирует или обновляет входную конфигурацию Caddy для одного окружения, управляемого CLI.
## Использование
@@ -18,20 +18,20 @@ nb proxy caddy generate --env <name> [--host <domain>] [--port <port>]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя env, управляемого CLI, для которого нужно сгенерировать конфигурацию |
| `--host` | string | Host, который будет записан в адрес сайта, например `app1.example.com` |
| `--env`, `-e` | string | Имя окружения, управляемого CLI, для которого нужно сгенерировать конфигурацию |
| `--host` | string | Хост, который будет записан в адрес сайта, например `app1.example.com` |
| `--port` | string | Порт прослушивания, который будет записан в адрес сайта, например `8080` |
## Сгенерированные файлы
На примере env `test2` команда обычно поддерживает следующие файлы и каталоги:
На примере окружения `test2` команда обычно поддерживает следующие файлы и каталоги:
- `NB_CLI_ROOT/.nocobase/proxy/caddy/nocobase.caddy`
- `NB_CLI_ROOT/.nocobase/proxy/caddy/test2/app.caddy`
- `NB_CLI_ROOT/.nocobase/proxy/caddy/test2/public/index-v1.html`
- `NB_CLI_ROOT/.nocobase/proxy/caddy/test2/public/index-v2.html`
В текущем дизайне `app.caddy` уже является полной конфигурацией сайта для одного env и больше не разделяется на отдельный файл `generated.caddy`.
В текущей реализации `app.caddy` уже является полной конфигурацией сайта для одного окружения и больше не разделяется на отдельный файл `generated.caddy`.
## Примеры
@@ -44,8 +44,8 @@ nb proxy caddy generate --env demo --host demo.local.nocobase.com --port 8080
- `generate` только записывает или обновляет конфигурацию и не запускает Caddy автоматически
- Повторная генерация полностью перезаписывает `app.caddy`
- Если вы меняете параметры вроде `app-port` или `app-public-path` через `nb env update`, обычно нужно повторно запустить эту команду
- Эту команду можно использовать только для env `local` или `docker`, управляемых CLI
- Если вы меняете параметры вроде `app-port` или `app-public-path` через `nb env update`, обычно нужно повторно выполнить эту команду
- Эту команду можно использовать только для окружений типов `local` или `docker`, управляемых CLI
## Связанные команды
docs/docs/ru/api/cli/proxy/caddy/index.md
+19 -19
View File
@@ -1,17 +1,17 @@
---
title: "nb proxy caddy"
description: "Справка по группе команд nb proxy caddy: управление driver provider Caddy, генерацией конфигурации и runtime-контролем."
keywords: "nb proxy caddy,NocoBase CLI,caddy,reverse proxy,proxy configuration"
description: "Справочник по группе команд nb proxy caddy: управление драйвером провайдера Caddy, генерацией конфигурации и контролем среды выполнения."
keywords: "nb proxy caddy,NocoBase CLI,caddy,обратный прокси,конфигурация прокси"
---
# nb proxy caddy
`nb proxy caddy` — это точка входа группы команд для provider Caddy.
`nb proxy caddy` — точка входа группы команд провайдера Caddy.
Если у вас уже есть домен, вы хотите быстро включить HTTPS и не хотите вручную поддерживать слишком много деталей TLS, обычно стоит начинать отсюда. Эта группа решает две задачи:
- выбрать способ запуска Caddy — `local` или `docker`
- генерировать, запускать, перезагружать и проверять входную конфигурацию Caddy для env, управляемых CLI
- генерировать, запускать, перезагружать и проверять точку входа Caddy для окружений, управляемых CLI
## Использование
@@ -23,26 +23,26 @@ nb proxy caddy <command>
| Команда | Описание |
| --- | --- |
| [`nb proxy caddy use`](./use.md) | Переключает driver Caddy |
| [`nb proxy caddy current`](./current.md) | Показывает текущий driver |
| [`nb proxy caddy generate`](./generate.md) | Генерирует или обновляет конфигурацию Caddy для одного env |
| [`nb proxy caddy start`](./start.md) | Запускает proxy Caddy |
| [`nb proxy caddy restart`](./restart.md) | Перезапускает proxy Caddy |
| [`nb proxy caddy reload`](./reload.md) | Перезагружает конфигурацию Caddy |
| [`nb proxy caddy stop`](./stop.md) | Останавливает proxy Caddy |
| [`nb proxy caddy status`](./status.md) | Показывает runtime-статус Caddy |
| [`nb proxy caddy info`](./info.md) | Показывает driver, пути конфигурации и сведения о runtime |
| [`nb proxy caddy use`](./use.md) | Переключить драйвер Caddy |
| [`nb proxy caddy current`](./current.md) | Показать текущий драйвер |
| [`nb proxy caddy generate`](./generate.md) | Сгенерировать или обновить конфигурацию Caddy для одного окружения |
| [`nb proxy caddy start`](./start.md) | Запустить прокси Caddy |
| [`nb proxy caddy restart`](./restart.md) | Перезапустить прокси Caddy |
| [`nb proxy caddy reload`](./reload.md) | Перезагрузить конфигурацию Caddy |
| [`nb proxy caddy stop`](./stop.md) | Остановить прокси Caddy |
| [`nb proxy caddy status`](./status.md) | Показать состояние среды выполнения Caddy |
| [`nb proxy caddy info`](./info.md) | Показать драйвер, пути конфигурации и сведения о среде выполнения |
## Примечания
- Текущий driver хранится в `proxy.caddy-driver`
- Driver по умолчанию — `local`
- Локальный driver использует исполняемый файл, указанный в `bin.caddy`, его значение по умолчанию — `caddy`
- Docker driver использует `caddy:latest`
- Текущий драйвер хранится в `proxy.caddy-driver`
- Драйвер по умолчанию — `local`
- Локальный драйвер использует исполняемый файл, указанный в `bin.caddy`; по умолчанию это `caddy`
- Драйвер `docker` использует `caddy:latest`
- Имя Docker-контейнера по умолчанию — `<docker.container-prefix>-caddy-proxy`
- Docker driver монтирует `NB_CLI_ROOT` хоста в контейнер по пути `/apps`
- Драйвер `docker` монтирует `NB_CLI_ROOT` хоста в контейнер по пути `/apps`
## Типовой рабочий процесс
## Типичный рабочий процесс
```bash
nb proxy caddy use local
docs/docs/ru/api/cli/proxy/caddy/info.md
+2 -2
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy caddy info"
description: "Справка по команде nb proxy caddy info: показать текущий драйвер provider Caddy, пути конфигурации и runtime-детали."
description: "Справочник по команде nb proxy caddy info: вывод текущего драйвера провайдера Caddy, путей конфигурации и сведений о среде выполнения."
keywords: "nb proxy caddy info,NocoBase CLI,caddy,пути,конфигурация"
---
# nb proxy caddy info
Показывает текущий драйвер provider Caddy, пути конфигурации и runtime-детали.
Показывает текущий драйвер провайдера Caddy, пути конфигурации и сведения о среде выполнения.
## Использование
docs/docs/ru/api/cli/proxy/caddy/reload.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy caddy reload"
description: "Справка по команде nb proxy caddy reload: перезагружает конфигурацию Caddy с текущим driver."
description: "Справочник по команде nb proxy caddy reload: перезагрузка конфигурации Caddy с текущим драйвером."
keywords: "nb proxy caddy reload,NocoBase CLI,caddy,reload"
---
# nb proxy caddy reload
Перезагружает конфигурацию Caddy с текущим driver.
Перезагружает конфигурацию Caddy с текущим драйвером.
## Использование
@@ -23,8 +23,8 @@ nb proxy caddy reload
## Примечания
- Обычно эту команду используют после повторной генерации конфигурации
- Для `reload` Caddy уже должен быть запущен; если он еще не запущен, сначала выполните `nb proxy caddy start`
- Локальный driver перезагружает локальный Caddy, а Docker driver перезагружает Caddy внутри контейнера
- Для `reload` Caddy уже должен быть запущен; если он ещё не запущен, сначала выполните `nb proxy caddy start`
- Локальный драйвер перезагружает локальный Caddy, а драйвер `docker` — Caddy внутри контейнера
## Связанные команды
docs/docs/ru/api/cli/proxy/caddy/restart.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy caddy restart"
description: "Справка по команде nb proxy caddy restart: перезапускает proxy Caddy с текущим driver."
description: "Справочник по команде nb proxy caddy restart: перезапуск прокси Caddy с текущим драйвером."
keywords: "nb proxy caddy restart,NocoBase CLI,caddy,restart"
---
# nb proxy caddy restart
Перезапускает proxy Caddy с текущим driver.
Перезапускает прокси Caddy с текущим драйвером.
## Использование
@@ -22,8 +22,8 @@ nb proxy caddy restart
## Примечания
- Эта команда сначала останавливает proxy, а затем запускает его снова
- При `local` или `docker` она работает с локальным процессом или Docker-контейнером, соответствующим текущему driver
- Команда сначала останавливает прокси, а затем запускает его снова
- С драйверами `local` или `docker` она работает с локальным процессом или Docker-контейнером текущего драйвера
## Связанные команды
docs/docs/ru/api/cli/proxy/caddy/start.md
+5 -6
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy caddy start"
description: "Справка по команде nb proxy caddy start: запускает proxy Caddy с текущим driver."
description: "Справочник по команде nb proxy caddy start: запуск прокси Caddy с текущим драйвером."
keywords: "nb proxy caddy start,NocoBase CLI,caddy,start"
---
# nb proxy caddy start
Запускает proxy Caddy с текущим driver.
Запускает прокси Caddy с текущим драйвером.
## Использование
@@ -22,12 +22,11 @@ nb proxy caddy start
## Примечания
- С driver `local` эта команда запускает локальный процесс Caddy
- С driver `docker` эта команда запускает или создает Docker-контейнер
- Если proxy уже запущен, команда сообщит об этом
- С драйвером `local` команда запускает локальный процесс Caddy
- С драйвером `docker` команда запускает или создаёт Docker-контейнер
- Если прокси уже запущен, команда сообщит об этом
## Связанные команды
- [`nb proxy caddy start`](./start.md)
- [`nb proxy caddy stop`](./stop.md)
- [`nb proxy caddy status`](./status.md)
docs/docs/ru/api/cli/proxy/caddy/status.md
+8 -2
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy caddy status"
description: "Справка по команде nb proxy caddy status: показывает текущий runtime-статус proxy Caddy."
description: "Справочник по команде nb proxy caddy status: вывод текущего состояния среды выполнения прокси Caddy."
keywords: "nb proxy caddy status,NocoBase CLI,caddy,status"
---
# nb proxy caddy status
Показывает текущий runtime-статус proxy Caddy.
Показывает текущее состояние среды выполнения прокси Caddy.
## Использование
@@ -23,6 +23,12 @@ nb proxy caddy status
- `config`
- `caddy` или `container`
## Примеры
```bash
nb proxy caddy status
```
## Связанные команды
- [`nb proxy caddy info`](./info.md)
docs/docs/ru/api/cli/proxy/caddy/stop.md
+5 -5
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy caddy stop"
description: "Справка по команде nb proxy caddy stop: останавливает proxy Caddy с текущим driver."
description: "Справочник по команде nb proxy caddy stop: остановка прокси Caddy с текущим драйвером."
keywords: "nb proxy caddy stop,NocoBase CLI,caddy,stop"
---
# nb proxy caddy stop
Останавливает proxy Caddy с текущим driver.
Останавливает прокси Caddy с текущим драйвером.
## Использование
@@ -22,9 +22,9 @@ nb proxy caddy stop
## Примечания
- С driver `local` эта команда останавливает локальный процесс Caddy
- С driver `docker` эта команда останавливает контейнер proxy
- Если proxy уже остановлен, команда сообщит об этом
- С драйвером `local` команда останавливает локальный процесс Caddy
- С драйвером `docker` команда останавливает контейнер прокси
- Если прокси уже остановлен, команда сообщит об этом
## Связанные команды
docs/docs/ru/api/cli/proxy/caddy/use.md
+5 -5
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy caddy use"
description: "Справка по команде nb proxy caddy use: переключает текущий driver provider Caddy."
keywords: "nb proxy caddy use,NocoBase CLI,caddy,driver"
description: "Справочник по команде nb proxy caddy use: переключение текущего драйвера провайдера Caddy."
keywords: "nb proxy caddy use,NocoBase CLI,caddy,драйвер"
---
# nb proxy caddy use
Переключает текущий driver provider Caddy.
Переключает текущий драйвер провайдера Caddy.
## Использование
@@ -29,8 +29,8 @@ nb proxy caddy use docker
## Примечания
- Эта команда сохраняет результат в `proxy.caddy-driver`
- Последующие команды, такие как `start`, `reload`, `stop`, `status` и `info`, будут использовать текущий driver
- Команда сохраняет результат в `proxy.caddy-driver`
- Последующие команды, такие как `start`, `reload`, `stop`, `status` и `info`, используют текущий драйвер
## Связанные команды
docs/docs/ru/api/cli/proxy/index.md
+28 -28
View File
@@ -1,19 +1,19 @@
---
title: "nb proxy"
description: "Справка по группе команд nb proxy: выбор provider Nginx или Caddy и управление reverse proxy entrypoint для env, управляемых CLI."
keywords: "nb proxy,NocoBase CLI,nginx,caddy,reverse proxy,конфигурация proxy"
description: "Справочник по группе команд nb proxy: выбор провайдера Nginx или Caddy и управление точками входа обратного прокси для окружений, управляемых CLI."
keywords: "nb proxy,NocoBase CLI,nginx,caddy,обратный прокси,конфигурация прокси"
---
# nb proxy
В NocoBase CLI `nb proxy` — это единая точка входа для управления reverse proxy.
В NocoBase CLI `nb proxy` — единая точка входа для управления обратным прокси.
CLI разделяет управление env и управление входным уровнем:
CLI разделяет управление окружениями и управление входным уровнем:
- `nb env` сохраняет и поддерживает env приложения
- `nb proxy` генерирует и управляет entrypoint Nginx или Caddy для этих env, управляемых CLI
- `nb env` сохраняет и поддерживает окружения приложения
- `nb proxy` генерирует и управляет точками входа Nginx или Caddy для этих окружений, управляемых CLI
Если ваше приложение уже сохранено как env, управляемое CLI, и это env имеет тип `local` или `docker`, обычно достаточно выбрать один из subcommand provider.
Если приложение уже сохранено как окружение, управляемое CLI, и это окружение имеет тип `local` или `docker`, обычно достаточно выбрать подкоманду провайдера.
## Использование
@@ -45,36 +45,36 @@ nb proxy caddy status
nb proxy caddy info
```
## Providers
## Провайдеры
| Я хочу... | Куда перейти |
| --- | --- |
| Продолжать использовать Nginx для сайтов, сертификатов, кэша или контроля доступа | [`nb proxy nginx`](./nginx/index.md) |
| Быстро включить HTTPS и самостоятельно поддерживать меньше деталей TLS | [`nb proxy caddy`](./caddy/index.md) |
| Настроить параметры env, которые могут влиять на результат proxy, например `app-port` или `app-public-path` | [`nb env update`](../env/update.md) |
| Настроить параметры окружения, которые могут влиять на вывод прокси, например `app-port` или `app-public-path` | [`nb env update`](../env/update.md) |
## Примечания
- У `nb proxy` нет собственных независимых флагов
- Используйте `nb proxy nginx` или `nb proxy caddy` для генерации и управления entrypoint
- Оба provider работают только для управляемых env, runtime которых доступен с текущей машины, то есть `local` или `docker`
- Оба provider поддерживают два драйвера: `local` и `docker`
- Используйте `nb proxy nginx` или `nb proxy caddy` для генерации и управления точками входа
- Оба провайдера работают только для управляемых окружений, среда выполнения которых доступна с текущей машины, то есть `local` или `docker`
- Оба провайдера поддерживают два драйвера: `local` и `docker`
- `use` сохраняет драйвер по умолчанию, а `current` напрямую выводит текущий драйвер
- `generate` записывает или обновляет файлы entry-конфигурации и не запускает proxy-процесс автоматически
- `start`, `restart`, `reload`, `stop`, `status` и `info` работают с runtime текущего драйвера
- `generate` записывает или обновляет файлы входной конфигурации и не запускает процесс прокси автоматически
- `start`, `restart`, `reload`, `stop`, `status` и `info` работают со средой выполнения текущего драйвера
- Если вы меняете параметры вроде `app-port` или `app-public-path` через `nb env update`, обычно после этого нужно повторно выполнить соответствующую команду `generate`
- Эта группа команд пока не работает для env, у которых есть только удалённое API-подключение, и для SSH env
- Эта группа команд пока не работает для окружений только с удалённым API-подключением и для окружений типа `ssh`
## Типичный сценарий
## Типичный рабочий процесс
```bash
# 1. Выбрать provider и драйвер runtime
# 1. Выбрать провайдера и драйвер среды выполнения
nb proxy nginx use docker
# 2. Сгенерировать entry-конфигурацию для одного CLI-managed env
# 2. Сгенерировать входную конфигурацию для одного окружения, управляемого CLI
nb proxy nginx generate --env app1 --host app1.example.com
# 3. Запустить proxy
# 3. Запустить прокси
nb proxy nginx start
# 4. Проверить статус и информацию о путях
@@ -91,25 +91,25 @@ nb proxy nginx reload
| Команда | Назначение |
| --- | --- |
| `use` | Переключить драйвер по умолчанию для текущего provider |
| `current` | Показать текущий драйвер provider, например `local` или `docker` |
| `generate` | Сгенерировать или обновить proxy entry-файлы для одного env |
| `start` | Запустить proxy с текущим драйвером |
| `use` | Переключить драйвер по умолчанию для текущего провайдера |
| `current` | Показать текущий драйвер провайдера, например `local` или `docker` |
| `generate` | Сгенерировать или обновить файлы конфигурации точки входа для одного окружения |
| `start` | Запустить прокси с текущим драйвером |
| `reload` | Перезагрузить конфигурацию без остановки сервиса |
| `restart` | Остановить и затем запустить снова |
| `stop` | Остановить proxy |
| `status` | Показать состояние runtime |
| `info` | Показать драйвер, путь к config file, runtime root, upstream host и другие связанные runtime-детали |
| `stop` | Остановить прокси |
| `status` | Показать состояние среды выполнения |
| `info` | Показать драйвер, путь к файлу конфигурации, корень среды выполнения, `upstream host` и другие связанные сведения о среде выполнения |
## Примеры
```bash
# Сгенерировать и запустить Nginx для одного env
# Сгенерировать и запустить Nginx для одного окружения
nb proxy nginx use docker
nb proxy nginx generate --env demo --host demo.local.nocobase.com
nb proxy nginx start
# Сгенерировать и запустить Caddy для одного env
# Сгенерировать и запустить Caddy для одного окружения
nb proxy caddy use local
nb proxy caddy generate --env demo --host demo.local.nocobase.com
nb proxy caddy start
docs/docs/ru/api/cli/proxy/nginx/current.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy nginx current"
description: "Справка по команде nb proxy nginx current: показывает текущий driver provider Nginx."
keywords: "nb proxy nginx current,NocoBase CLI,nginx,driver"
description: "Справочник по команде nb proxy nginx current: вывод текущего драйвера провайдера Nginx."
keywords: "nb proxy nginx current,NocoBase CLI,nginx,драйвер"
---
# nb proxy nginx current
Показывает текущий driver provider Nginx.
Выводит текущий драйвер провайдера Nginx.
## Использование
@@ -16,7 +16,7 @@ nb proxy nginx current
## Вывод
Команда выводит одно из двух значений:
Команда напрямую выводит одно значение:
- `local`
- `docker`
docs/docs/ru/api/cli/proxy/nginx/generate.md
+9 -9
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy nginx generate"
description: "Справка по команде nb proxy nginx generate: генерирует или обновляет конфигурацию Nginx для одного env, управляемого CLI."
keywords: "nb proxy nginx generate,NocoBase CLI,nginx,reverse proxy,proxy configuration"
description: "Справочник по команде nb proxy nginx generate: генерация или обновление конфигурации Nginx для одного окружения, управляемого CLI."
keywords: "nb proxy nginx generate,NocoBase CLI,nginx,обратный прокси,конфигурация прокси"
---
# nb proxy nginx generate
Генерирует или обновляет входную конфигурацию Nginx для одного env, управляемого CLI.
Генерирует или обновляет входную конфигурацию Nginx для одного окружения, управляемого CLI.
## Использование
@@ -18,13 +18,13 @@ nb proxy nginx generate --env <name> [--host <domain>] [--port <port>]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--env`, `-e` | string | Имя env, управляемого CLI, для которого нужно сгенерировать конфигурацию |
| `--host` | string | Host, который будет записан во входную конфигурацию, например `app1.example.com` |
| `--env`, `-e` | string | Имя окружения, управляемого CLI, для которого нужно сгенерировать конфигурацию |
| `--host` | string | Хост, который будет записан во входную конфигурацию, например `app1.example.com` |
| `--port` | string | Порт прослушивания, который будет записан во входную конфигурацию, например `8080` |
## Сгенерированные файлы
На примере env `test2` команда обычно поддерживает следующие файлы и каталоги:
На примере окружения `test2` команда обычно поддерживает следующие файлы и каталоги:
- `NB_CLI_ROOT/.nocobase/proxy/nginx/nocobase.conf`
- `NB_CLI_ROOT/.nocobase/proxy/nginx/snippets/`
@@ -32,7 +32,7 @@ nb proxy nginx generate --env <name> [--host <domain>] [--port <port>]
- `NB_CLI_ROOT/.nocobase/proxy/nginx/test2/public/index-v1.html`
- `NB_CLI_ROOT/.nocobase/proxy/nginx/test2/public/index-v2.html`
Сгенерированная входная конфигурация Nginx охватывает такие основные области:
Сгенерированная точка входа Nginx охватывает такие основные области:
- `uploads`
- `dist`
@@ -52,8 +52,8 @@ nb proxy nginx generate --env demo --host demo.local.nocobase.com --port 8080
- `generate` только записывает или обновляет конфигурацию и не запускает Nginx автоматически
- `app.conf` — редактируемый входной файл, но управляемый блок внутри него должен оставаться без изменений
- Если вы меняете параметры вроде `app-port` или `app-public-path` через `nb env update`, обычно нужно повторно запустить эту команду
- Эту команду можно использовать только для env `local` или `docker`, управляемых CLI
- Если вы меняете параметры вроде `app-port` или `app-public-path` через `nb env update`, обычно нужно повторно выполнить эту команду
- Эту команду можно использовать только для окружений типов `local` или `docker`, управляемых CLI
## Связанные команды
docs/docs/ru/api/cli/proxy/nginx/index.md
+20 -20
View File
@@ -1,17 +1,17 @@
---
title: "nb proxy nginx"
description: "Справка по группе команд nb proxy nginx: управление driver provider Nginx, генерацией конфигурации и runtime-контролем."
keywords: "nb proxy nginx,NocoBase CLI,nginx,reverse proxy,proxy configuration"
description: "Справочник по группе команд nb proxy nginx: управление драйвером провайдера Nginx, генерацией конфигурации и контролем среды выполнения."
keywords: "nb proxy nginx,NocoBase CLI,nginx,обратный прокси,конфигурация прокси"
---
# nb proxy nginx
`nb proxy nginx` — это точка входа группы команд для provider Nginx.
`nb proxy nginx` — точка входа группы команд провайдера Nginx.
Если вы уже используете Nginx для управления сайтами, сертификатами, кешем или контролем доступа, обычно стоит начинать отсюда. Эта группа решает две задачи:
Если вы уже используете Nginx для управления сайтами, сертификатами, кэшем или контролем доступа, обычно стоит начинать отсюда. Эта группа решает две задачи:
- выбрать способ запуска Nginx — `local` или `docker`
- генерировать, запускать, перезагружать и проверять входную конфигурацию Nginx для env, управляемых CLI
- генерировать, запускать, перезагружать и проверять точку входа Nginx для окружений, управляемых CLI
## Использование
@@ -23,26 +23,26 @@ nb proxy nginx <command>
| Команда | Описание |
| --- | --- |
| [`nb proxy nginx use`](./use.md) | Переключает driver Nginx |
| [`nb proxy nginx current`](./current.md) | Показывает текущий driver |
| [`nb proxy nginx generate`](./generate.md) | Генерирует или обновляет конфигурацию Nginx для одного env |
| [`nb proxy nginx start`](./start.md) | Запускает proxy Nginx |
| [`nb proxy nginx restart`](./restart.md) | Перезапускает proxy Nginx |
| [`nb proxy nginx reload`](./reload.md) | Перезагружает конфигурацию Nginx |
| [`nb proxy nginx stop`](./stop.md) | Останавливает proxy Nginx |
| [`nb proxy nginx status`](./status.md) | Показывает runtime-статус Nginx |
| [`nb proxy nginx info`](./info.md) | Показывает driver, пути конфигурации и сведения о runtime |
| [`nb proxy nginx use`](./use.md) | Переключить драйвер Nginx |
| [`nb proxy nginx current`](./current.md) | Показать текущий драйвер |
| [`nb proxy nginx generate`](./generate.md) | Сгенерировать или обновить конфигурацию Nginx для одного окружения |
| [`nb proxy nginx start`](./start.md) | Запустить прокси Nginx |
| [`nb proxy nginx restart`](./restart.md) | Перезапустить прокси Nginx |
| [`nb proxy nginx reload`](./reload.md) | Перезагрузить конфигурацию Nginx |
| [`nb proxy nginx stop`](./stop.md) | Остановить прокси Nginx |
| [`nb proxy nginx status`](./status.md) | Показать состояние среды выполнения Nginx |
| [`nb proxy nginx info`](./info.md) | Показать драйвер, пути конфигурации и сведения о среде выполнения |
## Примечания
- Текущий driver хранится в `proxy.nginx-driver`
- Driver по умолчанию — `local`
- Локальный driver использует исполняемый файл, указанный в `bin.nginx`, его значение по умолчанию — `nginx`
- Docker driver использует `nginx:latest`
- Текущий драйвер хранится в `proxy.nginx-driver`
- Драйвер по умолчанию — `local`
- Локальный драйвер использует исполняемый файл, указанный в `bin.nginx`; по умолчанию это `nginx`
- Драйвер `docker` использует `nginx:latest`
- Имя Docker-контейнера по умолчанию — `<docker.container-prefix>-nginx-proxy`
- Docker driver монтирует `NB_CLI_ROOT` хоста в контейнер по пути `/apps`
- Драйвер `docker` монтирует `NB_CLI_ROOT` хоста в контейнер по пути `/apps`
## Типовой рабочий процесс
## Типичный рабочий процесс
```bash
nb proxy nginx use docker
docs/docs/ru/api/cli/proxy/nginx/info.md
+2 -2
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy nginx info"
description: "Справка по команде nb proxy nginx info: показать текущий драйвер provider Nginx, пути конфигурации и runtime-детали."
description: "Справочник по команде nb proxy nginx info: вывод текущего драйвера провайдера Nginx, путей конфигурации и сведений о среде выполнения."
keywords: "nb proxy nginx info,NocoBase CLI,nginx,пути,конфигурация"
---
# nb proxy nginx info
Показывает текущий драйвер provider Nginx, пути конфигурации и runtime-детали.
Показывает текущий драйвер провайдера Nginx, пути конфигурации и сведения о среде выполнения.
## Использование
docs/docs/ru/api/cli/proxy/nginx/reload.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy nginx reload"
description: "Справка по команде nb proxy nginx reload: перезагружает конфигурацию Nginx с текущим driver."
description: "Справочник по команде nb proxy nginx reload: перезагрузка конфигурации Nginx с текущим драйвером."
keywords: "nb proxy nginx reload,NocoBase CLI,nginx,reload"
---
# nb proxy nginx reload
Перезагружает конфигурацию Nginx с текущим driver.
Перезагружает конфигурацию Nginx с текущим драйвером.
## Использование
@@ -23,8 +23,8 @@ nb proxy nginx reload
## Примечания
- Обычно эту команду используют после повторной генерации конфигурации
- Для `reload` Nginx уже должен быть запущен; если он еще не запущен, сначала выполните `nb proxy nginx start`
- Локальный driver перезагружает локальный Nginx, а Docker driver перезагружает Nginx внутри контейнера
- Для `reload` Nginx уже должен быть запущен; если он ещё не запущен, сначала выполните `nb proxy nginx start`
- Локальный драйвер перезагружает локальный Nginx, а драйвер `docker` — Nginx внутри контейнера
## Связанные команды
docs/docs/ru/api/cli/proxy/nginx/restart.md
+4 -4
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy nginx restart"
description: "Справка по команде nb proxy nginx restart: перезапускает proxy Nginx с текущим driver."
description: "Справочник по команде nb proxy nginx restart: перезапуск прокси Nginx с текущим драйвером."
keywords: "nb proxy nginx restart,NocoBase CLI,nginx,restart"
---
# nb proxy nginx restart
Перезапускает proxy Nginx с текущим driver.
Перезапускает прокси Nginx с текущим драйвером.
## Использование
@@ -22,8 +22,8 @@ nb proxy nginx restart
## Примечания
- Эта команда сначала останавливает proxy, а затем запускает его снова
- При `local` или `docker` она работает с локальным процессом или Docker-контейнером, соответствующим текущему driver
- Команда сначала останавливает прокси, а затем запускает его снова
- С драйверами `local` или `docker` она работает с локальным процессом или Docker-контейнером текущего драйвера
## Связанные команды
docs/docs/ru/api/cli/proxy/nginx/start.md
+5 -6
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy nginx start"
description: "Справка по команде nb proxy nginx start: запускает proxy Nginx с текущим driver."
description: "Справочник по команде nb proxy nginx start: запуск прокси Nginx с текущим драйвером."
keywords: "nb proxy nginx start,NocoBase CLI,nginx,start"
---
# nb proxy nginx start
Запускает proxy Nginx с текущим driver.
Запускает прокси Nginx с текущим драйвером.
## Использование
@@ -22,12 +22,11 @@ nb proxy nginx start
## Примечания
- С driver `local` эта команда запускает локальный процесс Nginx
- С driver `docker` эта команда запускает или создает Docker-контейнер
- Если proxy уже запущен, команда сообщит об этом
- С драйвером `local` команда запускает локальный процесс Nginx
- С драйвером `docker` команда запускает или создаёт Docker-контейнер
- Если прокси уже запущен, команда сообщит об этом
## Связанные команды
- [`nb proxy nginx start`](./start.md)
- [`nb proxy nginx stop`](./stop.md)
- [`nb proxy nginx status`](./status.md)
docs/docs/ru/api/cli/proxy/nginx/status.md
+8 -2
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy nginx status"
description: "Справка по команде nb proxy nginx status: показывает текущий runtime-статус proxy Nginx."
description: "Справочник по команде nb proxy nginx status: вывод текущего состояния среды выполнения прокси Nginx."
keywords: "nb proxy nginx status,NocoBase CLI,nginx,status"
---
# nb proxy nginx status
Показывает текущий runtime-статус proxy Nginx.
Показывает текущее состояние среды выполнения прокси Nginx.
## Использование
@@ -23,6 +23,12 @@ nb proxy nginx status
- `config`
- `nginx` или `container`
## Примеры
```bash
nb proxy nginx status
```
## Связанные команды
- [`nb proxy nginx info`](./info.md)
docs/docs/ru/api/cli/proxy/nginx/stop.md
+5 -5
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy nginx stop"
description: "Справка по команде nb proxy nginx stop: останавливает proxy Nginx с текущим driver."
description: "Справочник по команде nb proxy nginx stop: остановка прокси Nginx с текущим драйвером."
keywords: "nb proxy nginx stop,NocoBase CLI,nginx,stop"
---
# nb proxy nginx stop
Останавливает proxy Nginx с текущим driver.
Останавливает прокси Nginx с текущим драйвером.
## Использование
@@ -22,9 +22,9 @@ nb proxy nginx stop
## Примечания
- С driver `local` эта команда останавливает локальный процесс Nginx
- С driver `docker` эта команда останавливает контейнер proxy
- Если proxy уже остановлен, команда сообщит об этом
- С драйвером `local` команда останавливает локальный процесс Nginx
- С драйвером `docker` команда останавливает контейнер прокси
- Если прокси уже остановлен, команда сообщит об этом
## Связанные команды
docs/docs/ru/api/cli/proxy/nginx/use.md
+5 -5
View File
@@ -1,12 +1,12 @@
---
title: "nb proxy nginx use"
description: "Справка по команде nb proxy nginx use: переключает текущий driver provider Nginx."
keywords: "nb proxy nginx use,NocoBase CLI,nginx,driver"
description: "Справочник по команде nb proxy nginx use: переключение текущего драйвера провайдера Nginx."
keywords: "nb proxy nginx use,NocoBase CLI,nginx,драйвер"
---
# nb proxy nginx use
Переключает текущий driver provider Nginx.
Переключает текущий драйвер провайдера Nginx.
## Использование
@@ -29,8 +29,8 @@ nb proxy nginx use docker
## Примечания
- Эта команда сохраняет результат в `proxy.nginx-driver`
- Последующие команды, такие как `start`, `reload`, `stop`, `status` и `info`, будут использовать текущий driver
- Команда сохраняет результат в `proxy.nginx-driver`
- Последующие команды, такие как `start`, `reload`, `stop`, `status` и `info`, используют текущий драйвер
## Связанные команды
docs/docs/ru/api/cli/scaffold/migration.md
+2 -2
View File
@@ -19,8 +19,8 @@ nb scaffold migration <name> --pkg <pkg> [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `<name>` | string | Имя миграционного скрипта, обязательный параметр |
| `--pkg` | string | Имя пакета плагина-владельца, обязательный параметр |
| `--on` | string | Момент выполнения: `beforeLoad`, `afterSync` или `afterLoad` |
| `--pkg` | string | Имя пакета плагина, обязательный параметр |
| `--on` | string | Этап выполнения: `beforeLoad`, `afterSync` или `afterLoad` |
## Примеры
docs/docs/ru/api/cli/self/check.md
+10 -10
View File
@@ -1,12 +1,12 @@
---
title: "nb self check"
description: "Справочник по команде nb self check: проверка версии установленного NocoBase CLI и поддержки автообновления."
description: "Справочник по команде nb self check: проверка версии установленного NocoBase CLI и поддержки самообновления."
keywords: "nb self check,NocoBase CLI,проверка версии"
---
# nb self check
Проверяет текущую установку NocoBase CLI, определяет последнюю версию выбранного channel и сообщает о поддержке автоматического самообновления.
Проверяет текущую установку NocoBase CLI, определяет последнюю версию для выбранного канала релиза и сообщает, поддерживается ли самообновление.
## Использование
@@ -18,25 +18,25 @@ nb self check [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--channel` | string | Channel релиза для сравнения, по умолчанию `auto`; возможные значения: `auto`, `latest`, `test`, `beta`, `alpha` |
| `--channel` | string | Канал релиза для сравнения, по умолчанию `auto`; возможные значения: `auto`, `latest`, `test`, `beta`, `alpha` |
| `--json` | boolean | Вывести в формате JSON |
## Метод установки
## Способ установки
`nb self check` определяет текущий метод установки во время выполнения. Исторический cache `self-install-methods.json` не используется.
`nb self check` определяет текущий способ установки при выполнении команды. Исторический кэш `self-install-methods.json` не используется.
Команда может вывести такие методы установки:
Команда может вывести такие способы установки:
| Метод установки | Значение |
| Способ установки | Описание |
| --- | --- |
| `npm-global` | CLI установлен в текущем `npm prefix -g`. |
| `pnpm-global` | CLI установлен в глобальном дереве `node_modules` pnpm. |
| `yarn-global` | CLI запускается из `yarn global bin` или установлен в `yarn global dir`. |
| `package-local` | CLI установлен в дереве зависимостей локального проекта. |
| `source` | CLI запущен из checkout репозитория. |
| `unknown` | Установку CLI не удалось сопоставить с поддерживаемым методом установки. |
| `source` | CLI запущен из рабочей копии репозитория. |
| `unknown` | Установку CLI не удалось сопоставить с поддерживаемым способом установки. |
Самообновление поддерживается для `npm-global`, `pnpm-global` и `yarn-global`. Для `package-local` или `source` обновляйте родительский проект или checkout репозитория.
Самообновление поддерживается для `npm-global`, `pnpm-global` и `yarn-global`. Для `package-local` или `source` обновляйте родительский проект или рабочую копию репозитория.
## Примеры
docs/docs/ru/api/cli/self/index.md
+3 -3
View File
@@ -1,7 +1,7 @@
---
title: "nb self"
description: "Справочник по команде nb self: проверка или обновление установленного NocoBase CLI."
keywords: "nb self,NocoBase CLI,автообновление,проверка версии"
keywords: "nb self,NocoBase CLI,самообновление,проверка версии"
---
# nb self
@@ -18,8 +18,8 @@ nb self <command>
| Команда | Описание |
| --- | --- |
| [`nb self check`](./check.md) | Проверяет текущую версию CLI и поддержку автообновления |
| [`nb self update`](./update.md) | Обновляет NocoBase CLI, глобально установленный через npm, pnpm или yarn |
| [`nb self check`](./check.md) | Проверить текущую версию CLI и поддержку самообновления |
| [`nb self update`](./update.md) | Обновить NocoBase CLI, глобально установленный через npm, pnpm или yarn |
## Примеры
docs/docs/ru/api/cli/self/update.md
+8 -8
View File
@@ -1,12 +1,12 @@
---
title: "nb self update"
description: "Справочник по команде nb self update: обновление NocoBase CLI, глобально установленного через npm, pnpm или yarn."
keywords: "nb self update,NocoBase CLI,обновление,автообновление"
keywords: "nb self update,NocoBase CLI,обновление,самообновление"
---
# nb self update
Обновляет установленный NocoBase CLI, если текущий CLI управляется стандартной глобальной установкой npm, pnpm или yarn.
Обновляет установленный NocoBase CLI, если текущий CLI управляется стандартной глобальной установкой через npm, pnpm или yarn.
## Использование
@@ -18,25 +18,25 @@ nb self update [flags]
| Параметр | Тип | Описание |
| --- | --- | --- |
| `--channel` | string | Channel релиза для обновления, по умолчанию `auto`; возможные значения: `auto`, `latest`, `test`, `beta`, `alpha` |
| `--channel` | string | Канал релиза для обновления, по умолчанию `auto`; возможные значения: `auto`, `latest`, `test`, `beta`, `alpha` |
| `--yes`, `-y` | boolean | Пропустить подтверждение обновления |
| `--json` | boolean | Вывести в формате JSON |
| `--skills` | boolean | Также обновить глобально установленные NocoBase AI coding skills |
| `--skills` | boolean | Также обновить глобально установленные навыки ИИ-разработки NocoBase |
| `--verbose` | boolean | Показать подробный вывод процесса обновления |
## Поведение обновления
`nb self update` сначала определяет текущий метод установки во время выполнения. Исторический cache `self-install-methods.json` не используется.
`nb self update` сначала определяет текущий способ установки при выполнении команды. Исторический кэш `self-install-methods.json` не используется.
Когда доступно обновление, команда использует тот же package manager, который управляет текущей глобальной установкой CLI:
Когда доступно обновление, команда использует тот же менеджер пакетов, который управляет текущей глобальной установкой CLI:
| Метод установки | Команда обновления |
| Способ установки | Команда обновления |
| --- | --- |
| `npm-global` | `npm install -g @nocobase/cli@<channel>` |
| `pnpm-global` | `pnpm add -g @nocobase/cli@<channel>` |
| `yarn-global` | `yarn global add @nocobase/cli@<channel>` |
Интерактивное подтверждение по умолчанию выбирает yes. Используйте `--yes`, чтобы пропустить prompt в scripts.
В интерактивном режиме по умолчанию предлагается подтверждение. Используйте `--yes`, чтобы пропустить запрос подтверждения в сценариях.
## Примеры
docs/docs/ru/api/cli/session/id.md
+7 -5
View File
@@ -1,24 +1,26 @@
---
title: "nb session id"
description: "Справочник по команде nb session id: показать текущий фактически используемый `NB_SESSION_ID`."
keywords: "nb session id,NocoBase CLI,NB_SESSION_ID,id сессии"
description: "Справочник по команде nb session id: вывод текущего действующего `NB_SESSION_ID`."
keywords: "nb session id,NocoBase CLI,NB_SESSION_ID,идентификатор сессии"
---
# nb session id
Показывает текущий фактически используемый id сессии.
Если в текущей shell или runtime нет пригодного `NB_SESSION_ID`, команда предложит сначала выполнить [`nb session setup`](./setup.md), а затем открыть новую shell или runtime.
Если в текущей оболочке или среде выполнения нет пригодного `NB_SESSION_ID`, команда предложит сначала выполнить [`nb session setup`](./setup.md), а затем открыть новую сессию оболочки или новую среду выполнения.
## Использование
```bash
nb session id
```
## Примеры
```bash
nb session id
```
## Связанные команды
docs/docs/ru/api/cli/session/index.md
+11 -10
View File
@@ -1,27 +1,28 @@
---
title: "nb session"
description: "Справочник по команде nb session: настройка и проверка `NB_SESSION_ID` для изоляции текущего env по shell или runtime агента."
keywords: "nb session,NocoBase CLI,NB_SESSION_ID,session mode"
description: "Справочник по команде nb session: настройка и проверка `NB_SESSION_ID` для изоляции текущего окружения по оболочке или среде выполнения агента."
keywords: "nb session,NocoBase CLI,NB_SESSION_ID,режим сессии"
---
# nb session
Управляет session mode для `NB_SESSION_ID`.
Управление режимом сессии для `NB_SESSION_ID`.
После включения session mode команды `nb env use` и `nb env current` сначала используют контекст текущей shell или runtime агента, вместо того чтобы напрямую делить один глобальный current env.
После включения режима сессии команды `nb env use` и `nb env current` сначала используют контекст текущей оболочки или среды выполнения агента, вместо того чтобы напрямую делить одно глобальное текущее окружение.
## Использование
```bash
nb session <command>
```
## Подкоманды
| Команда | Описание |
| --- | --- |
| [`nb session setup`](./setup.md) | Устанавливает интеграцию shell или runtime для `NB_SESSION_ID` |
| [`nb session id`](./id.md) | Показывает текущий фактически используемый id сессии |
| [`nb session remove`](./remove.md) | Удаляет интеграцию shell или runtime для `NB_SESSION_ID` |
| [`nb session setup`](./setup.md) | Установить интеграцию оболочки или среды выполнения для `NB_SESSION_ID` |
| [`nb session id`](./id.md) | Показать текущий действующий идентификатор сессии |
| [`nb session remove`](./remove.md) | Удалить интеграцию оболочки или среды выполнения для `NB_SESSION_ID` |
## Когда это нужно
@@ -29,9 +30,9 @@ nb session <command>
- терминал 1 может использовать `env1`
- терминал 2 может одновременно использовать `env2`
- runtime агента тоже может хранить свой current env
- среда выполнения агента тоже может хранить своё текущее окружение
Без session mode разные сессии в итоге используют один и тот же глобальный `last env` как fallback, поэтому параллельная работа чаще влияет друг на друга.
Без режима сессии разные сессии в итоге используют один и тот же глобальный `last env` как запасной вариант, поэтому параллельная работа чаще влияет друг на друга.
## Связанные команды
docs/docs/ru/api/cli/session/remove.md
+9 -7
View File
@@ -1,31 +1,33 @@
---
title: "nb session remove"
description: "Справочник по команде nb session remove: удалить интеграцию shell или runtime для `NB_SESSION_ID`."
keywords: "nb session remove,NocoBase CLI,NB_SESSION_ID,удалить session-интеграцию"
description: "Справочник по команде nb session remove: удаление интеграции оболочки или среды выполнения для `NB_SESSION_ID`."
keywords: "nb session remove,NocoBase CLI,NB_SESSION_ID,удаление интеграции сессии"
---
# nb session remove
Удаляет session-интеграцию для `NB_SESSION_ID`.
Удаляет интеграцию сессии для `NB_SESSION_ID`.
Эта команда очищает конфигурацию shell, ранее записанную [`nb session setup`](./setup.md). Если обнаружена plugin-интеграция opencode, она тоже будет удалена.
Эта команда очищает конфигурацию оболочки, ранее записанную [`nb session setup`](./setup.md). Если обнаружена интеграция плагина opencode, она тоже будет удалена.
## Использование
```bash
nb session remove [flags]
```
## Параметры
| Параметр | Тип | Описание |
| --- | --- | --- |
| --shell | string | Target shell. Supported values: `bash`, `zsh`, `fish`, `powershell`, `cmd` |
| `--shell` | string | Целевая оболочка. Поддерживаемые значения: `bash`, `zsh`, `fish`, `powershell`, `cmd` |
## Примеры
```bash
nb session remove
nb session remove --shell zsh
```
## Связанные команды
docs/docs/ru/api/cli/session/setup.md
+12 -10
View File
@@ -1,42 +1,44 @@
---
title: "nb session setup"
description: "Справочник по команде nb session setup: установить интеграцию shell или runtime для `NB_SESSION_ID`."
keywords: "nb session setup,NocoBase CLI,NB_SESSION_ID,интеграция shell"
description: "Справочник по команде nb session setup: установка интеграции оболочки или среды выполнения для `NB_SESSION_ID`."
keywords: "nb session setup,NocoBase CLI,NB_SESSION_ID,интеграция оболочки"
---
# nb session setup
Устанавливает session-интеграцию для `NB_SESSION_ID`.
Устанавливает интеграцию сессии для `NB_SESSION_ID`.
Эта команда определяет текущую shell или использует shell, переданную через `--shell`, и записывает соответствующий файл инициализации, чтобы новые shell-сессии автоматически получали `NB_SESSION_ID`.
Эта команда определяет текущую оболочку или использует оболочку, переданную через `--shell`, и записывает соответствующий файл инициализации, чтобы новые сессии оболочки автоматически получали `NB_SESSION_ID`.
Если на машине обнаружена конфигурация opencode, команда также записывает соответствующую plugin-интеграцию, чтобы runtime агента мог внедрять собственный `NB_SESSION_ID`.
Если на машине обнаружена конфигурация opencode, команда также записывает соответствующую интеграцию плагина, чтобы среда выполнения агента могла внедрять собственный `NB_SESSION_ID`.
## Использование
```bash
nb session setup [flags]
```
## Параметры
| Параметр | Тип | Описание |
| --- | --- | --- |
| --shell | string | Target shell. Supported values: `bash`, `zsh`, `fish`, `powershell`, `cmd` |
| `--shell` | string | Целевая оболочка. Поддерживаемые значения: `bash`, `zsh`, `fish`, `powershell`, `cmd` |
## Примечания
В большинстве случаев эту команду нужно выполнить только один раз.
После этого откройте новую shell-сессию или перезагрузите profile, чтобы `NB_SESSION_ID` инициализировался автоматически.
После этого откройте новую сессию оболочки или перезагрузите профиль, чтобы `NB_SESSION_ID` инициализировался автоматически.
В runtime агента, таких как Codex, если уже есть переменная контекста вроде `CODEX_THREAD_ID`, CLI сначала использует именно её значение.
В средах выполнения агентов, таких как Codex, если уже есть переменная контекста вроде `CODEX_THREAD_ID`, CLI сначала использует именно её значение.
## Примеры
```bash
nb session setup
nb session setup --shell zsh
nb session setup --shell powershell
```
## Связанные команды
docs/docs/ru/api/cli/skills/check.md
+3 -3
View File
@@ -1,12 +1,12 @@
---
title: "nb skills check"
description: "Справочник по команде nb skills check: проверка глобальных AI coding Skills NocoBase."
keywords: "nb skills check,NocoBase CLI,проверка Skills"
description: "Справочник по команде nb skills check: проверка глобальных навыков ИИ-разработки NocoBase."
keywords: "nb skills check,NocoBase CLI,проверка навыков"
---
# nb skills check
Проверяет глобальные AI coding Skills NocoBase и сообщает, управляются ли они CLI и доступны ли обновления.
Проверяет глобальные навыки ИИ-разработки NocoBase и сообщает, управляет ли ими CLI и доступны ли обновления.
## Использование

Some files were not shown because too many files have changed in this diff Show More