• English

      • nb portal create

      Create a local portal from a template and create or update the portal record

      Usage

      nb portal create <portal> [flags]

      Flag

      FlagTypeDescription
      <portal>stringPortal name or slug.
      --templatestringTemplate package, local path, or file:// URL. Default: @nocobase/portal-template-default.
      --env, -estringCLI env name. If omitted, the current env is used.
      --yes, -ybooleanSkip cross-env confirmation.
      --titlestringPortal display title.
      --pathstringPortal workspace directory. Default: ./<portal>.
      --forcebooleanDelete the existing workspace and recreate it.

      Examples

      nb portal create customer
nb portal create customer --path ./portals/customer
nb portal create customer --template @nocobase/portal-template-default
nb portal create customer --env dev --yes

      Notes

      The command writes .env and .env.local, stores the workspace path in the selected CLI env config, and runs pnpm install when the template contains package.json. Portal names must use lowercase letters, numbers, underscores, or hyphens, and start with a lowercase letter or number.