Salt la conținutul principal

Rularea CLI-ului

CLI-ul twenty se conectează la spațiile de lucru Twenty din terminalul dvs. Folosiți-l pentru a inspecta metadatele, a citi înregistrări, a trimite solicitări API și a crea, sincroniza și depana aplicații. CLI-ul însuși necesită Node.js 24.5+. Dezvoltarea aplicațiilor necesită, de asemenea, o versiune Node acceptată de SDK-ul instalat; consultați Pornire rapidă. Rulați orice comandă prin npx, fără o instalare globală:
Sau instalați-l o singură dată la nivel global și apelați twenty direct:
Exemplele de mai jos folosesc twenty. Înlocuiți twenty cu npx twenty@latest dacă nu l-ați instalat global. Rulați twenty commands pentru lista completă de comenzi și twenty \<command> --help pentru opțiunile unei comenzi. Fiecare comandă care comunică cu un spațiu de lucru acceptă --remote \<name> pentru a viza o conexiune salvată alta decât cea implicită și --json pentru ieșire structurată.

Conectarea la un spațiu de lucru

Autentificați-vă cu browserul. --use face din această conexiune conexiunea implicită:
Utilizați adresa spațiului dvs. de lucru sau adresa serverului pentru o configurare locală: http://localhost:2020 pentru mediul de dezvoltare local, http://localhost:3000 pentru o copie locală a codului sursă. Puteți copia comanda exactă din Settings > Developers > CLI. Autentificarea prin browser necesită Twenty 2.42 sau o versiune ulterioară. Păstrați mai multe conexiuni denumindu-le:
În CI sau scripturi, redirecționați o cheie API în loc să vă autentificați cu browserul:
De asemenea, puteți seta TWENTY_API_URL și TWENTY_API_KEY pentru o singură rulare fără a salva nimic. Conexiunile salvate se află în ~/.twenty/config.json. Comenzile selectează un spațiu de lucru în această ordine:
  1. Un --remote \<name> explicit, care suprascrie variabilele de mediu țintă.
  2. TWENTY_REMOTE sau perechea TWENTY_API_URL și TWENTY_API_KEY. Nu combinați aceste două metode.
  3. Remote-ul implicit salvat.
auth login --name \<name> salvează o conexiune, dar păstrează un remote implicit existent. Adăugați --use sau rulați twenty remote use \<name> pentru a schimba remote-ul implicit.

Explorarea datelor

Numele obiectelor sunt nume API exacte, la singular sau plural (company sau companies). Scrierile API brute se execută fără un pas de confirmare, iar permisiunile din spațiul de lucru se aplică în continuare.

Construirea unei aplicații

  • app init scrie un proiect nou din șablon. Nu instalează dependențe și nu contactează un spațiu de lucru.
  • app apply --create compilează aplicația, o înregistrează în spațiul de lucru, o instalează și îi sincronizează metadatele.
  • app dev monitorizează sursa și sincronizează fiecare compilare reușită.
Alte comenzi pentru aplicații: Definițiile care lipsesc din sursă sunt șterse implicit din spațiul de lucru. Transmiteți --no-prune pentru a le păstra. Aplicația Personalizată pentru spațiul de lucru le păstrează dacă nu transmiteți --prune. Ștergerea obiectelor sau a câmpurilor șterge și datele acestora, deci necesită confirmare. Consultați Sincronizare și recuperare pentru detalii.

Executarea funcțiilor

Rulați o funcție logică implementată fără a o declanșa printr-o rută, un cron sau un eveniment de bază de date. Sincronizați mai întâi modificările locale cu app apply sau app dev.
Executarea funcțiilor necesită autentificare prin browser. Cheile API nu le pot executa.

Monitorizarea jurnalelor funcțiilor

Transmiteți în flux ieșirea funcțiilor logice ale aplicației pe măsură ce execuțiile se finalizează:
Afișează doar execuțiile noi, nu și pe cele anterioare.

Dezinstalarea unei aplicații

Aceasta execută cârligul de dezinstalare al aplicației și șterge tot ce îi aparține, inclusiv obiectele, câmpurile și datele lor. Aplicația rămâne înregistrată, astfel încât twenty app apply o poate instala din nou.

Diagnosticarea problemelor

doctor verifică versiunea Node, ce binar twenty se află în PATH, conexiunile salvate și SDK-ul aplicației, apoi raportează ce trebuie remediat.

Scripturi și teste

Rezultatul compilării aparține CLI-ului. Nu citiți .twenty/output/manifest.json și nu importați cod intern de compilare; citiți data.manifest din twenty app build --json.

Referință completă

Referința comenzilor acoperă fiecare opțiune, permisiune, format de ieșire și cod de ieșire.