• Português

      • nb portal

      nb portal gerencia workspaces de Portal. Um Portal pode ter seu próprio código-fonte frontend, caminho de entrada e saída de deploy; este grupo conecta o registro do Portal no NocoBase ao workspace local e ao source storage.

      O fluxo típico é criar um workspace local, iniciar o modo de desenvolvimento, enviar alterações de source para o source storage e depois buildar e fazer deploy. Se você vai assumir um Portal existente, primeiro faça pull para o ambiente local.

      Uso

      nb portal <command>

      Subcomandos

      ComandoDescrição
      nb portal configAtualiza a configuração de source do workspace Portal local e sincroniza com o registro remoto quando possível
      nb portal createCria um workspace Portal local a partir de um template e cria ou atualiza o registro do Portal
      nb portal deployCompila e faz deploy do workspace Portal especificado
      nb portal destroyExclui o registro do Portal e o workspace local
      nb portal devInicia o modo de desenvolvimento para o workspace Portal especificado
      nb portal infoMostra detalhes do registro Portal especificado e do workspace local
      nb portal listLista registros Portal e o status de sincronização do workspace local
      nb portal pullBaixa o source do Portal do source storage para o workspace local
      nb portal pushEnvia alterações locais do source do Portal para o source storage

      Fluxo típico

      Criar um Portal chamado customer:

      nb portal create customer -e dev --yes

      Iniciar o modo de desenvolvimento local:

      nb portal dev customer -e dev --yes

      Inspecionar o workspace local e o registro remoto:

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

      Enviar o source e fazer deploy:

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

      Assumir um Portal existente:

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

      Trocar o 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

      Ao criar um Portal, escolha onde o código-fonte será gerenciado:

      ModoDescrição
      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:

      ModoDescrição
      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:

      ParâmetroDescrição
      --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.

      Comandos relacionados