Quick Start

Before you start

Use Node.js 24.5+ and Yarn 4. Install the CLI globally; your app keeps its own SDK dependencies.

Building Twenty apps is officially supported on Unix systems (macOS and Linux) only. On Windows, work inside WSL 2.

Create the project

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

app init writes the template only. It does not install dependencies, initialize Git, start Docker, authenticate, or sync. Customize the display name and description with --display-name and --description; use --path for a different destination.

Connect to Twenty

Use an existing workspace, or start a local server, then sign in:

twenty auth login --url https://your-workspace.twenty.com --name dev

Sync your changes

For the first sync, explicitly allow registration and installation:

twenty app apply --create

Then start the development watcher:

twenty app dev

Use bounded commands for scripts and agents:

twenty app plan
twenty app apply

plan previews changes. apply uploads and synchronizes once. Use --no-delete to keep remote entities missing from source, or --yes to permit object and field deletions without a prompt. All three commands require an authenticated remote and registration ownership.

What you can build

Apps are composed of entities — each defined as a TypeScript file with a single export default:

Entity	What it does
Objects & Fields	Custom data models (Post Card, Invoice, etc.) with typed fields
Logic functions	Server-side TypeScript triggered by HTTP routes, cron schedules, or database events
Front components	React components that render inside Twenty’s UI (side panel, widgets, command menu)
Skills & Agents	AI capabilities — reusable instructions and autonomous assistants
Views & Navigation	Pre-configured list views and sidebar menu items
Page layouts	Custom record detail pages with tabs and widgets

Full reference: Concepts.

Build with AI agent skills

Official Twenty Agent Skills teach coding agents the full app workflow: scaffolding, entity development, sync and deploy operations, and marketplace publishing. They install into Claude Code, Codex, Cursor, Pi, and any other harness supported by the skills CLI, and work against any Twenty instance, including self-hosted custom domains and localhost.

# List the available skills
npx skills add https://github.com/twentyhq/twenty/tree/agent-skills --list

# Install the scaffolding and development skills
npx skills add https://github.com/twentyhq/twenty/tree/agent-skills --skill create-app
npx skills add https://github.com/twentyhq/twenty/tree/agent-skills --skill develop-app

Each skill installs with its own reference docs. The agent-skills branch becomes available after the first successful publish from main; before that, follow the local build instructions.

Next steps

Config

Application identity, default role, install and uninstall hooks, public assets.

Data

Objects, fields, and bidirectional relations.

Logic

Logic functions, skills, agents, connections, and messaging channels.

Layout

Views, navigation, page layouts, front components.

Operations

CLI, testing, remotes, CI, and publishing your app.

Developers

Apps

API

Self-Host

Contribute

UI Library

Before you start

Create the project

Connect to Twenty

Sync your changes

What you can build

Build with AI agent skills

Next steps

​Before you start

​Create the project

​Connect to Twenty

​Sync your changes

​What you can build

​Build with AI agent skills

​Next steps

Before you start

Create the project

Connect to Twenty

Sync your changes

What you can build

Build with AI agent skills

Next steps