---
title: 'NocoBase CLI'
description: 'Справочник по NocoBase CLI (команда nb): инициализация, резервное копирование и восстановление, конфигурация, управление окружением, запуск приложения, исходный код, база данных, плагины, коммерческая лицензия, API, самообновление CLI и управление Skills.'
keywords: 'NocoBase CLI,nb,командная строка,справочник команд,резервное копирование,восстановление,управление окружением,управление плагинами,коммерческая лицензия,API'
---

# NocoBase CLI

## Описание

NocoBase CLI (`nb`) — это точка входа командной строки NocoBase, используемая для инициализации, подключения и управления приложениями NocoBase в локальном рабочем пространстве.

Он поддерживает два распространённых пути инициализации:

- Подключить существующее приложение NocoBase и сохранить его как CLI env
- Установить новое приложение NocoBase через Docker, npm или Git, а затем сохранить его как CLI env

При создании нового локального приложения [`nb init`](./init.md) также может устанавливать или обновлять AI coding skills NocoBase. Если нужно пропустить этот шаг, можно использовать `--skip-skills`.

## Использование

```bash
nb [command]
```

Корневая команда в основном используется для отображения справки и перенаправления вызовов в группы команд или отдельные команды.

## Группы команд (Topics)

В `nb --help` отображаются следующие группы команд:

| Группа команд                        | Описание                                                                                                            |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- |
| [`nb api`](./api/index.md)           | Вызывать API NocoBase через CLI.                                                                                    |
| [`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 license`](./license/index.md)   | Управлять коммерческой лицензией и лицензируемыми плагинами.                                                        |
| [`nb plugin`](./plugin/index.md)     | Управлять плагинами выбранного окружения NocoBase.                                                                  |
| [`nb scaffold`](./scaffold/index.md) | Генерировать scaffold для разработки плагинов 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)     | Управлять локальным проектом исходного кода: загрузка, разработка, сборка и тестирование.                           |

## Команды (Commands)

Отдельные команды, которые сейчас напрямую предоставляет корневая команда:

| Команда                | Описание                                                                   |
| ---------------------- | -------------------------------------------------------------------------- |
| [`nb init`](./init.md) | Инициализировать NocoBase, чтобы coding agent мог подключаться и работать. |

## Просмотр справки

Просмотреть справку по корневой команде:

```bash
nb --help
```

Просмотреть справку по команде или группе команд:

```bash
nb init --help
nb app --help
nb backup --help
nb config --help
nb api resource --help
nb license --help
```

## Примеры

Интерактивная инициализация:

```bash
nb init
```

Инициализация с использованием формы в браузере:

```bash
nb init --ui
```

Создание Docker-приложения в неинтерактивном режиме:

```bash
nb init --env app1 --yes --source docker --version alpha
```

Подключение существующего приложения:

```bash
nb env add app1 --api-base-url http://localhost:13000/api
nb env current
nb env status
```

Повторная синхронизация состояния env после запуска приложения:

```bash
nb app start -e app1
nb env update app1
```

Вызов API:

```bash
nb api resource list --resource users -e app1
```

Просмотр конфигурации CLI по умолчанию:

```bash
nb config list
nb config get docker.network
```

Просмотр состояния коммерческой лицензии:

```bash
nb license status -e app1
nb license plugins list -e app1
```

Создание и загрузка резервной копии:

```bash
nb backup create -e app1 --output ./backups
```

Восстановление локальной резервной копии:

```bash
nb backup restore -e app1 --file ./backups/backup_20260520_190408_8397.nbdata --yes --force
```

## Переменные окружения

Следующие переменные окружения влияют на поведение CLI:

| Переменная      | Описание                                                                                                                                               |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `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` изолируются по сессии.                          |

Пример:

```bash
export NB_CLI_ROOT=/your/workspace
export NB_LOCALE=zh-CN
```

## Файл конфигурации

Файл конфигурации по умолчанию:

```text
~/.nocobase/config.json
```

После установки `NB_CLI_ROOT=/your/workspace` путь к файлу конфигурации станет:

```text
/your/workspace/.nocobase/config.json
```

CLI также совместим с чтением старой конфигурации проекта из текущего рабочего каталога.

Кэш уровня сессии для текущего env хранится в:

```text
.nocobase/sessions/<NB_SESSION_ID>.json
```

Последний глобально использованный env хранится в поле `lastEnv` файла `config.json`. При отсутствии `NB_SESSION_ID` CLI возвращается к этому глобальному значению.

Кэш runtime-команд хранится в:

```text
.nocobase/versions/<hash>/commands.json
```

Этот файл создаётся или обновляется командой [`nb env update`](./env/update.md) и используется для кэширования runtime-команд, синхронизированных с целевого приложения.

## Связанные ссылки

- [Быстрый старт](../../ai/quick-start.mdx)
- [Глобальные переменные окружения](../app/env.md)
- [AI-конструктор](../../ai-builder/index.md)
- [Разработка плагинов](../../plugin-development/index.md)
