CLI

yarn twenty Befehle zum Ausführen von Funktionen, Streamen von Logs, Verwalten von App-Installationen und Wechseln von Remotes.

Die yarn twenty CLI ist Ihre Schnittstelle für alles, was mit der App zu tun hat. Vollständige Befehlsliste:

Befehl	Was es tut	Dokumentiert in
dev	Überwacht Ihre Quelldateien und synchronisiert Änderungen in Echtzeit	Schnellstart
plan	Metadatenänderungen anzeigen, ohne sie anzuwenden	Synchronisierung & Wiederherstellung
apply	Metadatenänderungen anwenden, nachdem der Plan angezeigt wurde	Synchronisierung & Wiederherstellung
dev:build	Die App kompilieren und den API-Client generieren (--tarball, um ein .tgz zu packen)	Veröffentlichen
dev:typecheck	TypeScript-Typprüfung ausführen	Tests
dev:add	Ein Gerüst für eine neue Entität erstellen	Gerüste
dev:generate-client	Den typisierten API-Client erneut generieren	diese Seite
dev:function:exec / dev:function:logs	Funktionen ausführen und ihre Protokolle streamen	diese Seite
dev:translations-extract	Übersetzbare Zeichenketten in locales/-Kataloge extrahieren	Übersetzungen
dev:catalog-sync	Eine Synchronisierung des Marktplatzkatalogs auslösen	Veröffentlichen
app:publish / app:install / app:uninstall	Release-Lebenszyklus	Veröffentlichen und diese Seite
docker:*	Den lokalen Twenty-Server-Container verwalten	Lokaler Server
remote:*	Serververbindungen verwalten	diese Seite

Jeder Befehl akzeptiert -r, --remote \<name>, um ein bestimmtes Remote statt des Standard-Remotes anzusteuern.

​

Funktionen ausführen (yarn twenty dev:function:exec)

Eine Logikfunktion manuell ausführen, ohne sie über HTTP, Cron oder ein Datenbankereignis auszulösen:

# Execute by function name
yarn twenty dev:function:exec -n create-new-post-card

# Execute by universalIdentifier
yarn twenty dev:function:exec -u e56d363b-0bdc-4d8a-a393-6f0d1c75bdcf

# Pass a JSON payload
yarn twenty dev:function:exec -n create-new-post-card -p '{"name": "Hello"}'

# Execute the install and uninstall hooks
yarn twenty dev:function:exec --postInstall
yarn twenty dev:function:exec --preInstall
yarn twenty dev:function:exec --uninstall

​

Funktionsprotokolle ansehen (yarn twenty dev:function:logs)

Ausführungsprotokolle für die Logikfunktionen Ihrer App streamen:

# Stream all function logs
yarn twenty dev:function:logs

# Filter by function name
yarn twenty dev:function:logs -n create-new-post-card

# Filter by universalIdentifier
yarn twenty dev:function:logs -u e56d363b-0bdc-4d8a-a393-6f0d1c75bdcf

Dies unterscheidet sich von yarn twenty docker:logs, das die Docker-Container-Logs anzeigt. yarn twenty dev:function:logs zeigt die Funktionsausführungsprotokolle Ihrer App vom Twenty-Server.

​

Generieren des typisierten Clients (yarn twenty dev:generate-client)

Generieren Sie den typisierten API-Client (twenty-client-sdk) erneut aus dem Schema des aktiven Remotes, ohne eine App zu erstellen oder zu synchronisieren. Verwenden Sie ihn, um in jedem Projekt einen typisierten Client zu erhalten – zum Beispiel für einen Backend-Dienst in einem separaten Repository –, der mit Ihrer Twenty-Instanz kommuniziert:

# In your project (no Twenty app definition required)
yarn add twenty-sdk twenty-client-sdk

# Connect to the Twenty instance to generate the client from
yarn twenty remote:add

# Generate the typed client into node_modules/twenty-client-sdk
yarn twenty dev:generate-client

Importieren Sie dann den Client in Ihrem Code:

import { CoreApiClient } from 'twenty-client-sdk/core';

Führen Sie den Befehl erneut aus, wann immer sich Ihr Datenmodell ändert, um die generierten Typen zu aktualisieren.

Der Client wird in node_modules generiert, daher wird er nicht zusammen mit Ihrem Code eingecheckt. Führen Sie yarn twenty dev:generate-client nach jeder Installation aus (zum Beispiel in einem postinstall-Skript oder in CI).

​

Eine App deinstallieren (yarn twenty app:uninstall)

Entfernen Sie Ihre App aus dem aktiven Arbeitsbereich:

yarn twenty app:uninstall

# Skip the confirmation prompt
yarn twenty app:uninstall --yes

​

Remotes verwalten

Ein Remote ist ein Twenty-Server, mit dem sich Ihre App verbindet. Während der Einrichtung erstellt das Scaffolding-Tool automatisch eines für Sie. Sie können jederzeit weitere Remotes hinzufügen oder zwischen ihnen wechseln.

# Add a new remote (opens a browser for OAuth login)
yarn twenty remote:add

# Connect to a local Twenty server (auto-detects port 2020 or 3000)
yarn twenty remote:add --local

# Add a remote non-interactively (useful for CI)
yarn twenty remote:add --url https://your-twenty-server.com --api-key $TWENTY_API_KEY --as my-remote

# List all configured remotes
yarn twenty remote:list

# Set the active remote
yarn twenty remote:use <name>

# Check that the active remote's authentication is still valid
yarn twenty remote:status

# Remove a remote
yarn twenty remote:remove <name>

Ihre Anmeldedaten werden in ~/.twenty/config.json gespeichert.