twenty/packages/create-twenty-app/README.md

Create Twenty App

Create Twenty App is the official scaffolding CLI for building apps on top of Twenty CRM. It sets up a ready‑to‑run project that works seamlessly with the twenty-sdk.

• Zero‑config project bootstrap
• Preconfigured scripts for auth, generate, dev sync, one‑off sync, uninstall
• Strong TypeScript support and typed client generation

Prerequisites

• Node.js 18+ (recommended) and Yarn 4
• A Twenty workspace and an API key (create one at https://app.twenty.com/settings/api-webhooks)

Quick start

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

# Authenticate using your API key (you'll be prompted)
yarn auth

# Add a new entity to your application (guided)
yarn create-entity

# Generate a typed Twenty client and workspace entity types
yarn generate

# Start dev mode: automatically syncs local changes to your workspace
yarn dev

# Or run a one‑time sync
yarn sync

# Uninstall the application from the current workspace
yarn uninstall

What gets scaffolded

• A minimal app structure ready for Twenty
• TypeScript configuration
• Prewired scripts that wrap the twenty CLI from twenty-sdk
• Example placeholders to help you add entities, actions, and sync logic

Next steps

• Explore the generated project and add your first entity with yarn create-entity.
• Keep your types up‑to‑date using yarn generate.
• Use yarn dev while you iterate to see changes instantly in your workspace.

Publish your application

Applications are currently stored in twenty/packages/twenty-apps.

You can share your application with all Twenty users:

# pull the Twenty project
git clone https://github.com/twentyhq/twenty.git
cd twenty

# create a new branch
git checkout -b feature/my-awesome-app

• Copy your app folder into twenty/packages/twenty-apps.
• Commit your changes and open a pull request on https://github.com/twentyhq/twenty

git commit -m "Add new application"
git push

Our team reviews contributions for quality, security, and reusability before merging.

Troubleshooting

• Auth prompts not appearing: run yarn auth again and verify the API key permissions.
• Types not generated: ensure yarn generate runs without errors, then re‑start yarn dev.

Contributing

• See our GitHub
• Join our Discord