Başlarken

• Özel nesneleri ve alanları kod olarak tanımlayın (yönetilen veri modeli)
• Özel tetikleyicilerle mantık işlevleri oluşturun (HTTP routes, cron, database events)
• Yapay zekâ ajanları için becerileri tanımlayın
• Twenty’nin UI’si içinde görüntülenen ön bileşenler oluşturun
• Aynı uygulamayı birden çok çalışma alanına dağıtın

​

Ön Gereksinimler

• Node.js 24+ ve Yarn 4
• Bir Twenty çalışma alanı ve bir API anahtarı (https://app.twenty.com/settings/api-webhooks adresinde oluşturun)

​

Başlarken

# Scaffold a new app (includes all examples by default)
npx create-twenty-app@latest my-twenty-app
cd my-twenty-app

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

# Default (exhaustive): all examples (object, field, logic function, front component, view, navigation menu item, skill)
npx create-twenty-app@latest my-app

# Minimal: only core files (application-config.ts and default-role.ts)
npx create-twenty-app@latest my-app --minimal

# Add a new entity to your application (guided)
yarn twenty entity:add

# Watch your application's function logs
yarn twenty function:logs

# Execute a function by name
yarn twenty function:execute -n my-function -p '{"name": "test"}'

# Execute the pre-install function
yarn twenty function:execute --preInstall

# Execute the post-install function
yarn twenty function:execute --postInstall

# Uninstall the application from the current workspace
yarn twenty app:uninstall

# Display commands' help
yarn twenty help

​

Proje yapısı (şablondan oluşturulmuş)

• Minimal bir temel uygulamayı my-twenty-app/ içine kopyalar
• Yerel bir twenty-sdk bağımlılığı ve Yarn 4 yapılandırması ekler
• twenty CLI ile bağlantılı yapılandırma dosyaları ve betikler oluşturur
• İskelet oluşturma moduna bağlı olarak çekirdek dosyaları (uygulama yapılandırması, varsayılan işlev rolü, kurulum öncesi ve kurulum sonrası işlevler) ile örnek dosyaları üretir

my-twenty-app/
  package.json
  yarn.lock
  .gitignore
  .nvmrc
  .yarnrc.yml
  .yarn/
    install-state.gz
  .oxlintrc.json
  tsconfig.json
  README.md
  public/                           # Public assets folder (images, fonts, etc.)
  src/
  ├── application-config.ts           # Required - main application configuration
  ├── roles/
  │   └── default-role.ts               # Default role for logic functions
  ├── objects/
  │   └── example-object.ts             # Example custom object definition
  ├── fields/
  │   └── example-field.ts              # Example standalone field definition
  ├── logic-functions/
  │   ├── hello-world.ts                # Example logic function
  │   ├── pre-install.ts                # Pre-install logic function
  │   └── post-install.ts               # Post-install logic function
  ├── front-components/
  │   └── hello-world.tsx               # Example front component
  ├── views/
  │   └── example-view.ts                # Example saved view definition
  ├── navigation-menu-items/
  │   └── example-navigation-menu-item.ts # Example sidebar navigation link
  └── skills/
      └── example-skill.ts                # Example AI agent skill definition

• package.json: Uygulama adını, sürümünü, motorları (Node 24+, Yarn 4) bildirir ve twenty-sdk ile yerel twenty CLI’sine yetki devreden bir twenty betiği ekler. Tüm mevcut komutları listelemek için yarn twenty help komutunu çalıştırın.
• .gitignore: node_modules, .yarn, generated/ (türlendirilmiş istemci), dist/, build/, kapsam klasörleri, günlük dosyaları ve .env* dosyaları gibi yaygın artifaktları yok sayar.
• yarn.lock, .yarnrc.yml, .yarn/: Proje tarafından kullanılan Yarn 4 araç zincirini kilitler ve yapılandırır.
• .nvmrc: Projenin beklediği Node.js sürümünü sabitler.
• .oxlintrc.json ve tsconfig.json: Uygulamanızın TypeScript kaynakları için linting ve TypeScript yapılandırması sağlar.
• README.md: Uygulama kökünde temel talimatların yer aldığı kısa bir README.
• public/: Uygulamanızla birlikte sunulacak genel varlıkları (görseller, yazı tipleri, statik dosyalar) depolamak için bir klasör. Buraya yerleştirilen dosyalar senkronizasyon sırasında yüklenir ve çalışma zamanında erişilebilir olur.
• src/: Uygulamanızı kod olarak tanımladığınız ana yer

​

Varlık algılama

// This file can be named anything and placed anywhere in src/
import { defineObject, FieldType } from 'twenty-sdk';

export default defineObject({
  universalIdentifier: '...',
  nameSingular: 'postCard',
  // ... rest of config
});

• yarn twenty app:dev, node_modules/twenty-sdk/generated içinde iki tiplendirilmiş API istemcisini otomatik olarak oluşturur: CoreApiClient (/graphql üzerinden çalışma alanı verileri için) ve MetadataApiClient (çalışma alanı yapılandırması ve /metadata üzerinden dosya yüklemeleri için).
• yarn twenty entity:add, özel nesneleriniz, fonksiyonlarınız, ön bileşenleriniz, rolleriniz, yetenekleriniz ve daha fazlası için src/ altında varlık tanım dosyaları ekler.

​

Kimlik Doğrulama

• API URL’si (varsayılan: http://localhost:3000 veya mevcut çalışma alanı profiliniz)
• API anahtarı

​

Çalışma alanlarını yönetme

# Login interactively (recommended)
yarn twenty auth:login

# Login to a specific workspace profile
yarn twenty auth:login --workspace my-custom-workspace

# List all configured workspaces
yarn twenty auth:list

# Switch the default workspace (interactive)
yarn twenty auth:switch

# Switch to a specific workspace
yarn twenty auth:switch production

# Check current authentication status
yarn twenty auth:status

​

Manuel kurulum (iskelet oluşturucu olmadan)

yarn add -D twenty-sdk

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

​

Sorun Giderme

• Kimlik doğrulama hataları: yarn twenty auth:login çalıştırın ve API anahtarınızın gerekli izinlere sahip olduğundan emin olun.
• Sunucuya bağlanılamıyor: API URL’sini ve Twenty sunucusunun erişilebilir olduğunu doğrulayın.
• Türler veya istemci eksik/eski: yarn twenty app:dev komutunu yeniden çalıştırın — tiplendirilmiş istemciyi otomatik olarak oluşturur.
• Geliştirme modu eşitlenmiyor: yarn twenty app:dev’in çalıştığından ve değişikliklerin ortamınız tarafından yok sayılmadığından emin olun.