ContextQMD
Back to Twenty

README

packages/create-twenty-app/README.md

2.2.03.2 KB
Original Source
<div align="center"> <a href="https://twenty.com"> <picture> 
</picture>
</a> <h1>Create Twenty App</h1>

<a href="https://www.npmjs.com/package/create-twenty-app"></a> <a href="https://github.com/twentyhq/twenty/blob/main/LICENSE"></a> <a href="https://discord.gg/cx5n4Jzs57"></a>

</div>

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

Quick start

bash
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

FlagDescription
--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-instanceSkip 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:

bash
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:

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