@nocobase/plugin-ai 2.2.0-beta.9 → 3.0.0-alpha.1

package/client-v2.d.ts

@@ -1 +1,2 @@
 export * from './dist/client-v2';
+export { default } from './dist/client-v2';

package/dist/ai/docs/nocobase/ai-employees/block/ai-chat-box.md

@@ -0,0 +1,133 @@
+---
+pkg: '@nocobase/plugin-ai'
+title: 'AI Chat box block'
+description: 'User guide for NocoBase administrators and page builders covering how to add an AI Chat box block, configure conversation capabilities, set Work context, manage conversations, and add Actions.'
+keywords: 'AI Chat box,AI Employee,page block,Work context,Scope,Actions,NocoBase'
+---
+
+# AI Chat box block
+
+In NocoBase, **AI Chat box** is an AI conversation block that can be added directly to a page. You can place it on a business page to provide a fixed AI assistant entry point for that page.
+
+Each AI Chat box block has its own current conversation and input state. Page builders can also restrict the available AI employees, models, file uploads, web search, and work context to suit the current business scenario.
+
+:::tip Before you start
+
+First [configure an LLM service](../features/llm-service.md) and [enable at least one AI employee](../features/enable-ai-employee.md).
+
+:::
+
+## Add an AI Chat box block
+
+1. Open the page you want to configure.
+2. Click `UI Editor` in the upper-right corner to enter page editing mode.
+3. Click `Add block`.
+4. Under `Other blocks`, select `AI chat box`.
+
+![Select AI chat box from the Add block menu](https://static-docs.nocobase.com/ai-employees/block/ai-chat-box/2026-07-22/add-ai-chat-box-block-3.png)
+
+## Understand the block structure
+
+![AI Chat box block](https://static-docs.nocobase.com/ai-employees/block/ai-chat-box/2026-07-22/ai-chat-box-overview-2.png)
+
+An AI Chat box contains three areas from top to bottom:
+
+- **Top action area** — conversation list, Actions, custom actions, and new conversation buttons; a messages button also appears when the messages area is hidden
+- **Messages area** — displays messages in the current draft or conversation
+- **Sender area** — input box, context selection, file upload, web search, AI employee selection, model selection, send button, and disclaimer
+
+### Add display content inside the block body
+
+In page editing mode, click `Add block` inside the AI Chat box to add any of the following blocks above the chat area:
+
+- JS block
+- Iframe
+- Markdown
+
+These blocks are useful for displaying instructions, external pages, or supporting information. The internal Add block menu only provides these three block types and does not allow another AI Chat box to be nested inside it.
+
+## Configure the AI Chat box
+
+Move the pointer over the block and open its settings menu. Click `Edit chat box` to configure the conversation scope, default message, Work context, AI employees, and models.
+
+![Edit chat box settings dialog](https://static-docs.nocobase.com/ai-employees/block/ai-chat-box/2026-07-22/edit-chat-box-settings-2.png)
+
+### Edit chat box settings
+
+| Setting | Description |
+| --- | --- |
+| `Scope` | Controls which AI Chat boxes share a conversation list. A new block uses its own block UID by default to keep conversations separate. |
+| `Background` | Adds a system prompt after the AI employee definition to provide the role, objective, or response requirements for the current page. |
+| `Default user message` | Prefills a default user message in the sender when a new conversation starts. |
+| `Work context` | Selects page blocks to place in a new draft by default. |
+| `AI employees` | Restricts the business AI employees that can be selected in this block. Leave it empty to allow all available business AI employees. |
+| `Models` | Restricts the models that can be selected in this block. Leave it empty to allow all available models. |
+
+### Other block settings
+
+| Setting | Description |
+| --- | --- |
+| `Show messages` | Controls whether the messages area is displayed directly in the block. When disabled, use the messages button at the top to open the right-side panel. |
+| `Sender placeholder` | Changes the placeholder shown in the sender. |
+| `Enable add context` | Shows or hides the context selection entry in the sender. |
+| `Enable upload files` | Shows or hides the file upload entry. When disabled, pasting a file does not start an upload. |
+| `Enable web search` | Shows or hides the web search switch. Disabling it also turns off web search for the current draft. |
+| `Enable employee select` | Shows or hides the AI employee selector. |
+| `Enable model select` | Shows or hides the model selector. |
+| `Show disclaimer` | Shows or hides the AI disclaimer below the sender. |
+
+## Configure Work context
+
+In `Work context` under `Edit chat box`, click the add context button, select `Pick block`, and then select the page block you want to provide to the AI. After saving, the selected block becomes the default work context for new conversations and can be removed from the sender before sending.
+
+## Hide the messages area and use the right-side panel
+
+After disabling `Show messages`, the block body only keeps the sender area. A messages button appears at the top; click it to open the messages panel from the right.
+
+![Right-side messages panel with the messages area hidden](https://static-docs.nocobase.com/ai-employees/block/ai-chat-box/2026-07-22/messages-side-panel-2.png)
+
+When the panel is open, the rest of the block is covered by an overlay. Click the overlay or click the messages button again to close the panel.
+
+This layout works well when the AI Chat box is used as a lightweight input entry on a page: keep only the sender visible and open the panel when you need to review messages.
+
+## Manage conversation history
+
+Click the conversation list button in the upper-left corner of the block to view conversation history under the current Scope.
+
+Keep these rules in mind:
+
+- Multiple AI Chat boxes with the same Scope can see the same conversation list
+- Each block still has its own current conversation, sender draft, AI employee, model, attachments, and context state
+- The global floating chatbox does not filter by block Scope, so it does not hide conversations with a Scope
+- After clearing Scope, the block no longer filters the conversation list by Scope and displays both conversations without a Scope and conversations using other Scopes
+
+Normally, keeping the Scope generated for a new block is enough to separate the history of each page assistant. Only configure the same Scope when multiple blocks need to share the same conversation list.
+
+## Add Actions
+
+In page editing mode, click `Actions` at the top of the block to add either of the following actions:
+
+- JS Action
+- AI employee
+
+After adding an AI employee, you can configure shortcut tasks for that employee.
+
+The `Chat box uid` setting in a shortcut task specifies which AI Chat box runs the task. An AI employee added directly inside an AI Chat box points to the current block UID by default.
+
+If the specified AI Chat box is not mounted, NocoBase reports that the target block cannot be found and does not fall back to the global floating chatbox. See [AI employee shortcut tasks](../features/task.md) for detailed configuration.
+
+## Configure a page-specific assistant
+
+The following steps create a lightweight AI assistant for a page:
+
+1. Add an AI Chat box block and move it to the appropriate position on the page.
+2. Enter a page-specific Background under `Edit chat box`.
+3. Select one or more Work contexts.
+4. Restrict the available employees and models under `AI employees` and `Models`.
+5. Exit editing mode, enter a question, and send it.
+
+## Notes
+
+- The AI Chat box block and the global floating chatbox in the lower-right corner are separate entry points; their current conversations and input states are not synchronized automatically
+- Only JS block, Iframe, and Markdown can be added from `Add block` inside an AI Chat box
+- Changing Scope affects the conversation list query and does not copy the conversation or draft currently open in another block

package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/documents.md

@@ -17,7 +17,7 @@ After opening the knowledge base detail page, click Documents in the left sideba
 
 Click Upload in the upper-right corner to upload files. After upload, documents automatically enter segment generation and vectorization. Status first shows Pending, then changes to Success after processing. If processing fails, it shows Error, and an error icon appears next to the filename.
 
-Supported document types include: `txt`, `md`, `json`, `csv`, `xls`, `xlsx`, `pdf`, `doc`, `docx`, `ppt`, and `pptx`.
+Supported document types include: `txt`, `md`, `json`, `csv`, `xls`, `xlsx`, `pdf`, `doc`, `docx`, and `pptx`.
 
 :::tip PDF documents
 

package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/index.md

@@ -13,7 +13,7 @@ A knowledge base is the foundation of RAG retrieval. You can add product manuals
 
 For most scenarios, a Local knowledge base is enough. Only consider Readonly or External knowledge bases when documents and vector data are already maintained by an external system.
 
-![](https://static-docs.nocobase.com/20260617003643.png)
+![](https://static-docs.nocobase.com/20260728222403.png)
 
 ## Open knowledge base management
 
@@ -23,15 +23,15 @@ Click a knowledge base card to open its detail page:
 
 - Documents is used to upload documents, run vectorization, and open segment management
 - Hit tests is used to test which segments can be matched by a query
-- Settings is used to adjust basic information, vector store, and default segmentation parameters
+- Settings is used to adjust basic information, vector configuration, and default segmentation parameters
 
-![](https://static-docs.nocobase.com/20260617004104.png)
+![](https://static-docs.nocobase.com/20260728222406.png)
 
 ## Create a knowledge base
 
 Click Add new in the upper-right corner to create a knowledge base. The menu shows three types: Local, Readonly, and External.
 
-![](https://static-docs.nocobase.com/20260617003505.png)
+![](https://static-docs.nocobase.com/20260728222404.png)
 
 The three knowledge base types have different capability boundaries:
 
@@ -45,19 +45,23 @@ Local knowledge bases are recommended by default. Only consider Readonly or Exte
 
 A Local knowledge base usually needs the following information:
 
-![](https://static-docs.nocobase.com/20260617003603.png)
+![](https://static-docs.nocobase.com/20260728222405.png)
 
 - Key: unique identifier of the knowledge base. It cannot be changed after creation
 - Name: knowledge base name
 - File storage: where original documents and segment files are stored
-- Vector store: vector store used to generate and retrieve vectors
+- Vector database: select a configured vector database. See [Vector database](../vector-database)
+- LLM service: select a configured LLM service that supports embedding models. See [LLM service management](../../features/llm-service)
+- Embedding model: select or enter the embedding model used to generate and retrieve vectors; available models update when the LLM service changes
 - Description: knowledge base description
 - Split document, Chunk size, and Chunk overlap: default segmentation parameters used after document upload
 - Enabled: whether the knowledge base is enabled
 
+A Readonly knowledge base does not require File storage or default segmentation parameters, but it still requires Vector database, LLM service, and Embedding model.
+
 :::tip Prerequisites
 
-Before creating a Local knowledge base, prepare two dependencies: file storage for original documents and segment files, see [File storage](../../../file-manager/storage/); and vector storage for generating and retrieving vectors, see [Vector database](../vector-database) and [Vector store](../vector-store).
+Before creating a Local knowledge base, prepare file storage, a vector database, and an LLM service that supports embedding models. File storage holds original documents and segment files; see [File storage](../../../file-manager/storage/index.md). Configure the vector database as described in [Vector database](../vector-database), and configure the LLM service as described in [LLM service management](../../features/llm-service).
 
 :::
 

package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/settings.md

@@ -1,17 +1,17 @@
 ---
 pkg: "@nocobase/plugin-ai-knowledge-base"
 title: "Settings"
-description: "Modify basic information, vector store, and default segmentation settings on the Settings page of a knowledge base, and understand the relation between knowledge-base-level and document-level segmentation settings."
-keywords: "knowledge base settings,segmentation settings,Chunk size,Chunk overlap,vector store,NocoBase"
+description: "Modify basic information, vector database, LLM service, embedding model, and default segmentation settings on the Settings page of a knowledge base."
+keywords: "knowledge base settings,vector database,LLM service,embedding model,segmentation settings,NocoBase"
 ---
 
 # Settings
 
 ## Open the Settings page
 
-After opening the knowledge base detail page, click Settings in the left sidebar. This page modifies basic information, file storage, vector store, and default segmentation settings of the current knowledge base.
+After opening the knowledge base detail page, click Settings in the left sidebar. This page modifies basic information, file storage, vector database, LLM service, embedding model, and default segmentation settings of the current knowledge base.
 
-![](https://static-docs.nocobase.com/20260617005832.png)
+![](https://static-docs.nocobase.com/20260728222407.png)
 
 ## Basic information
 
@@ -22,17 +22,21 @@ Local knowledge base settings include:
 | Key | Unique identifier of the knowledge base. It cannot be changed after creation |
 | Name | Knowledge base name |
 | File storage | Where documents and segment files are stored. It cannot be changed after creation |
-| Vector store | Vector store used by the current knowledge base |
+| Vector database | Vector database used by the current knowledge base |
+| LLM service | LLM service used to generate embeddings |
+| Embedding model | Embedding model used to generate and retrieve vectors |
 | Description | Knowledge base description |
 | Enabled | Whether the current knowledge base is enabled |
 
-:::tip Vector store changes
+:::tip Vector configuration changes
 
-After you modify Vector store, NocoBase asks for confirmation when saving. After the vector store changes, existing documents must be vectorized again before vector data can be written to the new vector store. Choose Save and vectorize to save the settings and vectorize immediately, or choose Save only to save the settings and later run Vectorization manually on the Documents page.
+After you modify Vector database, LLM service, or Embedding model, NocoBase asks for confirmation when saving. After the vector configuration changes, existing documents must be vectorized again. Choose Save and vectorize to save the settings and vectorize immediately, or choose Save only to save the settings and later run Vectorization manually on the Documents page.
+
+If the vector database connection settings change, the Documents page also prompts you to run vectorization again.
 
 :::
 
-![](https://static-docs.nocobase.com/20260617005951.png)
+![](https://static-docs.nocobase.com/20260728222408.png)
 
 ## Default segmentation parameters
 

package/dist/ai/docs/nocobase/ai-employees/knowledge-base/vector-database.md

@@ -10,10 +10,10 @@ Currently, the AI Knowledge Base plugin only has built-in support for PGVector,
 
 ## Vector Database Management
 
-Go to the AI Agent plugin configuration page, click the `Vector store` tab, and select `Vector database` to enter the vector database management page.
+Go to the AI employees plugin configuration page and click the top-level `Vector database` tab to open the vector database management page.
 
 
-![20251022233704](https://static-docs.nocobase.com/20251022233704.png)
+![20260728222401](https://static-docs.nocobase.com/20260728222401.png)
 
 
 Click the `Add new` button in the upper right corner to add a new `PGVector` vector database connection:
@@ -29,4 +29,4 @@ Click the `Add new` button in the upper right corner to add a new `PGVector` vec
 After entering all the necessary information, click the `Test` button to test if the vector database service is available, and click the `Submit` button to save the connection information.
 
 
-![20251022234644](https://static-docs.nocobase.com/20251022234644.png)
+![20260728222402](https://static-docs.nocobase.com/20260728222402.png)

package/dist/ai/docs/nocobase/ai-employees/scenarios/company-background-research.md

@@ -0,0 +1,125 @@
+---
+title: "Workflow + AI for employees to complete company background research automation"
+description: "Through company information forms, background investigation records, workflows, and AI employees, a company background investigation process can be automatically triggered, retained, and supported for manual review."
+keywords: "NocoBase, AI employees, workflow, company background research, due diligence, automation, business practice"
+---
+
+# Workflow + AI for employees to complete company background research automation
+
+In NocoBase, you can turn company background research into a trackable automated task flow. Business staff still work in the familiar company information page, while workflow and AI staff are responsible for completing background information, recording the processing process, and saving each generated report.
+
+![](https://static-docs.nocobase.com/202607121806356.png)
+
+This scenario is suitable for dealing with a common problem: company background information is not a static field that ends after being entered once. Public information will change, regulatory events will occur, and the status of cooperation will be constantly adjusted as business progresses. If you only rely on manual supplementary recording on a regular basis, it will be easy to miss; if you directly let AI cover company information, it will be difficult to explain "how this judgment came about." The approach here is to separate and save the current data and the research process - the company record saves the version being used by the business personnel, and the background check record saves the status, output and history of each AI survey.
+
+## Let’s look at the two tables first
+
+The company information form provides the basic information of the research object, and the background investigation record form is responsible for undertaking each research task. One saves the currently available information, and the other saves the processing process and historical results.
+
+### `companies`: Company information table
+
+| Core fields               | effect                                                           |
+| ---------------------- | -------------------------------------------------------------- |
+| Company name           | The main identifying information of the research object.                                   |
+| Website                | Provide official website clues to reduce misjudgments caused by companies with the same name or abbreviation.                   |
+| Address                | Assist in determining regions, entities and business scope.                                 |
+| Company type           | Mark business relationships such as customers, suppliers, partners, etc. to facilitate subsequent judgment and follow-up priorities. |
+| Background information | Save the company background report you are currently using and use Markdown to render structured content. |
+
+### `background_check_tasks`: Background check record form
+
+| Core fields                  | effect                                                                               |
+| ------------------------- | ---------------------------------------------------------------------------------- |
+| Company ID / Company name | Record which company this survey is for to facilitate task execution and historical review.                                 |
+| Status                    | The flow of marking tasks from `pending` to `processing` and `completed` is also the basis for preventing repeated triggering. |
+| Research report           | Save the complete research report generated by AI this time.                                                   |
+| Summary                   | Save AI's summary of the research process, risk points, and information to be supplemented.                                     |
+| Previous background       | Save the old version before writing back, supporting historical tracking and comparison of old and new reports.                                   |
+
+![](https://static-docs.nocobase.com/202607121807627.png)
+
+## Enter the research process from company information
+
+The company list is the most familiar entrance for business people. You can see the company name, official website, company type, contact person, email and other information on the page. After entering a company, business personnel can view the current background report or initiate a new background investigation.
+
+After entering the editing page, "Background information" is displayed using the Markdown editing component. The AI-generated content is not a short summary, but a structured report that can be read, copied, and continued to be maintained. Business personnel can still modify it manually, but each result generated by AI will leave a corresponding history in the background check record.
+
+![](https://static-docs.nocobase.com/202607121807450.png)
+
+In this way, the page still looks like an ordinary company data maintenance interface, and the underlying processing method has become "current data + research history". The company table saves the current version, and the task table saves the process and evidence chain.
+
+## Three triggering methods
+
+![](https://static-docs.nocobase.com/202607121807495.png)
+
+Background research shouldn’t just rely on a manual button. In real business, you may want to automatically complete the information after adding a new company, you may also need to make up historical records regularly, and you may also take the initiative to re-investigate before signing a contract or reviewing.
+
+The `New company background check` workflow handles automatic research after adding or updating a company. It listens to the data events of the company table and is triggered when the company name exists and the background information is empty. The AI ​​will not be called immediately after triggering, but will first check whether there are any unfinished tasks for the same company; if not, a new background check record will be created.
+
+![](https://static-docs.nocobase.com/202607121807374.png)
+
+The `Timing company background check` workflow is responsible for the continuous completion of historical data. It runs every 30 minutes, queries companies whose background information is still empty, and loops through batches. Inside the loop, we also check whether the task already exists, and then decide whether to create a new task. In this way, the scheduled task can be run repeatedly without creating multiple concurrently processed records due to repeated scanning.
+
+![](https://static-docs.nocobase.com/202607121807404.png)
+
+The `Manual company background check` workflow is bound to the "Run background check" button on the company details page, which is suitable for business personnel to proactively initiate a survey before visiting, signing a contract, or reviewing. Manual triggering and automatic triggering use the same set of follow-up links: a background check record is created first, and then the task execution workflow takes over the AI ​​investigation.
+
+![](https://static-docs.nocobase.com/202607121807793.png)
+
+These three entrances solve problems at different points in time, and are ultimately merged into the same background investigation record form. New triggers, scheduled triggers, and manual triggers are only responsible for recording the "need to investigate", and the specific execution, status management, and result writing back are handed over to subsequent workflows for unified processing.
+
+## Turn AI research into tasks
+
+`Do company background check` is the workflow that actually performs research. It listens for the `pending` record in the background check record table. Once the previous automatic, scheduled or manual process creates a task, this workflow will be triggered asynchronously.
+
+When executed, the workflow first queries whether the company still exists. If the company does not exist, the task will be closed and the description will be written; if the company exists, the task status will be switched to `processing`, and then the AI ​​employee will be called to generate the report. The prompt word of the AI ​​employee requires the output of two parts: a Markdown report that can be written directly into the company background field, and a summary for manual review.
+
+![](https://static-docs.nocobase.com/202607121808833.png)
+
+After AI returns structured results, the workflow first writes the report, summary, and old background content into the background check record, and then writes the new report back to the company record. This order avoids the problem of "only the latest results, no process records": the company page keeps the latest available content, and the task records retain the context before this generation and writing back.
+
+![](https://static-docs.nocobase.com/202607121808662.png)
+
+After tasking, batch processing will also become more natural. The scheduled workflow does not need to wait for each company's research to be completed, but is only responsible for creating multiple records to be processed; each record independently triggers the AI ​​survey. Multiple companies can advance in parallel, and if a certain task fails or times out, other companies will not be blocked.
+
+## Make AI results reviewable
+
+AI-generated reports are organized according to a fixed structure: company profile, core business, development history and capital background, market position and competitive perspective, sales follow-up judgment, and citation links. Business personnel can see not only the "conclusion", but also the risk tips and additional information given by AI in the summary.
+
+The background investigation record details page displays "Research report" and "Previous background" in tabs, and provides a "Copy" operation. In this way, you can quickly copy this report during discussion, review, or external communication, and you can also check changes against the old version.
+
+The record details also configure two AI worker tasks. in:
+
+- Improve the background research report: regenerate the report after adding information through dialogue, and write the results back to the company records
+- Compare the old and new background research reports: Read the old and new reports and let AI explain the substantial differences brought about by this update
+
+This allows AI not to stop at “generating text once” but to participate in the process of continuous maintenance, review and version comparison.
+
+![](https://static-docs.nocobase.com/202607121808444.png)
+
+## How to combine workflow
+
+Overall, this set of workflows can be divided into four layers.
+
+The first layer is responsible for creating tasks. `New company background check` is for newly added or updated companies, `Timing company background check` is for historical data completion, and `Manual company background check` is for manual initiative. They will all check whether there are any unfinished records before creating a task, reducing duplicate processing from the source.
+
+The second layer is responsible for performing tasks. `Do company background check` listens to the background check record, advances the pending task to processing, calls the AI ​​employee, and writes the report, summary, and company's current background fields upon completion.
+
+The third layer is responsible for providing controlled writeback capabilities to AI employees. As a tool-based workflow, `Update company background` restricts AI to only write specified records according to clear parameters to avoid over-exerting data modification permissions.
+
+The fourth layer is responsible for exception cleaning. `Clean overtime processing background check` runs every 30 minutes to clean up non-completed tasks that have not been completed for more than 15 minutes to avoid long-term processing of tasks after abnormal interruption.
+
+![](https://static-docs.nocobase.com/202607121808799.png)
+
+## What scenarios can be migrated to?
+
+What this scene shows is not an isolated form or a separate AI button, but a combination of several capabilities in NocoBase: the data table is responsible for carrying business objects and historical records, the page is responsible for viewing and triggering by business personnel, the workflow is responsible for scheduling and writing back, and the AI ​​staff is responsible for generating reviewable structured results.
+
+Similar models can be migrated to scenarios such as supplier admission, customer due diligence, contract risk preliminary review, lead quality scoring, public opinion tracking, and preliminary screening of investment and financing targets. As long as there are several requirements in the business such as "data needs to be continuously completed", "AI results need to be left behind" and "historical versions cannot be overwritten", a runnable, trackable and scalable automated process can be built in a similar way.
+
+## Reference documentation
+
+- [NocoBase Workflow](/workflow/)
+- [NocoBase AI Employee](/ai-employees/)
+- [NocoBase Workflow AI Employee Node ](/ai-employees/workflow/nodes/employee/configuration)
+- [NocoBase AI employee customization tool ](/ai-employees/features/tools)

package/dist/ai/docs/nocobase/ai-employees/workflow/nodes/knowledge/create-document.md

@@ -30,7 +30,7 @@ Where:
 
 The example uses the `Answers` / `Questions` collections and target knowledge base described in [Overview](./). Before configuring the workflow, confirm that:
 
-- A Local knowledge base has been created, with file storage and vector store configured. See [Knowledge base overview](../../../knowledge-base/knowledge-base) and [Vector store](../../../knowledge-base/vector-store)
+- A Local knowledge base has been created, with file storage, vector database, LLM service, and embedding model configured. See [Knowledge base overview](../../../knowledge-base/knowledge-base/index.md) and [Vector database](../../../knowledge-base/vector-database)
 - The `Answers.questions` relation field is ready. To review the collection structure, return to [Overview](./)
 - The workflow uses asynchronous execution. See [Workflow](../../../../workflow) for the basics
 

package/dist/ai/docs/nocobase/api/app/env.md

@@ -57,6 +57,8 @@ Whitelist for outbound HTTP requests initiated by the server. It applies to serv
 
 When this variable is not configured, NocoBase still allows `http` / `https` requests to keep existing deployments compatible. However, if the target is a loopback, private, link-local, or metadata address, or if a domain resolves to one of these addresses, the server logs a warning. Future versions may gradually tighten the default behavior. If your deployment needs to access internal services, configure an explicit whitelist in advance.
 
+When this variable is configured, the initial request and every redirect destination must match a whitelist entry. If a redirect points to a non-matching host, NocoBase stops before sending the redirected request.
+
 Supported entries include:
 
 - Exact IPv4 address, such as `192.168.1.10`
@@ -105,7 +107,7 @@ For example, to add the `hello` plugin to the `my-nocobase-app` project, the ful
 PLUGIN_PACKAGE_PREFIX can be configured as:
 
 ```bash
-PLUGIN_PACKAGE_PREFIX=@nocobase/plugin-,@nocobase-preset-,@my-nocobase-app/plugin-
+PLUGIN_PACKAGE_PREFIX=@nocobase/plugin-,@nocobase/preset-,@my-nocobase-app/plugin-
 ```
 
 Then the mapping between plugin names and package names is as follows:

package/dist/ai/docs/nocobase/api/cli/index.md

@@ -1,7 +1,7 @@
 ---
 title: 'NocoBase CLI'
-description: 'NocoBase CLI (`nb` command) reference: initialization, backup and restore, configuration, environment management, app runtime, source code, database, plugins, commercial license, API, CLI self-update, and Skills management.'
-keywords: 'NocoBase CLI,nb,command line,command reference,backup,restore,environment management,plugin management,commercial license,API'
+description: 'NocoBase CLI (`nb` command) reference: initialization, backup and restore, configuration, environment management, app runtime, portal, source code, database, plugins, commercial license, API, CLI self-update, and Skills management.'
+keywords: 'NocoBase CLI,nb,command line,command reference,backup,restore,environment management,Portal,plugin management,commercial license,API'
 ---
 
 # NocoBase CLI
@@ -39,6 +39,7 @@ The following command groups are shown in `nb --help`:
 | [`nb env`](./env/index.md)           | Manage NocoBase project environments, the current env, status, details, and runtime commands. |
 | [`nb license`](./license/index.md)   | Manage commercial licenses and licensed plugins.                                              |
 | [`nb plugin`](./plugin/index.md)     | Manage plugins in the selected NocoBase env.                                                  |
+| [`nb portal`](./portal/index.md)     | Manage portals: configure, create, develop, sync source, deploy, and destroy.                       |
 | [`nb scaffold`](./scaffold/index.md) | Generate scaffolding for NocoBase plugin development.                                         |
 | [`nb self`](./self/index.md)         | Check or update NocoBase CLI itself.                                                          |
 | [`nb session`](./session/index.md)   | Configure `NB_SESSION_ID` so the current env is isolated by shell or agent runtime.           |
@@ -70,6 +71,8 @@ nb backup --help
 nb config --help
 nb api resource --help
 nb license --help
+nb portal --help
+nb portal config --help
 ```
 
 ## Examples
@@ -127,6 +130,15 @@ nb license status -e app1
 nb license plugins list -e app1
 ```
 
+Create and develop a portal:
+
+```bash
+nb portal create customer -e app1 --yes
+nb portal config customer -e app1 --yes --source-storage git --git-repo git@github.com:nocobase/customer-portal.git
+nb portal dev customer -e app1 --yes
+nb portal deploy customer -e app1 --yes
+```
+
 Create and download a backup:
 
 ```bash

package/dist/ai/docs/nocobase/api/cli/portal/config.md

@@ -0,0 +1,44 @@
+---
+title: "nb portal config"
+description: "nb portal config command reference: update source storage and Git source configuration for a portal."
+keywords: "nb portal config,NocoBase CLI,Portal"
+---
+
+# nb portal config
+
+Update the local portal source configuration and sync it to the remote portal record when possible
+
+## Usage
+
+```bash
+nb portal config <portal> [flags]
+```
+
+## Flag
+
+| Flag | Type | Description |
+| --- | --- | --- |
+| `<portal>` | string | Portal name or slug |
+| `--env`, `-e` | string | CLI env name. If omitted, the current env is used. |
+| `--yes`, `-y` | boolean | Skip cross-env confirmation. |
+| `--source-storage` | `nocobase` \| `git` | Where portal source code is managed. |
+| `--git-repo` | string | Git repository URL used with `--source-storage=git`. |
+| `--git-branch` | string | Git branch used with `--source-storage=git`. |
+| `--git-path` | string | Directory inside the Git repository; defaults to the repository root (`.`). |
+
+## Examples
+
+```bash
+nb portal config customer --source-storage nocobase
+nb portal config customer --source-storage git --git-repo git@github.com:nocobase/customer-portal.git
+nb portal config customer --git-branch main --git-path portals/customer
+```
+
+## Notes
+
+Pass at least one configuration flag. The local workspace must already exist; use `nb portal create` or `nb portal pull` first. If the remote portal record exists, the configuration is synced to it; otherwise only `portal.config.json` is updated locally.
+
+## Related Commands
+
+- [`nb portal`](./index.md)
+- [`nb env`](../env/index.md)

package/dist/ai/docs/nocobase/api/cli/portal/create.md

@@ -0,0 +1,48 @@
+---
+title: "nb portal create"
+description: "nb portal create command reference: create a local portal from a template and create or update the portal record."
+keywords: "nb portal create,NocoBase CLI,Portal"
+---
+
+# nb portal create
+
+Create a local portal from a template and create or update the portal record
+
+## Usage
+
+```bash
+nb portal create <portal> [flags]
+```
+
+## Flag
+
+| Flag | Type | Description |
+| --- | --- | --- |
+| `<portal>` | string | Portal name or slug. |
+| `--template` | string | Template package, local path, or `file://` URL. Default: `@nocobase/portal-template-default`. |
+| `--env`, `-e` | string | CLI env name. If omitted, the current env is used. |
+| `--yes`, `-y` | boolean | Skip cross-env confirmation. |
+| `--title` | string | Portal display title. |
+| `--force` | boolean | Delete the existing workspace and recreate it. |
+| `--source-storage` | `nocobase` \| `git` | Where portal source code is managed. Default: `nocobase`. |
+| `--git-repo` | string | Git repository URL used with `--source-storage=git`. |
+| `--git-branch` | string | Git branch used with `--source-storage=git`. |
+| `--git-path` | string | Directory inside the Git repository; defaults to the repository root (`.`). |
+
+## Examples
+
+```bash
+nb portal create customer
+nb portal create customer --template @nocobase/portal-template-default
+nb portal create customer --env dev --yes
+nb portal create customer --source-storage git --git-repo git@github.com:nocobase/customer-portal.git
+```
+
+## Notes
+
+The command writes `.env`, `.env.local`, and `portal.config.json`. If the template contains `package.json`, it runs `pnpm install`. Portal names must use lowercase letters, numbers, underscores, or hyphens, and start with a lowercase letter or number.
+
+## Related Commands
+
+- [`nb portal`](./index.md)
+- [`nb env`](../env/index.md)

package/dist/ai/docs/nocobase/api/cli/portal/deploy.md

@@ -0,0 +1,39 @@
+---
+title: "nb portal deploy"
+description: "nb portal deploy command reference: build and deploy a portal."
+keywords: "nb portal deploy,NocoBase CLI,Portal"
+---
+
+# nb portal deploy
+
+Build and deploy the specified portal
+
+## Usage
+
+```bash
+nb portal deploy <portal> [flags]
+```
+
+## Flag
+
+| Flag | Type | Description |
+| --- | --- | --- |
+| `<portal>` | string | Portal name or slug. |
+| `--env`, `-e` | string | CLI env name. If omitted, the current env is used. |
+| `--yes`, `-y` | boolean | Skip cross-env confirmation. |
+
+## Examples
+
+```bash
+nb portal deploy customer
+nb portal deploy customer --env dev --yes
+```
+
+## Notes
+
+The command refreshes `.env` and `.env.local`, runs `pnpm build`, and expects `dist/index.html`. For `local` and `docker` envs, it syncs the portal record and uses the local or volume-mounted `dist`; for `http` envs, it uploads the packed `dist` through the API.
+
+## Related Commands
+
+- [`nb portal`](./index.md)
+- [`nb env`](../env/index.md)