@nocobase/plugin-ai 2.2.0-alpha.1 → 2.2.0-alpha.2

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

@@ -42,7 +42,7 @@ nb init --env app1 --resume
 
 `--prepare-only` is intended for flows where the env should be prepared first, then the license is activated, and only after that the app is installed and started.
 
-If you want to save the env config, prepare the source files or image, and get the database ready first, but delay the actual app installation and first startup, you can use:
+If you want to save the env config and prepare the database first, while delaying dependency download, app installation, and first startup, you can use:
 
 ```bash
 nb init --env app1 --prepare-only
@@ -67,6 +67,7 @@ By default, the CLI organizes local files under `app-path` using the following c
 
 ```text
 <app-path>/
+├── .nb/      # CLI metadata for this env, such as hooks.mjs
 ├── source/   # Default directory for app source code or downloaded content
 ├── storage/  # Runtime data directory
 └── .env      # Optional app environment variable file
@@ -74,7 +75,8 @@ By default, the CLI organizes local files under `app-path` using the following c
 
 Typically:
 
-- `source/` mainly corresponds to the local app directory for npm / Git envs. For Docker envs, the CLI also keeps this default path derivation, but most of the time you do not need to care about it manually
+- `.nb/` stores CLI-managed metadata. A script passed with `--hook-script` is copied to `<app-path>/.nb/hooks.mjs`, so later `nb app upgrade` and local source restore can reuse it
+- `source/` mainly corresponds to the local app directory for npm / Git envs. For Docker envs, the CLI also keeps this default path derivation, but most of the time you do not need to care about it manually. Pay special attention during upgrades: the `source/` directory will be deleted and downloaded again, so do not put files you need to keep here
 - `storage/` is used for runtime data, such as built-in database data, plugins, logs, and more
 - `.env` is an optional app environment variable file. You only need to add it in `<app-path>/.env` when you want to customize environment variables; if this file exists, Docker, npm, and Git install sources will all read it by default
 
@@ -101,7 +103,7 @@ If you are following the local UI wizard step by step, you can first use the tab
 | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `Getting started`         | `--env`、`--yes`、`--ui`、`--locale`、`--verbose`、`--skip-skills`、`--resume`                                                                                                                                    |
 | `App environment`         | `--lang`、`--app-path`、`--app-port`、`--force`                                                                                                                                                                   |
-| `App source and version`  | `--source`、`--version`、`--skip-download`、`--git-url`、`--docker-registry`、`--docker-platform`、`--npm-registry`、`--replace`、`--dev-dependencies`、`--output-dir`、`--docker-save`、`--build`、`--build-dts` |
+| `App source and version`  | `--source`、`--version`、`--skip-download`、`--git-url`、`--docker-registry`、`--docker-platform`、`--npm-registry`、`--replace`、`--dev-dependencies`、`--output-dir`、`--docker-save`、`--build`、`--build-dts`、`--hook-script` |
 | `Configure the database`  | `--builtin-db`、`--db-dialect`、`--builtin-db-image`、`--db-host`、`--db-port`、`--db-database`、`--db-user`、`--db-password`、`--db-schema`、`--db-table-prefix`、`--db-underscored`                             |
 | `Create an admin account` | `--root-username`、`--root-email`、`--root-password`、`--root-nickname`                                                                                                                                           |
 | `Remote connection`       | `--api-base-url`、`--auth-type`、`--access-token`、`--username`、`--password`、`--skip-auth`                                                                                                                      |
@@ -121,7 +123,7 @@ The “Default” below means the value or behavior that `nb init` usually uses
 | `--ui`          | boolean | `false`                                                                      | Open the local browser wizard; cannot be used with `--yes` or `--resume`               |
 | `--verbose`     | boolean | `false`                                                                      | Show detailed command output                                                           |
 | `--skip-skills` | boolean | `false`                                                                      | Skip syncing NocoBase AI coding skills                                                 |
