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.
Panoramica
Una volta che la tua app è stata compilata e testata localmente, hai due modalità per distribuirla:- Distribuisci un tarball — carica la tua app direttamente su un server Twenty specifico per uso interno o privato.
- Pubblica su npm — elenca la tua app nel marketplace di Twenty affinché qualsiasi spazio di lavoro possa scoprirla e installarla.
Compilazione della tua app
Esegui il comando di build per compilare la tua app e generare unmanifest.json pronto per la distribuzione:
.twenty/output/. Aggiungi --tarball per produrre anche un pacchetto .tgz per la distribuzione manuale o il comando di deploy.
Distribuzione su un server (tarball)
Per le app che non vuoi rendere pubbliche — strumenti proprietari, integrazioni solo aziendali o build sperimentali — puoi distribuire un tarball direttamente su un server Twenty.Prerequisiti
Prima della distribuzione, ti serve un remote configurato che punti al server di destinazione. I remote memorizzano localmente l’URL del server e le credenziali di autenticazione in~/.twenty/config.json.
Aggiungi un remote:
Distribuzione
Compila e carica la tua app sul server in un solo passaggio:Condivisione di un’app distribuita
Le app in formato tarball non sono elencate nel marketplace pubblico, quindi altri spazi di lavoro sullo stesso server non le troveranno navigando. Una volta che il tuo spazio di lavoro è sul piano Enterprise, puoi condividere un’app distribuita in questo modo:- Vai su Impostazioni > Applicazioni > Registrazioni e apri la tua app
- Nella scheda Distribuzione, fai clic su Copia link di condivisione
- Condividi questo link con utenti su altri spazi di lavoro — li porterà direttamente alla pagina di installazione dell’app
Gestione delle versioni
Quando si aggiorna un’app in formato tarball già distribuita, il server richiede che laversion in package.json sia strettamente superiore (per l’ordinamento semver) rispetto alla versione attualmente distribuita. Eseguire nuovamente il deploy della stessa versione, o pubblicarne una inferiore, viene rifiutato prima che il tarball venga archiviato — vedrai un errore VERSION_ALREADY_EXISTS nella CLI.
Per rilasciare un aggiornamento:
- Incrementa il campo
versionnel tuopackage.json(ad es.1.2.3→1.2.4,1.3.0o2.0.0). - Esegui
yarn twenty deploy(oppureyarn twenty deploy --remote production) - Gli spazi di lavoro che hanno l’app installata vedranno l’aggiornamento disponibile nelle proprie impostazioni
I tag di pre-release funzionano come previsto: incrementare
1.0.0-rc.1 → 1.0.0-rc.2 è consentito e una release finale come 1.0.0 viene correttamente riconosciuta come superiore a 1.0.0-rc.5. La versione in package.json deve essere essa stessa una stringa semver valida.CI/CD automatizzati (workflow preconfigurati)
Le app generate concreate-twenty-app includono due workflow di GitHub Actions pronti all’uso, nella cartella .github/workflows/. Sono pronti all’esecuzione non appena esegui il push del repository su GitHub — non è necessaria alcuna configurazione aggiuntiva per la CI e la CD richiede solo un singolo secret.
CI — ci.yml
Esegue automaticamente i test di integrazione a ogni push su main e sulle pull request.
Cosa fa:
- Esegue il checkout del codice sorgente della tua app.
- Avvia un’istanza di test isolata di Twenty utilizzando l’azione composita
twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main(l’equivalente per la CI diyarn twenty server start --test). - Abilita Corepack, configura Node.js dal tuo
.nvmrce installa le dipendenze conyarn install --immutable. - Esegue
yarn test, passandoTWENTY_API_URLeTWENTY_API_KEYdall’istanza avviata affinché i tuoi test possano comunicare con un server reale.
TWENTY_VERSION(variabile di ambiente, predefinitolatest) — fissa la versione del server Twenty usata nella CI modificando questo valore inci.yml.- La concorrenza è raggruppata per
github.refe annulla le esecuzioni in corso in caso di nuovi push.
CD — cd.yml
Esegue il deploy della tua app su un server Twenty configurato a ogni push su main e, facoltativamente, da una pull request quando viene applicata l’etichetta deploy.
Cosa fa:
- Esegue il checkout della testa della PR (per le PR etichettate) oppure del commit inviato.
- Esegue
twentyhq/twenty/.github/actions/deploy-twenty-app@main— l’equivalente per la CI diyarn twenty deploy. - Esegue
twentyhq/twenty/.github/actions/install-twenty-app@mainin modo che la versione appena distribuita venga installata nello spazio di lavoro di destinazione.
| Impostazione | Dove | Scopo |
|---|---|---|
TWENTY_DEPLOY_URL | env in cd.yml (predefinito http://localhost:3000) | Il server Twenty su cui effettuare il deploy. Modificalo con l’URL reale del tuo server prima del primo utilizzo. |
TWENTY_DEPLOY_API_KEY | Repository GitHub Settings → Secrets and variables → Actions | Chiave API con autorizzazione di deploy sul server di destinazione. |
Il valore predefinito di
TWENTY_DEPLOY_URL, http://localhost:3000, è un segnaposto — non raggiungerà alcuna risorsa da un runner ospitato su GitHub. Aggiornalo all’URL pubblico del tuo server (oppure usa un runner self-hosted con accesso di rete) prima di abilitare il CD.deploy a una pull request. La condizione if: in cd.yml eseguirà il job per quella PR utilizzando il commit di testa della PR, permettendoti di convalidare una modifica sul server di destinazione prima del merge.
Bloccare le azioni riutilizzabili
Entrambi i workflow fanno riferimento ad azioni riutilizzabili a@main, quindi gli aggiornamenti delle azioni nel repository twentyhq/twenty vengono recepiti automaticamente. Se desideri build deterministiche, sostituisci @main con uno SHA di commit o un tag di release in ciascuna riga uses:.
Pubblicazione su npm
La pubblicazione su npm rende la tua app scopribile nel marketplace di Twenty. Qualsiasi spazio di lavoro Twenty può sfogliare, installare e aggiornare le app del marketplace direttamente dall’interfaccia utente.Requisiti
- Un account npm
- La parola chiave
twenty-appnell’arraykeywordsdel tuopackage.json(aggiungila manualmente — non è inclusa per impostazione predefinita nel templatecreate-twenty-app)
Metadati del marketplace
La configurazionedefineApplication() supporta campi opzionali che controllano come la tua app appare nel marketplace. Usa logoUrl e screenshots per fare riferimento alle immagini nella cartella public/:
src/application-config.ts
author, category, aboutDescription, websiteUrl, termsUrl, ecc.).
Pubblica
beta o next):
Come funziona l’individuazione nel marketplace
Il server Twenty sincronizza il proprio catalogo del marketplace dal registro npm ogni ora. Puoi attivare la sincronizzazione immediatamente invece di aspettare:defineApplication() — campi come displayName, description, author, category, logoUrl, screenshots, aboutDescription, websiteUrl e termsUrl.
Se la tua app non definisce un
aboutDescription in defineApplication(), il marketplace userà automaticamente il README.md del tuo pacchetto su npm come contenuto della pagina Informazioni. Questo significa che puoi mantenere un unico README sia per npm sia per il marketplace di Twenty. Se desideri una descrizione diversa nel marketplace, imposta esplicitamente aboutDescription.Pubblicazione con CI
Usa questo workflow di GitHub Actions per pubblicare automaticamente a ogni release (usa OIDC):yarn install, yarn twenty build, quindi npm publish da .twenty/output.
npm provenance è opzionale ma consigliata. La pubblicazione con
--provenance aggiunge un badge di attendibilità alla tua scheda npm, consentendo agli utenti di verificare che il pacchetto sia stato creato a partire da uno specifico commit in una pipeline CI pubblica. Consulta la documentazione su npm provenance per le istruzioni di configurazione.Installazione delle app
Una volta che un’app è stata pubblicata (npm) o distribuita (tarball), gli spazi di lavoro possono installarla tramite l’interfaccia utente. Vai alla pagina Impostazioni > Applicazioni in Twenty, dove è possibile sfogliare e installare sia le app del marketplace sia quelle distribuite tramite tarball. Puoi anche installare le app dalla riga di comando:Il server applica il versioning semver durante l’installazione, rispecchiando le regole del deploy:
- L’installazione della stessa versione già installata nel tuo spazio di lavoro viene rifiutata con un errore
APP_ALREADY_INSTALLED. - L’installazione di una versione inferiore rispetto a quella attualmente installata viene rifiutata con un errore
CANNOT_DOWNGRADE_APPLICATION.
yarn twenty install.