Core and tool package index
Use this index to map a capability to its package and public source. It is not a dependency list that every application must install; the application's manifest and lockfile determine its dependencies. See the Plugin index and API reference for plugins and common interfaces.
Use this index
- Prefer the runtimes and services already integrated by the application template.
- Import package roots or public subpaths declared in
package.json, rather than private dependency files under src/ or dist/.
- Keep server libraries in server code; use browser-compatible entries in client code.
- Plugins provide runtime extensions. UI Registry provides editable source installed into the consuming project. Manage their dependencies and updates separately.
Application runtimes
Core libraries
| Package | Purpose |
|---|
@nocobase/api-client | HTTP requests, streaming responses and remote Repositories |
@nocobase/authorization | Authorization, permission sets and data scopes |
@nocobase/caching | Caching interfaces and adapters |
@nocobase/config | Configuration sources, parsers and merging |
@nocobase/db | Data models, queries, migrations, transactions and database extensions |
@nocobase/drive | File storage and storage drivers |
@nocobase/i18n | Client and server localization runtime |
@nocobase/jobs | Background jobs and recurring scheduling |
@nocobase/lifecycle | Record states, transitions and post-commit effects |
@nocobase/logging | Logging interfaces, formats and output |
@nocobase/mailer | Email delivery through SMTP, Resend and related mechanisms |
@nocobase/queue | Queues, producers and consumers |
@nocobase/realtime | Realtime messages, client subscriptions and server topic authorization |
@nocobase/repository-input | Query input contracts and builders shared by browsers and servers |
@nocobase/secrets | Versioned keys and sensitive-data encryption |
@nocobase/service-provider | Service containers, tokens, dependency injection and lifecycle |
@nocobase/session | Sessions and session storage |
@nocobase/snowflake | Snowflake ID generation |
@nocobase/document-extractor | Isolated document text extraction |
@nocobase/markdown-mermaid | Mermaid diagrams in React Markdown |
Database dialects
Commercial dialects include @nocobase/db-dameng, @nocobase/db-kingbase and @nocobase/db-oceanbase. See Database support and version compatibility for connection modes and version checks.
Agent and remote-command packages
Installation and versions
Use the project lockfile to reproduce dependencies. During upgrades, check the template, runtimes, plugin peer dependencies and database dialects together. Packages have independent version numbers; their major versions do not determine whether they belong to NocoBase 2 or 3.
Create an app with pnpm create @nocobase/app@beta and a plugin with pnpm create @nocobase/plugin@beta. Their implementation packages are @nocobase/create-app and @nocobase/create-plugin. See the Command-line reference for commands within an app.
Verification scope
Package names, locations and purposes were checked on 2026-10-27 against Core revision 015404ecd0db. A beta version is not a permanent compatibility baseline; installed public entries and type declarations define the available interfaces.