-| `--ui-host`     | string  | `127.0.0.1`                                                                  | Bind address for the `--ui` local service                                              |
+| `--ui-host`     | string  | `127.0.0.1`                                                                  | Browser-accessible host shown in the `--ui` wizard URL; the local service always listens on `0.0.0.0` |
 | `--ui-port`     | integer | `0`                                                                          | Port for the `--ui` local service; `0` means automatic assignment                      |
 | `--locale`      | string  | Follows `NB_LOCALE`, CLI config, or system locale; final fallback is `en-US` | Language for CLI prompts and the local setup UI: `en-US` or `zh-CN`                    |
 | `--resume`      | boolean | `false`                                                                      | Continue the last unfinished initialization and reuse the saved workspace env config   |
@@ -184,6 +186,7 @@ The “Default” below means the value or behavior that `nb init` usually uses
 | `--npm-registry`                                     | string  | Empty                                                                                            | Registry used for npm/Git download and dependency installation                           |
 | `--build` / `--no-build`                             | boolean | `true`                                                                                           | Whether to build after installing npm/Git dependencies                                   |
 | `--build-dts`                                        | boolean | `false`                                                                                          | Whether to generate TypeScript declaration files during npm/Git builds                   |
+| `--hook-script`                                      | string  | None                                                                                             | Copy the specified hook module to `<app-path>/.nb/hooks.mjs` and save it in the env config; supports the `beforeDependencyInstall`, `beforeAppInstall`, and `afterAppStart` lifecycle hooks |
 
 ## Examples
 
@@ -233,6 +236,40 @@ nb init --env app1 --yes --source git --version latest \
   --git-url https://gitee.com/nocobase/nocobase.git
 ```
 
+### Extend the install flow with a hook script
+
+If you need to prepare extra content during installation, pass a local ESM module with `--hook-script`:
+
+```bash
+nb init --env app1 --yes --source git --hook-script ./hooks.mjs
+```
+
+The CLI copies this file to `<app-path>/.nb/hooks.mjs` and saves `hookScript: ".nb/hooks.mjs"` in the env config. Later `nb app start`, `nb app restart`, and `nb app upgrade` reuse it from that location.
+
+The hook file must default-export an object. Implement only the methods you need:
+
+```js
+export default {
+  beforeDependencyInstall: async (context) => {
+    // Runs after git clone / npm scaffold and before yarn install.
+  },
+  beforeAppInstall: async (context) => {
+    // Runs before the app-level install or upgrade command.
+  },
+  afterAppStart: async (context) => {
+    // Runs after the app actually starts and passes the health check.
+  },
+};
+```
+
+- `beforeDependencyInstall` only applies to npm/Git source and runs right before the real `yarn install`; Docker source does not run it
+- `beforeAppInstall` runs before app-level install or upgrade commands, and applies to npm/Git/Docker source
+- `afterAppStart` runs after the app actually starts and passes `__health_check`; `nb app start`, `nb app restart`, and `nb app upgrade` may all trigger it
+
+`--prepare-only` only saves the env config and copies the hook file. It does not execute hooks. When you later run `nb app start` for the first time, the CLI runs the first-install hooks with `context.phase` set to `init` and `context.command` set to `app:start`.
+
+`context` includes lifecycle information such as `phase`, `command`, `source`, `version`, `appPath`, `sourcePath`, `storagePath`, `hookScript`, and `envConfig`. If a hook throws, the current CLI command fails. Because `afterAppStart` can run repeatedly during start, restart, and upgrade flows, keep it idempotent.
+
 ### Quick install and use basic authentication
 
 If you want to quickly install a local app in non-interactive mode and directly save `basic` authentication after installation, you can also write it like this. This way, you do not need to open a browser to complete OAuth.

package/dist/ai/docs/nocobase/api/cli/plugin/import.md

@@ -71,4 +71,4 @@ You do not need to extract anything into `storage/plugins` by hand. `nb plugin i
 
 - [`nb app restart`](../app/restart.md)
 - [`nb plugin enable`](./enable.md)
-- [`Install and upgrade third-party plugins`](../../../quickstart/plugins/third-party.md)
+- [`Install and upgrade third-party plugins`](../../../nocobase-cli/plugins/third-party.md)

package/dist/ai/docs/nocobase/api/cli/self/check.md

