Charles Bochet
63806b24fe
## Summary - Follows up on #19610 which exported view/page-layout types but missed field settings types - Adds re-exports for `DateDisplayFormat`, `NumberDataType`, and `FieldMetadataSettingsOnClickAction` from the SDK public API - These enums are referenced in the return type of `defineObject` (via field settings types like `FieldMetadataSettingsDate`, `FieldMetadataSettingsNumber`, `FieldMetadataSettingsMultiItem`) but were not publicly exported - This causes TS4082 ("private name") errors for SDK consumers that have `declaration: true` in their tsconfig, specifically when using `defineObject` with fields that have settings (e.g. SELECT, DATE, NUMBER fields)
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:
- Create a new project with TypeScript, linting, tests, and a preconfigured
twentyCLI - Optionally start a local Twenty server (Docker)
- 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 tryyarn 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 devis running — it auto-generates the typed client.