• Русский

      • nb portal

      nb portal управляет рабочими пространствами Portal. Portal может иметь собственный frontend-код, путь входа и результат развёртывания; эта группа команд связывает запись Portal в NocoBase с локальным рабочим пространством и source storage.

      Типовой процесс: создать локальное рабочее пространство, запустить режим разработки, отправить изменения исходного кода в source storage, затем выполнить build и deploy. Если вы берёте существующий Portal, сначала выполните pull.

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

      nb portal <command>

      Подкоманды

      КомандаОписание
      nb portal configОбновляет конфигурацию исходного кода локального рабочего пространства Portal и по возможности синхронизирует её с удалённой записью Portal
      nb portal createСоздаёт локальное рабочее пространство Portal из шаблона и создаёт или обновляет запись Portal
      nb portal deployСобирает и развёртывает указанное рабочее пространство Portal
      nb portal destroyУдаляет запись Portal и локальное рабочее пространство
      nb portal devЗапускает режим разработки для указанного рабочего пространства Portal
      nb portal infoПоказывает сведения об указанной записи Portal и локальном рабочем пространстве
      nb portal listВыводит записи Portal и состояние синхронизации локальных рабочих пространств
      nb portal pullЗагружает исходный код Portal из source storage в локальное рабочее пространство
      nb portal pushОтправляет локальные изменения исходного кодa Portal в source storage

      Типовой процесс

      Создать Portal с именем customer:

      nb portal create customer -e dev --yes

      Запустить локальный режим разработки:

      nb portal dev customer -e dev --yes

      Проверить локальное рабочее пространство и удалённую запись:

      nb portal info customer -e dev --yes
nb portal list -e dev --yes

      Отправить исходный код и развернуть:

      nb portal push customer -e dev --yes --message "Update customer portal"
nb portal deploy customer -e dev --yes

      Взять существующий Portal в работу:

      nb portal list -e dev --yes
nb portal pull customer -e dev --yes
nb portal dev customer -e dev --yes

      Переключить source storage:

      nb portal config customer -e dev --yes --source-storage git --git-repo git@github.com:nocobase/customer-portal.git
nb portal push customer -e dev --yes --message "Move customer portal source to Git"

      source storage

      При создании Portal выберите, где будет управляться исходный код:

      РежимОписание
      nocobaseDefault mode. Source code is managed by NocoBase source storage.
      gitSource code is stored in a Git repository, configured with --git-repo, --git-branch, and --git-path.

      For quick creation and development, the default nocobase storage is usually enough. Use git when the Portal source should be reviewed, versioned, or built through an existing team workflow.

      Source configuration is written to portal.config.json in the local workspace. create, pull, and config maintain this file; push and deploy read it to sync source or deployment output.

      Env Types

      nb portal currently supports local, docker, and http envs:

      РежимОписание
      localThe workspace and app storage are on the current machine. With default nocobase storage, pull/push usually do not need extra sync.
      dockerThe workspace is shared with the app through a Docker volume. With default nocobase storage, pull/push usually do not need extra sync.
      httpSource and deployment output are synced through APIs. pull downloads a source archive, and push uploads one.

      ssh envs do not support Portal management in the current version.

      Local Workspace Path

      Portals are stored under the selected env storage:

      <storagePath>/portals/<app>/<portal>

      The main app access path is usually:

      <appPublicPath>/x/<portal>/

      A sub-app access path is usually:

      <appPublicPath>/x/apps/<app>/<portal>/

      Env Confirmation

      Most nb portal subcommands support --env and --yes:

      ПараметрОписание
      --env, -eCLI env name. If omitted, the current env is used.
      --yes, -ySkip cross-env confirmation when an explicit --env targets a different env from the current env.

      In scripts or AI agent workflows, pass --env and --yes explicitly to avoid stopping at an interactive confirmation.

      Связанные команды