@@ -6,7 +6,7 @@ keywords: "nb self check,NocoBase CLI,version check"
 
 # nb self check
 
-Check the current NocoBase CLI installation, resolve the latest version for the selected channel, and report whether automatic self-update is supported.
+Check the current NocoBase CLI installation, resolve the latest version for the selected channel, and report whether self-update is supported.
 
 ## Usage
 
@@ -18,9 +18,26 @@ nb self check [flags]
 
 | Parameter | Type | Description |
 | --- | --- | --- |
-| `--channel` | string | Release channel to compare with, default `auto`; options: `auto`, `latest`, `beta`, `alpha` |
+| `--channel` | string | Release channel to compare with, default `auto`; options: `auto`, `latest`, `test`, `beta`, `alpha` |
 | `--json` | boolean | Output JSON |
 
+## Install Method
+
+`nb self check` detects the current install method at runtime. It does not use the historical `self-install-methods.json` cache.
+
+The command can report these install methods:
+
+| Install method | Meaning |
+| --- | --- |
+| `npm-global` | The CLI is installed under the current `npm prefix -g`. |
+| `pnpm-global` | The CLI is installed under a pnpm global `node_modules` tree. |
+| `yarn-global` | The CLI is launched from `yarn global bin` or installed under `yarn global dir`. |
+| `package-local` | The CLI is installed in a local project dependency tree. |
+| `source` | The CLI is running from a repository checkout. |
+| `unknown` | The CLI install could not be matched to a supported install method. |
+
+Self-update is supported for `npm-global`, `pnpm-global`, and `yarn-global`. For `package-local` or `source`, update the parent project or repository checkout instead.
+
 ## Examples
 
 ```bash

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

@@ -19,7 +19,7 @@ nb self <command>
 | Command | Description |
 | --- | --- |
 | [`nb self check`](./check.md) | Check current CLI version and self-update support |
-| [`nb self update`](./update.md) | Update the globally npm-installed NocoBase CLI |
+| [`nb self update`](./update.md) | Update the globally npm-, pnpm-, or yarn-installed NocoBase CLI |
 
 ## Examples
 

package/dist/ai/docs/nocobase/api/cli/self/update.md

@@ -1,12 +1,12 @@
 ---
 title: "nb self update"
-description: "nb self update command reference: update the globally npm-installed NocoBase CLI."
+description: "nb self update command reference: update the globally npm-, pnpm-, or yarn-installed NocoBase CLI."
 keywords: "nb self update,NocoBase CLI,update,self update"
 ---
 
 # nb self update
 
-Update the installed NocoBase CLI when the current CLI is managed by a standard global npm installation.
+Update the installed NocoBase CLI when the current CLI is managed by a standard global npm, pnpm, or yarn installation.
 
 ## Usage
 
@@ -18,12 +18,26 @@ nb self update [flags]
 
 | Parameter | Type | Description |
 | --- | --- | --- |
-| `--channel` | string | Release channel to update to, default `auto`; options: `auto`, `latest`, `beta`, `alpha` |
+| `--channel` | string | Release channel to update to, default `auto`; options: `auto`, `latest`, `test`, `beta`, `alpha` |
 | `--yes`, `-y` | boolean | Skip update confirmation |
 | `--json` | boolean | Output JSON |
 | `--skills` | boolean | Also refresh the globally installed NocoBase AI coding skills |
 | `--verbose` | boolean | Show detailed update output |
 
+## Update Behavior
+
+`nb self update` first detects the current install method at runtime. It does not use the historical `self-install-methods.json` cache.
+
+When an update is available, the command uses the same package manager that manages the current global CLI install:
+
+| Install method | Update command |
+| --- | --- |
+| `npm-global` | `npm install -g @nocobase/cli@<channel>` |
+| `pnpm-global` | `pnpm add -g @nocobase/cli@<channel>` |
+| `yarn-global` | `yarn global add @nocobase/cli@<channel>` |
+
+Interactive confirmation defaults to yes. Use `--yes` to skip the prompt in scripts.
+
 ## Examples
 
 ```bash

package/dist/ai/docs/nocobase/api/cli/skills/install.md

