twenty/packages/create-twenty-app

Create Twenty App

The official scaffolding CLI for building apps on top of Twenty CRM. Sets up a ready-to-run project with twenty-sdk.

Quick start

npx create-twenty-app@latest my-twenty-app
cd my-twenty-app
yarn twenty dev

The scaffolder will:

1. Create a new project with TypeScript, linting, tests, and a preconfigured twenty CLI
2. Optionally start a local Twenty server (Docker)
3. Open the browser for OAuth authentication

Options

Flag	Description
--example <name>	Initialize from an example
--name <name>	Set the app name (skips the prompt)
--display-name <displayName>	Set the display name (skips the prompt)
--description <description>	Set the description (skips the prompt)
--skip-local-instance	Skip the local server setup prompt

By default (no flags), a minimal app is generated with core files and an integration test. Use --example to start from a richer example:

npx create-twenty-app@latest my-twenty-app --example hello-world

Examples are sourced from twentyhq/twenty/packages/twenty-apps/examples.

Documentation

Full documentation is available at docs.twenty.com/developers/extend/apps:

• Getting Started — step-by-step setup, project structure, server management, CI
• Building Apps — entity definitions, API clients, testing
• Publishing — deploy, npm publish, marketplace

Troubleshooting

• Server not starting: check Docker is running (docker info), then try yarn twenty server logs.
• Auth not working: make sure you are logged in to Twenty in the browser, then run yarn twenty remote add.
• Types not generated: ensure yarn twenty dev is running — it auto-generates the typed client.

Contributing

• See our GitHub
• Join our Discord