CLI

Interfața CLI yarn twenty este punctul tău de acces pentru tot ce ține de aplicație. Lista completă de comenzi:

Comandă	Ce face	Documentat în
`dev`	Monitorizează fișierele sursă și sincronizează în timp real modificările	Ghid de pornire rapidă
`plan`	Previzualizează modificările metadatelor fără a le aplica	Sincronizare și recuperare
`aplică`	Aplică modificările metadatelor după afișarea planului	Sincronizare și recuperare
`dev:build`	Compilează aplicația și generează clientul API (`--tarball` pentru a împacheta un `.tgz`)	Publicare
`dev:typecheck`	Rulează verificarea tipurilor TypeScript	Testare
`dev:add`	Creează scheletul unei entități noi	Generarea scheletului
`dev:generate-client`	Regenerează clientul API tipizat	această pagină
`dev:function:exec` / `dev:function:logs`	Execută funcții și transmite în flux jurnalele acestora	această pagină
`dev:translations-extract`	Extrage șirurile traducibile în cataloagele din `locales/`	Traduceri
`dev:catalog-sync`	Declanșează o sincronizare a catalogului marketplace-ului	Publicare
`app:publish` / `app:install` / `app:uninstall`	Ciclul de viață al lansărilor	Publicare și această pagină
`docker:*`	Administrează containerul serverului Twenty local	Server local
`remote:*`	Administrează conexiunile la server	această pagină

Fiecare comandă acceptă -r, --remote \<name> pentru a viza un anumit server la distanță în locul celui implicit.

Executarea funcțiilor (`yarn twenty dev:function:exec`)

Rulați manual o funcție logică fără a o declanșa prin HTTP, cron sau eveniment de bază de date:

# 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

Vizualizarea jurnalelor funcțiilor (`yarn twenty dev:function:logs`)

Transmiteți în flux jurnalele de execuție pentru funcțiile logice ale aplicației:

# 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

Acest lucru este diferit de yarn twenty docker:logs, care afișează jurnalele containerului Docker. yarn twenty dev:function:logs afișează jurnalele de execuție ale funcțiilor aplicației de pe serverul Twenty.

Generarea clientului tipizat (`yarn twenty dev:generate-client`)

Regenerați clientul tipizat al API-ului (twenty-client-sdk) din schema remote-ului activ, fără a construi sau sincroniza o aplicație. Folosiți-l pentru a obține un client tipizat în orice proiect — cum ar fi un serviciu backend aflat într-un repository separat — care comunică cu instanța dvs. Twenty:

# 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

Apoi importați clientul în codul dvs.:

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

Rulați din nou comanda ori de câte ori se schimbă modelul de date pentru a reîmprospăta tipurile generate.

Clientul este generat în interiorul node_modules, astfel încât nu este inclus în commit împreună cu codul dvs. Rulați yarn twenty dev:generate-client după fiecare instalare (de exemplu, într-un script postinstall sau în CI).

Dezinstalarea unei aplicații (`yarn twenty app:uninstall`)

Eliminați aplicația din spațiul de lucru activ:

yarn twenty app:uninstall

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

Gestionarea remote-urilor

Un „remote” este un server Twenty la care se conectează aplicația. În timpul configurării, Scaffolderul creează automat unul pentru dvs. Puteți adăuga mai multe remote-uri sau comuta între ele oricând.

# 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>

Acreditările dvs. sunt stocate în ~/.twenty/config.json.

Prezentare generală

Aplicații

API

Autogazda

Contribuie

Executarea funcțiilor (`yarn twenty dev:function:exec`)

Vizualizarea jurnalelor funcțiilor (`yarn twenty dev:function:logs`)

Generarea clientului tipizat (`yarn twenty dev:generate-client`)

Dezinstalarea unei aplicații (`yarn twenty app:uninstall`)

Gestionarea remote-urilor

​Executarea funcțiilor (yarn twenty dev:function:exec)

​Vizualizarea jurnalelor funcțiilor (yarn twenty dev:function:logs)

​Generarea clientului tipizat (yarn twenty dev:generate-client)

​Dezinstalarea unei aplicații (yarn twenty app:uninstall)

​Gestionarea remote-urilor

Executarea funcțiilor (`yarn twenty dev:function:exec`)

Vizualizarea jurnalelor funcțiilor (`yarn twenty dev:function:logs`)

Generarea clientului tipizat (`yarn twenty dev:generate-client`)

Dezinstalarea unei aplicații (`yarn twenty app:uninstall`)

Gestionarea remote-urilor