Files
twenty/packages/twenty-cli
martmull e498367e2f Merge twenty-cli into twenty-sdk (#16150)
- Moves twenty-cli content into twenty-sdk
- add a new twenty-sdk:0.1.0 version
- this new twenty-sdk exports a cli command called 'twenty' (like
twenty-cli before)
- deprecates twenty-cli
- simplify app init command base-project
- use `twenty-sdk:0.1.0` in base project
- move the "twenty-sdk/application" barrel to "twenty-sdk"
- add `create-twenty-app` package

<img width="1512" height="919" alt="image"
src="https://github.com/user-attachments/assets/007bef45-4e71-419a-9213-cebed376adbf"
/>

<img width="1506" height="929" alt="image"
src="https://github.com/user-attachments/assets/3de2fec6-1624-4923-ae13-f4e1cf165eb5"
/>
2025-12-01 11:44:35 +01:00
..

Deprecated: twenty-cli

This package is deprecated. Please install and use twenty-sdk instead:

npm uninstall twenty-cli
npm install -g twenty-sdk

The command name remains the same: twenty.

A command-line interface to easily scaffold, develop, and publish applications that extend Twenty CRM (now provided by twenty-sdk).

Requirements

  • yarn >= 4.9.2
  • an apiKey. Go to https://twenty.com/settings/api-webhooks to generate one

Quick example project

# Authenticate using your apiKey (CLI will prompt for your <apiKey>)
twenty auth login

# Init a new application called hello-world
twenty app init hello-world

# Go to your app
cd hello-world

# Add a serverless function to your application
twenty app add serverlessFunction

# Add a trigger to your serverless function
twenty app add trigger

# Add axios to your application
yarn add axios

# Start dev mode: automatically syncs changes to your Twenty workspace, so you can test new functions/objects instantly.
twenty app dev

# Or use one time sync (also generates SDK automatically)
twenty app sync

# List all available commands
twenty help

Application Structure

Each application in this package follows the standard application structure:

app-name/
├── package.json
├── README.md
├── serverlessFunctions  # Custom backend logic (runs on demand)
└── ...

Publish your application

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

You can share your application with all twenty users.

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

# create a new branch
git checkout -b feature/my-awesome-app
git commit -m "Add new application"
git push

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

Contributing