Core · 参考

核心包与工具包索引

本页用于从功能找到包名和公开源码。它是包索引,不是每个应用都需要安装的依赖清单;应用实际依赖以 package.json 和锁文件为准。插件清单见插件索引,常用接口见 API 参考。

怎样使用这个索引

  • 在应用中优先使用模板已经接入的运行时和服务。
  • 导入包根入口或 package.json 中声明的公开子路径,不引用依赖的 src/、dist/ 私有文件。
  • 服务端库进入服务端代码;客户端只能使用声明支持浏览器的入口。
  • 插件提供运行时扩展,UI Registry 提供安装到使用方的可编辑源码,两者分别管理依赖和更新。

应用运行时

包用途
@nocobase/app-client客户端应用、路由、服务与 React 扩展
@nocobase/app-server服务端应用、HTTP、配置与资源接入
@nocobase/app-cli应用命令,以及开发和构建工具
@nocobase/app-websocketWebSocket 契约与 Node 服务端适配

核心基础库

包用途
@nocobase/api-clientHTTP 请求、流式响应与远程 Repository
@nocobase/authorization授权、权限集与数据范围
@nocobase/caching缓存接口与适配
@nocobase/config配置源、解析器与配置合并
@nocobase/db数据模型、查询、迁移、事务与数据库扩展
@nocobase/drive文件存储与存储驱动
@nocobase/i18n前后端多语言运行机制
@nocobase/jobs后台任务与周期调度
@nocobase/lifecycle记录状态、流转与提交后的业务效果
@nocobase/logging日志接口、格式与输出
@nocobase/mailerSMTP、Resend 等邮件发送基础能力
@nocobase/queue队列、生产者与消费者
@nocobase/realtime实时消息、客户端订阅与服务端主题授权
@nocobase/repository-input可在浏览器和服务端使用的查询输入契约与构造器
@nocobase/secrets版本化密钥与敏感数据加密
@nocobase/service-provider服务容器、Token、依赖注入与生命周期
@nocobase/session会话与会话存储
@nocobase/snowflakeSnowflake ID 生成
@nocobase/document-extractor隔离执行的文档文本提取
@nocobase/markdown-mermaid在 React Markdown 中渲染 Mermaid 图表

数据库方言

包用途
@nocobase/db-sqliteSQLite
@nocobase/db-postgresPostgreSQL
@nocobase/db-mysqlMySQL 与 MariaDB
@nocobase/db-mssqlMicrosoft SQL Server
@nocobase/db-oracleOracle Database

商业方言包括 @nocobase/db-dameng、@nocobase/db-kingbase 和 @nocobase/db-oceanbase。连接方式、数据库模式与版本核对见数据库支持与版本兼容。

Agent 与远程命令配套包

包用途
@nocobase/acp-bridge通过 ACP 连接本地编码 Agent
@nocobase/agent-protocol应用、Runner 与远程 CLI 的通信协议
@nocobase/agent-runner连接应用并领取、执行 Agent 任务
@nocobase/app-cli-client登录应用并调用应用公开的远程业务命令
@nocobase/cli-envelopeCLI JSON 输出契约与 Node 版本检查

开发与测试工具

包用途
@nocobase/app-skills应用开发、升级、部署与插件开发 Skills
@nocobase/app-testing应用与插件的测试辅助工具
@nocobase/db-testing隔离数据库环境与可跨方言运行的测试辅助工具
@nocobase/db-testkit数据库方言共用的集成测试契约
@nocobase/dev-configTypeScript、ESLint、Vitest、Vite 等共享配置
@nocobase/create-app创建应用的脚手架
@nocobase/create-plugin创建插件的脚手架

部署与托管工具

包用途
@nocobase/app-installer从部署归档安装、升级与回滚应用
@nocobase/app-host应用运行托管
@nocobase/app-host-dockerApp Host 的 Docker 托管后端

安装与版本

使用项目锁文件复现依赖;升级时同时检查模板、运行时、插件的 peer dependencies 和数据库方言。各包独立编号,版本号不要求相同,不能根据包版本的主版本号判断它属于 NocoBase 2 还是 3。

创建项目使用 pnpm create @nocobase/app@beta,创建插件使用 pnpm create @nocobase/plugin@beta;它们对应的实现包分别是 @nocobase/create-app 与 @nocobase/create-plugin。应用内命令见命令行参考。

核对范围

包名、位置与职责按 Core 源码修订 015404ecd0db 核对于 2026-10-27。这里不把某个 beta 版本描述为永久兼容基线,安装后的公开入口与类型声明决定可用接口。

NocoBase 文档助手

关于 NocoBase,你想了解什么?

每次提问独立回答,不会参考之前的问答。请提供完整背景。