• Deutsch

      • nb portal

      nb portal verwaltet Portal-Workspaces. Ein Portal kann eigenen Frontend-Quellcode, einen eigenen Einstiegspfad und eigene Deployment-Ausgaben haben; diese Befehlsgruppe verbindet den Portal-Datensatz in NocoBase mit lokalem Workspace und source storage.

      Ein typischer Ablauf: lokalen Workspace erstellen, Entwicklungsmodus starten, Quellcode in source storage pushen und anschließend builden und deployen. Wenn du ein bestehendes Portal übernimmst, ziehe es zuerst lokal mit pull.

      Verwendung

      nb portal <command>

      Unterbefehle

      BefehlBeschreibung
      nb portal configUpdate portal source configuration
      nb portal createErstellt einen lokalen Portal-Workspace aus einem Template und erstellt oder aktualisiert den Portal-Datensatz
      nb portal deployBuildet und deployt den angegebenen Portal-Workspace
      nb portal destroyLöscht den Portal-Datensatz und den lokalen Workspace
      nb portal devStartet den Entwicklungsmodus für den angegebenen Portal-Workspace
      nb portal infoZeigt Details zum angegebenen Portal-Datensatz und lokalen Workspace
      nb portal listList portal records and development paths
      nb portal pullZieht Portal-Quellcode aus dem source storage in den lokalen Workspace
      nb portal pushPusht lokale Portal-Quellcodeänderungen in den source storage

      Typischer Ablauf

      Ein Portal namens customer erstellen:

      nb portal create customer -e dev --yes

      Den lokalen Entwicklungsmodus starten:

      nb portal dev customer -e dev --yes

      Lokalen Workspace und Remote-Datensatz prüfen:

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

      Quellcode pushen und deployen:

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

      Ein bestehendes Portal übernehmen:

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

      Source storage wechseln:

      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

      Beim Erstellen eines Portals wählen Sie, wo der Quellcode verwaltet wird:

      ModusBeschreibung
      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.

      nb portal config updates source storage and Git settings in the remote portal record. The development workspace path is stored separately in the CLI env config as portals.<portal>.path, maintained by create, pull --path, or config --path.

      Env Types

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

      ModusBeschreibung
      localThe workspace and app storage are on the current machine. pull writes source to the development path, and deploy builds from that path before syncing deployment output.
      dockerThe workspace is shared with the app through a Docker volume. pull writes source to the development path, and deploy builds from that path before syncing deployment output.
      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.

      Development And Deployment Paths

      Portal development workspaces are created under the current working directory by default:

      ./<portal>

      Use --path with create, pull, or config to choose a different development path. Deployment output is still stored under the target app 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:

      ParameterBeschreibung
      --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.

      Verwandte Befehle