Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.twenty.com/llms.txt

Use this file to discover all available pages before exploring further.

Instead of creating entity files by hand, use the interactive scaffolder: 
yarn twenty add
It prompts you to pick an entity type and walks you through the required fields, then writes a ready-to-use file with a stable universalIdentifier and the correct defineEntity() call. You can also pass the entity type directly to skip the first prompt: 
yarn twenty add object
yarn twenty add logicFunction
yarn twenty add frontComponent

​
Available entity types

Entity typeCommandGenerated file
Objectyarn twenty add objectsrc/objects/\<name>.ts
Fieldyarn twenty add fieldsrc/fields/\<name>.ts
Logic functionyarn twenty add logicFunctionsrc/logic-functions/\<name>.ts
Front componentyarn twenty add frontComponentsrc/front-components/\<name>.tsx
Roleyarn twenty add rolesrc/roles/\<name>.ts
Skillyarn twenty add skillsrc/skills/\<name>.ts
Agentyarn twenty add agentsrc/agents/\<name>.ts
Viewyarn twenty add viewsrc/views/\<name>.ts
Navigation menu itemyarn twenty add navigationMenuItemsrc/navigation-menu-items/\<name>.ts
Page layoutyarn twenty add pageLayoutsrc/page-layouts/\<name>.ts

​
What the scaffolder generates

Each entity type has its own template. For example, yarn twenty add object asks for:
  1. Name (singular) — e.g., invoice
  2. Name (plural) — e.g., invoices
  3. Label (singular) — auto-populated from the name (e.g., Invoice)
  4. Label (plural) — auto-populated (e.g., Invoices)
  5. Create a view and navigation item? — if you answer yes, the scaffolder also generates a matching view and sidebar link for the new object.
Other entity types have simpler prompts — most only ask for a name. The field entity type is more detailed: it asks for the field name, label, type (from a list of all available field types like TEXT, NUMBER, SELECT, RELATION, etc.), and the target object’s universalIdentifier.

​
Custom output path

Use the --path flag to place the generated file in a custom location: 
yarn twenty add logicFunction --path src/custom-folder