upstream-twenty/packages/twenty-sdk/README.md

Twenty SDK

A CLI and SDK to develop, build, and publish applications that extend Twenty CRM.

Quick start

The recommended way to start is with create-twenty-app:

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

Documentation

Full documentation is available at docs.twenty.com/developers/extend/apps:

• Getting Started — scaffolding, local server, authentication, dev mode
• Building Apps — entity definitions, API clients, testing, CLI reference
• Publishing — deploy, npm publish, marketplace

Guides in this repository:

• Logic function inputs — input schema inference, record-typed inputs, and the id contract

Manual installation

If you are adding twenty-sdk to an existing project instead of using create-twenty-app:

yarn add twenty-sdk twenty-client-sdk

Then add a twenty script to your package.json:

{
  "scripts": {
    "twenty": "twenty"
  }
}

Run yarn twenty help to see all available commands.

Configuration

The CLI stores credentials per remote in ~/.twenty/config.json. Run yarn twenty remote:add to configure a remote, or yarn twenty remote:list to see existing ones.

Troubleshooting

• Auth errors: run yarn twenty remote:add to re-authenticate.
• Typings out of date: restart yarn twenty dev to refresh the client and types.
• Not seeing changes in dev: make sure dev mode is running (yarn twenty dev).

Contributing

Development setup

git clone https://github.com/twentyhq/twenty.git
cd twenty
yarn install

Development mode

npx nx run twenty-sdk:dev

Production build

npx nx run twenty-sdk:build

Running the CLI locally

npx nx run twenty-sdk:start -- <command>

Resources

• See our GitHub
• Join our Discord