Zum Hauptinhalt springen

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.

Anstatt Entitätsdateien manuell zu erstellen, können Sie den interaktiven Scaffolder verwenden: 
yarn twenty add
Er fordert Sie auf, einen Entitätstyp auszuwählen, führt Sie durch die erforderlichen Felder und schreibt anschließend eine einsatzbereite Datei mit einem stabilen universalIdentifier und dem korrekten defineEntity()-Aufruf. Sie können den Entitätstyp auch direkt übergeben, um die erste Eingabeaufforderung zu überspringen: 
yarn twenty add object
yarn twenty add logicFunction
yarn twenty add frontComponent

​
Verfügbare Entitätstypen

EntitätstypBefehlGenerierte Datei
Objektyarn twenty add objectsrc/objects/\<name>.ts
Feldyarn twenty add fieldsrc/fields/\<name>.ts
Logikfunktionyarn twenty add logicFunctionsrc/logic-functions/\<name>.ts
Frontend-Komponenteyarn twenty add frontComponentsrc/front-components/\<name>.tsx
Rolleyarn twenty add rolesrc/roles/\<name>.ts
Skillyarn twenty add skillsrc/skills/\<name>.ts
Agentyarn twenty add agentsrc/agents/\<name>.ts
Ansichtyarn twenty add viewsrc/views/\<name>.ts
Navigationsmenüeintragyarn twenty add navigationMenuItemsrc/navigation-menu-items/\<name>.ts
Seitenlayoutyarn twenty add pageLayoutsrc/page-layouts/\<name>.ts

​
Was der Scaffolder generiert

Jeder Entitätstyp hat seine eigene Vorlage. Zum Beispiel fragt yarn twenty add object nach:
  1. Name (Singular) — z. B. invoice
  2. Name (Plural) — z. B. invoices
  3. Label (Singular) — automatisch aus dem Namen befüllt (z. B. Invoice)
  4. Label (Plural) — automatisch befüllt (z. B. Invoices)
  5. Ansicht und Navigationseintrag erstellen? — wenn Sie mit Ja antworten, erzeugt der Scaffolder außerdem eine passende Ansicht und einen Sidebar-Link für das neue Objekt.
Andere Entitätstypen haben einfachere Eingabeaufforderungen — die meisten fragen nur nach einem Namen. Der Entitätstyp field ist detaillierter: Er fragt nach Feldname, Label, Typ (aus einer Liste aller verfügbaren Feldtypen wie TEXT, NUMBER, SELECT, RELATION usw.) sowie dem universalIdentifier des Zielobjekts.

​
Benutzerdefinierter Ausgabepfad

Verwenden Sie den Schalter --path, um die generierte Datei an einem benutzerdefinierten Ort abzulegen: 
yarn twenty add logicFunction --path src/custom-folder