@@ -27,6 +27,7 @@ nb skills install [flags]
 ```bash
 nb skills install
 nb skills install --yes
+nb skills install --verbose
 nb skills install --json
 ```
 

package/dist/ai/docs/nocobase/api/cli/skills/update.md

@@ -27,6 +27,7 @@ nb skills update [flags]
 ```bash
 nb skills update
 nb skills update --yes
+nb skills update --verbose
 nb skills update --json
 ```
 

package/dist/ai/docs/nocobase/api/cli/source/download.md

@@ -33,6 +33,7 @@ nb source download [flags]
 | `--npm-registry` | string | Registry used for npm/Git downloads and dependency installation |
 | `--build` / `--no-build` | boolean | Whether to build after npm/Git dependency installation |
 | `--build-dts` | boolean | Whether to generate TypeScript declaration files during npm/Git build |
+| `--hook-script` | string | Hook module to run after npm scaffold or Git clone and before dependency installation; only applies to npm/Git source |
 
 ## Examples
 
@@ -47,8 +48,26 @@ nb source download --source git --version alpha --git-url=git@github.com:nocobas
 nb source download --source git --version fix/cli-v2
 nb source download -y --source npm --version alpha --build-dts
 nb source download -y --source npm --version alpha --npm-registry=https://registry.npmmirror.com
