📄 仓库 README

在 GitHub 查看 ↗

来自 GitHub 仓库自述文件 · 版权归原作者所有

The #1 Open-Source CRM

Website · Documentation · Roadmap · Discord · Figma

Why Twenty

Twenty gives technical teams the building blocks for a custom CRM that meets complex business needs and quickly adapts as the business evolves. Twenty is the CRM you build, ship, and version like the rest of your stack.

Learn more about why we built Twenty

Installation

Cloud

The fastest way to get started. Sign up at twenty.com and spin up a workspace in under a minute, with no infrastructure to manage and always up to date.

Build an app

Scaffold a new app with the Twenty CLI:

npm install -g twenty
twenty app init my-app
cd my-app
yarn install

Define objects, fields, and views as code:

import { defineObject, FieldType } from 'twenty-sdk/define';

export default defineObject({
  nameSingular: 'deal',
  namePlural: 'deals',
  labelSingular: 'Deal',
  labelPlural: 'Deals',
  fields: [
    { name: 'name', label: 'Name', type: FieldType.TEXT },
    { name: 'amount', label: 'Amount', type: FieldType.CURRENCY },
    { name: 'closeDate', label: 'Close Date', type: FieldType.DATE_TIME },
  ],
});

Then ship it to your workspace:

twenty auth login --url https://your-workspace.twenty.com
twenty app publish --private

See the app development guide for objects, views, agents, and logic functions.

Building with a coding agent? Install the official Twenty app skills, which work in Claude Code, Codex, Cursor, Pi, and any other harness supported by the skills CLI:

npx skills add https://github.com/twentyhq/twenty/tree/agent-skills --list

The agent-skills branch is created by the first successful publish from main. Until then, use the local build instructions. SKILLS.md explains the other skill families in this repository and who they are for.

Self-hosting

Run Twenty on your own infrastructure with Docker Compose, or contribute locally via the local setup guide.

Everything you need

Twenty gives you the building blocks of a modern CRM (objects, views, workflows, and agents) and lets you extend them as code. Here's a tour of what's in the box.

Want to go deeper? Read the User Guide for product walkthroughs, or the Documentation for developer reference.

Learn more about apps in doc	Learn more about version control in doc
Learn more about primitives in doc	Learn more about layouts in doc
Learn more about AI in doc	Learn more about CRM features in doc