Charles Bochet
7540bb064f
## Summary - Fixes TS4082 errors for SDK consumers with `declaration: true` in their tsconfig - The `define*` functions (e.g. `defineView`, `definePageLayout`, `defineLogicFunction`) return `ValidationResult<T>` where `T` references types from `twenty-shared` that were not re-exported from the SDK's public barrel - TypeScript cannot generate `.d.ts` files when the return type references "private names" — types that exist in the package but aren't publicly exported ### Added re-exports **Enums** (used in `ViewManifest`, `HttpRouteTriggerSettings`): - `ViewType`, `ViewFilterOperand`, `ViewFilterGroupLogicalOperator`, `ViewOpenRecordIn`, `ViewVisibility` - `HTTPMethod` **Types** (used in `PageLayoutWidgetManifest`, `LogicFunctionConfig`): - `GridPosition`, `PageLayoutWidgetConditionalDisplay` - `InputJsonSchema`
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.