Începeți

• Definiți obiecte și câmpuri personalizate sub formă de cod (model de date gestionat)
• Construiți funcții logice cu declanșatoare personalizate (rute HTTP, cron, evenimente ale bazei de date)
• Definiți abilități pentru agenți de IA
• Construiți componente front-end care se afișează în interfața Twenty
• Implementați aceeași aplicație în mai multe spații de lucru

​

Cerințe

• Node.js 24+ și Yarn 4
• Un spațiu de lucru Twenty și o cheie API (creați una la https://app.twenty.com/settings/api-webhooks)

​

Începeți

# 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

​

Structura proiectului (generată)

• Copiază o aplicație de bază minimală în my-twenty-app/
• Adaugă o dependență locală twenty-sdk și configurația Yarn 4
• Creează fișiere de configurare și scripturi conectate la CLI-ul twenty
• Generează fișierele de bază (configurația aplicației, rolul implicit al funcțiilor, funcțiile de pre-instalare și post-instalare) plus fișiere de exemplu în funcție de modul de generare a scheletului.

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: Declară numele aplicației, versiunea, motoarele (Node 24+, Yarn 4) și adaugă twenty-sdk plus un script twenty care deleagă către CLI-ul local twenty. Rulați yarn twenty help pentru a lista toate comenzile disponibile.
• .gitignore: Ignoră artefacte comune precum node_modules, .yarn, generated/ (client tipizat), dist/, build/, foldere de coverage, fișiere jurnal și fișiere .env*.
• yarn.lock, .yarnrc.yml, .yarn/: Blochează și configurează lanțul de instrumente Yarn 4 folosit de proiect.
• .nvmrc: Fixează versiunea Node.js așteptată de proiect.
• .oxlintrc.json și tsconfig.json: Oferă linting și configurație TypeScript pentru fișierele TypeScript ale aplicației.
• README.md: Un README scurt în rădăcina aplicației, cu instrucțiuni de bază.
• public/: Un folder pentru stocarea resurselor publice (imagini, fonturi, fișiere statice) care vor fi servite împreună cu aplicația dvs. Fișierele plasate aici sunt încărcate în timpul sincronizării și sunt accesibile la rulare.
• src/: Locul principal unde vă definiți aplicația sub formă de cod

​

Detectarea entităților

// 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 va genera automat doi clienți API tipizați în node_modules/twenty-sdk/generated: CoreApiClient (pentru datele spațiului de lucru prin /graphql) și MetadataApiClient (pentru configurarea spațiului de lucru și încărcarea fișierelor prin /metadata).
• yarn twenty entity:add va adăuga fișiere de definire a entităților în src/ pentru obiectele, funcțiile, componentele front-end, rolurile, abilitățile și altele.

​

Autentificare

• URL-ul API (implicit http://localhost:3000 sau profilul spațiului de lucru curent)
• Cheie API

​

Gestionarea spațiilor de lucru

# 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

​

Configurare manuală (fără generator)

yarn add -D twenty-sdk

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

​

Depanare

• Erori de autentificare: rulați yarn twenty auth:login și asigurați-vă că cheia API are permisiunile necesare.
• Nu se poate conecta la server: verificați URL-ul API și că serverul Twenty este accesibil.
• Tipuri sau client lipsă/învechite: reporniți yarn twenty app:dev — acesta generează automat clientul tipizat.
• Modul dev nu sincronizează: asigurați-vă că yarn twenty app:dev rulează și că modificările nu sunt ignorate de mediul dvs.