+nb source download -y --source git --version beta --hook-script ./hooks.mjs
 ```
 
+## Pre-install hook
+
+`--hook-script` only affects the current `nb source download` run. If you want the hook to be saved with the env and reused by `nb app upgrade` or local source restore, pass it through [`nb init --hook-script`](../init.md) instead.
+
+The hook file must default-export an object with `beforeDependencyInstall(context)`:
+
+```js
+export default {
+  beforeDependencyInstall: async ({ sourcePath, version, envConfig }) => {
+    // Runs after git clone / npm scaffold and before yarn install.
+  },
+};
+```
+
+When you run `nb source download --hook-script` directly, `beforeDependencyInstall` receives `context.phase` as `source-download` and `context.command` as `source:download`. This command does not run `beforeAppInstall` or `afterAppStart`; those hooks belong to app install, start, restart, and upgrade flows.
+
+
 ## Version Aliases
 
 With Git source, common dist-tags are resolved to branches: `latest` -> `main`, `beta` -> `next`, `alpha` -> `develop`.

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/validation.md

@@ -78,6 +78,9 @@ After configuring field rules, the corresponding validation rules will be trigge
 
 ![20250819201027](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20250819201027.png)
 
+When the field is used in a form, field validation rules are also displayed in the field validation settings. These rules appear under **Server-side field validation rules** and are read-only there. If you need to change them, edit the field in Data source → Collection configuration.
+
+You can still add extra rules for the current form field under **Client-side validation rules**. These rules only apply to the current field component. The final validation result combines **Server-side field validation rules** and **Client-side validation rules**.
 
 Validation rules also apply to sub-table and sub-form components:
 
@@ -93,12 +96,12 @@ Note that in sub-form or sub-table scenarios, required validation for associatio
 ![20250819203016](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20250819203016.png)
 
 
-## Differences from Client-Side Field Validation
-Client-side and server-side field validation are applied in different scenarios, with significant differences in implementation and rule trigger timing, so they need to be managed separately.
+## Differences Between Server-Side Field Validation Rules and Client-Side Validation Rules
+Server-side field validation rules and client-side validation rules are configured in different places and have different scopes.
 
 ### Configuration Method Differences
-- **Client-side validation**: Configure rules in edit forms (as shown in the figure below)
-- **Server-side field validation**: Set field rules in Data Source → Collection Configuration
+- **Server-side field validation rules**: Set field rules in Data source → Collection configuration. These rules are the base rules of the field.
+- **Client-side validation rules**: Configure extra rules in a form field's settings. These rules only affect the current field component.
 
 ![20250819203836](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20250819203836.png)
 
@@ -109,7 +112,7 @@ Client-side and server-side field validation are applied in different scenarios,
 
 
 ### Validation Trigger Timing Differences
-- **Client-side validation**: Triggers validation in real-time as users fill in fields, displaying error messages immediately.
-- **Server-side field validation**: Validates on the server side before data entry after data submission, with error messages returned through API responses.
-- **Application scope**: Server-side field validation takes effect not only during form submission but also triggers in all scenarios involving data addition or modification, such as workflows and data imports.
-- **Error messages**: Client-side validation supports custom error messages, while server-side validation does not currently support custom error messages.
+- **Server-side field validation rules**: Trigger frontend validation when the field is used in a form, and also validate before data is written. They also apply to scenarios that create or update data, such as workflows and data imports.
+- **Client-side validation rules**: Trigger frontend validation in the current form field only.
+- **Rule display**: Server-side field validation rules are shown as inherited read-only rules. Client-side validation rules are shown separately and can be edited there.
+- **Error messages**: Client-side validation rules support custom error messages, while server-side field validation rules do not currently support custom error messages.

package/dist/ai/docs/nocobase/development/index.md

@@ -2,8 +2,8 @@
 pageType: home
 pageName: development
 title: "NocoBase Development Guide"
-description: "NocoBase development guide: plugin development, FlowEngine, RunJS, block/field/action extensions, data source extensions, workflow extensions, authentication extensions."
-keywords: "NocoBase,development guide,plugin development,FlowEngine,RunJS,NocoBase extensions"
+description: "NocoBase development guide: plugin development, shared components, FlowEngine, RunJS, block/field/action extensions, data source extensions, workflow extensions, authentication extensions."
+keywords: "NocoBase,development guide,plugin development,shared components,FlowEngine,RunJS,NocoBase extensions"
 features:
   - title: Core Development
     details: Master NocoBase's underlying extension mechanism and advanced development capabilities, including the plugin system, AI assistance, FlowEngine and RunJS environment, to build a solid development foundation.
@@ -24,6 +24,10 @@ features:
         details: JavaScript execution environment for JS blocks, JS fields, and JS actions, and similar scenarios.
         link: /runjs
         showOnHome: true
+      - title: Shared Components
+        details: Reuse the built-in form, filter, table, and icon components in NocoBase client v2 when building plugin pages.
+        link: /shared-components
+        showOnHome: true
   - title: Plugin Ecosystem
     details: Extend the capabilities of existing plugins through other plugins, building a hierarchical and modular plugin ecosystem to enhance system extensibility and collaboration.
     items:
@@ -46,4 +50,7 @@ features:
       - title: File Preview Extension
         details: Extend file preview capabilities to support online preview and rendering of more file formats.
         link: /file-manager/development
+      - title: Knowledge Base Extension
+        details: Connect external knowledge bases or custom retrieval services to extend RAG retrieval sources for AI employees.
+        link: /ai-employees/knowledge-base/dev/external-knowledge-base
 ---

package/dist/ai/docs/nocobase/get-started/deployment/how-to-deploy-nocobase-faster.mdx

@@ -116,7 +116,7 @@ When users access NocoBase, requests go directly to your server. An appropriate
 - Disadvantages: This method is simple but performs poorly when handling high concurrency or static files; suitable for development and testing only.
 - Recommendation: Please avoid this method if possible.
 
-> Reference "[Installation Documentation](https://v2.docs.nocobase.com/get-started/quickstart)"
+> Reference "[Installation Documentation](https://docs.nocobase.com/get-started/quickstart)"
 
 Without a reverse proxy, homepage loading takes about 6.1 seconds
 ![20250409131357](https://static-docs.nocobase.com/20250409131357.png)
@@ -126,7 +126,7 @@ Without a reverse proxy, homepage loading takes about 6.1 seconds
 - Advantages: Reverse proxy servers can efficiently handle concurrent connections, serve static files, implement load balancing, and make HTTP/2 configuration simple.
 - Recommendation: In production environments, after application deployment (source code deployment / create-nocobase-app / Docker image), use Nginx or Caddy as a reverse proxy.
 
-> Reference "[Deployment Documentation](https://v2.docs.nocobase.com/get-started/deployment/production)"
+> Reference "[Deployment Documentation](https://docs.nocobase.com/get-started/deployment/production)"
 
 With Nginx proxy, homepage loading takes about 3-4 seconds
 ![20250409131541](https://static-docs.nocobase.com/20250409131541.png)

package/dist/ai/docs/nocobase/get-started/how-nocobase-works.mdx

@@ -3,4 +3,11 @@
 <video controls width="100%" poster="https://static-docs.nocobase.com/video-cover-home.png">
   <source src="https://static-docs.nocobase.com/nocobase-2-main-1080p-en-v2.mp4" type="video/mp4" />
   Your browser does not support video playback.
-</video>
+</video>
+
+## What's Next
+
+If you've finished the video and want to start right away, there are usually two common paths:
+
+1. If you want to compare installation methods and version channels first, continue with [Installation and Version Comparison](/ai/quickstart)
+2. If you want to install the app right away, continue with [Install NocoBase App](/ai/install-nocobase-app)

package/dist/ai/docs/nocobase/get-started/quickstart.md

@@ -55,4 +55,9 @@ You can install NocoBase in different ways.
 | **Scenarios** | No-code users; users who want to quickly deploy to a server. | Front-end/full-stack developers; team projects; low-code development. | Technical developers; users who want to try unreleased versions. |
 | **Technical Requirement** | ★☆☆☆☆ | ★★★☆☆ | ★★★★★ |
 | **Upgrade Method** | Pull the latest image and restart the container. | Update dependencies with yarn. | Synchronize updates through Git. |
-| **Tutorials** | [<code>Installation</code>](#) [<code>Upgrade</code>](#) [<code>Deployment</code>](#) | [<code>Installation</code>](#) [<code>Upgrade</code>](#) [<code>Deployment</code>](#) | [<code>Installation</code>](#) [<code>Upgrade</code>](#) [<code>Deployment</code>](#) |
+
+![2026-06-11-20-09-54](https://static-docs.nocobase.com/2026-06-11-20-09-54.png)
+
+## What's Next
+
+If you've already picked an installation method, the next step is [Install NocoBase App](/ai/install-nocobase-app). It walks you through installing NocoBase CLI and finishing the app installation and initialization.

package/dist/ai/docs/nocobase/get-started/system-requirements.md

@@ -11,6 +11,14 @@ Except for functionality validation or purely experimental scenarios, **we stron
 
 The system configuration and capacity planning of those services must be evaluated and tuned separately based on the **actual data size, workload, and concurrency level**.
 
+## Operating System
+
+For production environments, Linux servers are recommended, such as Ubuntu LTS, Debian, Rocky Linux, or AlmaLinux. Docker, reverse proxy, process management, logging, and backup workflows are more mature on Linux and are easier to integrate with common cloud server environments.
+
+NocoBase can also be installed on Windows Server. If you choose Windows Server, confirm Node.js, database, reverse proxy, process supervision, backup, file permissions, firewall, and related operations based on your actual deployment method.
+
+macOS is usually more suitable for local development and testing, and is not recommended as a production server. If you are setting up NocoBase locally for development or AI Agent usage, see [Local Development Setup](../ai/local-development-setup.md).
+
 ## Single-Node Deployment Mode
 
 Single-node deployment mode means the NocoBase application service runs on a single server or container instance.
@@ -85,4 +93,4 @@ In cluster mode, the recommended hardware configuration for each application nod
 Recommendations for production environments:
 
 - Adjust the node count dynamically based on monitoring metrics (CPU, memory, request latency, and so on).
-- Reserve a resource buffer to handle traffic spikes.
+- Reserve a resource buffer to handle traffic spikes.

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

@@ -11,21 +11,21 @@ hero:
   actions:
     - theme: brand
       text: Get Started
-      link: /get-started/how-nocobase-works
+      link: /ai/how-nocobase-works
     - theme: alt
       text: GitHub
       link: https://github.com/nocobase/nocobase
 
 features:
   - title: Start
-    details: Get started with NocoBase the traditional way - install, configure, and explore step by step.
+    details: Get started with NocoBase quickly - install, configure, and explore step by step.
     items:
-      - title: NocoBase Getting Started
+      - title: How NocoBase Works
         details: Understand NocoBase's core concepts and basic operations.
-        link: /get-started/how-nocobase-works
-      - title: Install App
-        details: Quickly install and manage applications.
-        link: /get-started/installation/docker
+        link: /ai/how-nocobase-works
+      - title: Install NocoBase App
+        details: Use NocoBase CLI to install an application quickly.
+        link: /ai/install-nocobase-app
       - title: Tutorials
         details: Step-by-step tutorials to build real projects with NocoBase from scratch.
         link: /tutorials/v2/
@@ -33,9 +33,6 @@ features:
   - title: AI
     details: An AI-powered new way to get started - use natural language to build, use, and develop.
     items:
-      - title: Quick Start
-        details: Install NocoBase CLI, configure AI Skills, and connect your AI Agent, preparing for AI building, using, and developing NocoBase.
-        link: /ai/quick-start
       - title: AI Builder
         details: Build NocoBase applications from scratch with AI, covering the full process from data modeling, UI configuration, workflows to release management.
         link: /ai-builder

package/dist/ai/docs/nocobase/interface-builder/blocks/data-blocks/gantt.md

@@ -0,0 +1,204 @@
+---
+pkg: '@nocobase/plugin-gantt'
+title: 'Gantt Block'
+description: 'The Gantt block displays record start and end dates and progress on a timeline. It is suitable for project planning, task scheduling, and milestone tracking, and supports title fields, date fields, progress fields, color fields, time scale, the left table, and event popup settings.'
+keywords: 'Gantt block,Gantt,project planning,task scheduling,timeline,progress management,UI building,NocoBase'
+---
+
+# Gantt Block
+
+## Introduction
+
+The Gantt block displays record start and end dates and progress on a timeline. It is suitable for project planning, task scheduling, milestone tracking, and other scenarios where you need to view task duration by time.
+
+![](https://static-docs.nocobase.com/Project-tasks-06-11-2026_11_30_AM.png)
+
+## Installation
+
+This block is a built-in plugin and does not require additional installation.
+
+## Add Block
+
+After selecting the Gantt block and choosing a data table, configure the fields required by the Gantt block in the popup:
+
+1. Select the title field, which is used to display the task name
+2. Select the start date field, which is used to determine the task start time
+3. Select the end date field, which is used to determine the task end time
+4. Optionally select the progress field, which is used to display and drag to update task progress
+5. Optionally select the color field, which is used to distinguish different tasks
+6. Select the time scale, which controls the granularity of the timeline
+
+After completing the configuration, you can create the Gantt block.
+
+![](<https://static-docs.nocobase.com/Project-tasks-06-11-2026_11_27_AM%20(1).png>)
+
+![](https://static-docs.nocobase.com/Project-tasks-06-11-2026_11_27_AM.png)
+
+## Block Settings
+
+![](https://static-docs.nocobase.com/Project-tasks-06-11-2026_11_28_AM.png)
+
+### Gantt Fields
+
+Gantt fields determine how records are mapped to timeline tasks.
+
+They include:
+
+- The title field determines the name displayed on the task bar
+- The start date field determines where the task bar starts
+- The end date field determines where the task bar ends
+- The progress field determines the progress displayed inside the task bar
+- The color field determines the task bar color
+- The time scale determines whether the timeline is displayed by hour, day, week, month, and so on
+
+### Title Field
+
+Used to display the task name. Usually, you can select a string field such as task name, project name, or title.
+
+### Start Date Field
+
+Used to specify the task start time. The Gantt block uses this field to place the task on the timeline.
+
+### End Date Field
+
+Used to specify the task end time. When the start date and end date are the same, the task is displayed as a shorter time range.
+
+### Progress Field
+
+Used to display task completion progress, and supports updating it by dragging the progress handle on the task bar.
+
+The progress field uses a float field. Data is stored from `0` to `1`, and displayed as a percentage in the Gantt block. For example, `0.6` is displayed as `60%`.
+
+### Color Field
+
+Used to set the task bar color, making it easier to distinguish different task types, statuses, or priorities.
+
+The color field supports:
+
+- Single select field
+- Color field
+
+If a single select field is used, the Gantt block will prioritize the color configured for the selected option.
+
+### Time Scale
+
+Used to control the timeline display granularity.
+
+Currently supported:
+
+- Hour
+- Quarter of day
+- Half of day
+- Day
+- Week
+- Month
+- Year
+- Quarter
+
+For short task spans, use hour, half-day, or day. For longer task spans, use week, month, quarter, or year.
+
+### Show Table
+
+When enabled, the Gantt block displays a table area on the left. You can configure table columns to show key task attributes.
+
+When disabled, the block only displays the timeline on the right. This is suitable when page space is limited or you only need to view scheduling.
+
+### Table Width
+
+Used to set the width of the left table area. This setting only appears when Show table is enabled.
+
+If there are many table fields, increase the table width. If only a few fields are kept, reduce the width and leave more space for the timeline.
+
+### Enable Drag to Reschedule
+
+When enabled, you can drag task bars on the timeline to adjust start and end dates.
+
+Details:
+
+- Drag the whole task bar to adjust both the start date and end date
+- Drag the handles on both sides of the task bar to adjust the start date or end date
+- Drag the progress handle to update the progress field
+
+If you do not want users to modify schedules directly in the Gantt block, disable this option.
+
+### Scroll to Today on First Display
+
+When enabled, the Gantt block automatically scrolls to today when it is first displayed.
+
+This option is suitable for projects with long task spans. When the page opens, users can first see tasks near the current date.
+
+### Event Popup Settings
+
+Used to configure how a task bar opens after being clicked.
+
+You can configure:
+
+- Open mode, such as drawer, dialog, or page
+- Popup size
+- Popup template
+
+After clicking a task bar, NocoBase opens the current record according to this configuration, making it convenient to view or edit task details.
+
+### Data Scope
+
+Used to limit the data displayed in the Gantt block.
+
+For example: only show tasks under the current project, or only show unfinished tasks.
+
+For more details, refer to [Data Scope](../block-settings/data-scope).
+
+### Page Size
+
+Used to control the number of records loaded per page. When there are many records, users can switch pages to view more tasks.
+
+### Show Row Numbers
+
+When enabled, the left table displays row numbers, making it easier to locate records when there are many tasks.
+
+### Tree Table
+
+If the current data table is a tree table, the Gantt block can enable tree table mode. After enabling it, the left table displays records by parent-child hierarchy, and the timeline on the right displays tasks in the same hierarchy.
+
+In tree table mode, you can also configure Expand all rows by default.
+
+## Configure Fields
+
+The left table area uses table columns to display record fields.
+
+![](https://static-docs.nocobase.com/Project-tasks-06-11-2026_11_29_AM.png)
+
+### Add Fields
+
+After Show table is enabled, you can add field columns to the left table. Field settings can refer to [Table Column](../../fields/generic/table-column).
+
+### Actions Column
+
+The Gantt block includes an actions column by default. You can add record actions such as view, edit, and delete to the actions column.
+
+If Event popup settings have already been configured, you can also click the task bar on the right to open record details.
+
+## Configure Actions
+
+The Gantt block supports configuring global actions at the top. Available action types depend on the enabled capabilities in the current environment.
+
+![](<https://static-docs.nocobase.com/Project-tasks-06-11-2026_11_29_AM%20(1).png>)
+
+### Built-in Actions
+
+- Today: quickly scroll to today
+- Expand/Collapse: expand or collapse all rows in tree table mode
+
+### Global Actions
+
+- [Add New](../../actions/types/add-new)
+- [Popup](../../actions/types/pop-up)
+- [Link](../../actions/types/link)
+- [Refresh](../../actions/types/refresh)
+- [Filter](../../actions/types/filter)
+- [Bulk Edit](../../actions/types/bulk-edit)
+- [Bulk Update](../../actions/types/bulk-update)
+- [Trigger Workflow](../../actions/types/trigger-workflow)
+- [Custom Request](../../actions/types/custom-request)
+- [JS Item](../../actions/types/js-item)
+- [JS Action](../../actions/types/js-action)
+- [AI Employee](../../actions/types/ai-employee)