ContextQMD
Back to Twenty

README

packages/create-twenty-app/README.md

2.5.03.6 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. Start a local Twenty server via Docker (pulls the latest image automatically)
  3. Authenticate with the development API key

Options

FlagDescription
--example <name>Initialize from an example
--name <name>Set the app name
--display-name <displayName>Set the display name
--description <description>Set the description
--api-url <url>Twenty instance URL (default: http://localhost:2020)
--authentication-method <method>oauth or apiKey (default: apiKey for local, oauth for remote)

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:

  • Quick Start — scaffold, run a local server, sync your code
  • Concepts — how apps work: entity model, sandboxing, lifecycle
  • Operations — CLI, testing, CI, deploy and publish

Troubleshooting

  • Server not starting: check Docker is running (docker info), then try yarn twenty server logs.
  • Auth not working: run yarn twenty remote add --local to re-authenticate.
  • Types not generated: ensure yarn twenty dev is running — it auto-generates the typed client.

Contributing