Skip to content

The open alternative to Salesforce, designed for AI.

1.9 KB
Raw Blame
Twenty logo

Twenty SDK

NPM version License Join the community on Discord

The application authoring and runtime SDK for Twenty CRM.

Use twenty-sdk/define to declare app entities, twenty-sdk/front-component for UI helpers, and twenty-sdk/logic-function for server-side helpers. The SDK also provides billing, utils, and renderer integration exports.

Quick start

Install the standalone CLI separately from your app's SDK:

npm install -g twenty
twenty app init my-twenty-app
cd my-twenty-app
yarn install
twenty auth login --url https://your-workspace.twenty.com
twenty app dev --create

Keep twenty-sdk installed in each app. The global twenty package owns scaffolding, builds, authentication, sync, and publishing.

Documentation

Contributing

yarn install
npx nx build twenty-sdk
npx nx run twenty-sdk:test:unit

To work on CLI behavior, use packages/twenty-cli and npx nx build twenty-cli.