Knowledge Base updated: 2026-11-19
Twenty Knowledge Base
Twenty is a workspace-centric CRM platform. Its monorepo combines a React web client, a NestJS server, reusable shared contracts and UI packages, an application SDK/CLI, and packaged applications.
Critical workspace state is persisted through the server's database and metadata layers. The frontend derives product behavior from GraphQL/API data, workspace metadata, and local client stores; asynchronous work moves through server workers and queues.
System map
flowchart TD
Browser[Web browser] --> Client[twenty-front React client]
Client --> API[twenty-server APIs]
Client --> Shared[twenty-shared contracts]
API --> Metadata[Metadata and workspace runtime]
API --> CRM[CRM modules]
API --> Integrations[Connected accounts and messaging]
API --> Workflows[Workflow and logic runtime]
API --> Applications[Application platform]
API --> DB[(Workspace database)]
API --> Queue[Worker queues and cron jobs]
Queue --> DB
CLI[twenty-cli] --> API
SDK[Application SDK] --> Applications
Applications --> DB
Shared --> Client
Shared --> API
Glossary
- Workspace metadata — runtime definitions for objects, fields, views, roles, and other workspace-specific behavior.
- Object record — a data record governed by object metadata, including standard CRM objects and custom objects.
- Application — a packaged extension with manifests, configuration, logic functions, and frontend components.
- Logic function — application or workflow executable behavior invoked by the server runtime.
- Connected account — an authenticated external-provider connection used for calendar, messaging, and synchronization.
Codebase-wide invariants
- Workspace-facing behavior must resolve through metadata rather than assume only fixed CRM schemas; evidence:
packages/twenty-server/src/engine/metadata-modules/**. - Frontend API access is generated and composed through the client GraphQL layer; evidence:
packages/twenty-front/src/modules/**/graphql/**. - Shared contracts must remain consumable by both server and client; evidence:
packages/twenty-shared/src/**and package imports acrosstwenty-frontandtwenty-server. - Background execution must be registered through queue, worker, or cron infrastructure rather than browser-only scheduling; evidence: packages/…/cron-register-all.command.ts and
packages/twenty-server/src/engine/**/jobs/**. - Application delivery must preserve manifest-driven composition across CLI, SDK, frontend, and server boundaries; evidence:
packages/twenty-cli/src/app/**andpackages/twenty-server/src/engine/core-modules/application/**.
Routing table
| Paths or trigger | Knowledge-base page |
|---|---|
packages/…/main.ts, packages/twenty-server/src/engine/**, packages/twenty-server/src/modules/** | Backend application platform |
packages/twenty-server/src/engine/metadata-modules/**, packages/twenty-server/src/engine/api/**, packages/twenty-server/src/engine/workspace-manager/** | API, metadata, and workspace runtime |
packages/twenty-server/src/database/**, packages/twenty-server/src/engine/**/jobs/**, packages/twenty-server/src/engine/**/queue/** | Data persistence and event processing |
packages/twenty-server/src/engine/core-modules/**, packages/twenty-server/src/modules/** | CRM workspace domain |
packages/twenty-front/src/modules/object-record/**, packages/twenty-front/src/modules/activities/**, packages/twenty-front/src/modules/dashboard/**, packages/twenty-front/src/modules/object-metadata/** | Records, views, and activity experiences |
packages/twenty-front/src/modules/auth/**, packages/twenty-front/src/modules/onboarding/**, packages/twenty-server/src/engine/core-modules/user/**, packages/twenty-server/src/engine/core-modules/workspace-member/** | Identity, onboarding, and workspace membership |
packages/twenty-front/src/modules/workflow/**, packages/twenty-front/src/modules/ai-chat/**, packages/twenty-server/src/engine/core-modules/workflow/** | Automation and AI capabilities |
packages/twenty-server/src/engine/core-modules/workflow/**, packages/twenty-front/src/modules/workflow/**, packages/twenty-shared/src/workflow/** | Workflow and logic-function execution |
packages/twenty-front/src/modules/ai-chat/**, packages/twenty-sdk/**, packages/twenty-server/src/engine/core-modules/application/** | AI features and application extensibility |
packages/twenty-server/src/engine/core-modules/messaging/**, packages/twenty-server/src/engine/core-modules/calendar/**, packages/twenty-front/src/modules/inbox/** | External integrations and communications |
packages/twenty-server/src/engine/core-modules/connected-account/**, packages/twenty-server/src/engine/core-modules/messaging/**, packages/twenty-server/src/engine/core-modules/calendar/** | Connected accounts and messaging sync |
packages/twenty-front/src/modules/applications/**, packages/twenty-sdk/**, packages/twenty-server/src/engine/core-modules/marketplace/** | Marketplace, Zapier, and external extensions |
packages/twenty-server/src/engine/core-modules/application/**, packages/twenty-front/src/modules/applications/**, packages/twenty-shared/src/application/** | Packaged installed applications |
packages/twenty-cli/src/**, packages/…/package.json | CLI application delivery |
packages/twenty-front/src/**, packages/…/package.json | Web client application |
packages/twenty-front/src/config/**, packages/twenty-front/src/modules/ui/**, packages/twenty-front/src/locales/**, packages/twenty-front/src/modules/settings/** | Client application shell and navigation |
packages/twenty-front/src/modules/object-record/**, packages/twenty-front/src/modules/activities/**, packages/twenty-front/src/modules/file/**, packages/twenty-front/src/modules/import/** | Client record and productivity experiences |
packages/twenty-front/src/modules/settings/admin-panel/**, packages/twenty-front/src/modules/**/log/** | Administrative log console |
packages/twenty-shared/src/**, packages/twenty-ui/** | Shared libraries and design system |
packages/twenty-shared/src/**, packages/twenty-front/src/modules/**/types/** | Shared domain contracts and utilities |
packages/twenty-ui/src/**, packages/twenty-front/src/modules/ui/** | UI component system |