CLI

CLI yarn twenty je vaše rozhraní ke všemu, co souvisí s aplikací. Úplný seznam příkazů:

Příkaz	K čemu slouží	Zdokumentováno v
`dev`	Sleduje zdrojové soubory a živě synchronizuje změny	Rychlý start
`plán`	Náhled změn metadat bez jejich aplikování	Synchronizace a obnovení
`použít`	Aplikovat změny metadat po zobrazení plánu	Synchronizace a obnovení
`dev:build`	Zkompilovat aplikaci a vygenerovat API klienta (`--tarball` pro zabalení do `.tgz`)	Publikování
`dev:typecheck`	Spustit kontrolu typů TypeScriptu	Testování
`dev:add`	Vytvořit kostru nové entity	Scaffolding
`dev:generate-client`	Znovu vygenerovat typovaného API klienta	tato stránka
`dev:function:exec` / `dev:function:logs`	Spustit funkce a streamovat jejich logy	tato stránka
`dev:translations-extract`	Extrahovat přeložitelné řetězce do katalogů v `locales/`	Překlady
`dev:catalog-sync`	Spustit synchronizaci katalogu tržiště	Publikování
`app:publish` / `app:install` / `app:uninstall`	Životní cyklus vydání	Publikování a tato stránka
`docker:*`	Spravovat kontejner lokálního serveru Twenty	Lokální server
`remote:*`	Spravovat připojení k serveru	tato stránka

Každý příkaz přijímá -r, --remote \<name> pro zacílení na konkrétní vzdálené připojení místo výchozího.

Spouštění funkcí (`yarn twenty dev:function:exec`)

Spusťte logickou funkci ručně bez vyvolání přes HTTP, cron nebo databázovou událost:

# 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 hooks
yarn twenty dev:function:exec --postInstall
yarn twenty dev:function:exec --preInstall

Zobrazení logů funkcí (`yarn twenty dev:function:logs`)

Streamujte výstupní logy běhu logických funkcí vaší aplikace:

# 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

To se liší od yarn twenty docker:logs, který zobrazuje logy kontejneru Docker. yarn twenty dev:function:logs zobrazuje logy běhu funkcí vaší aplikace ze serveru Twenty.

Generování typovaného klienta (`yarn twenty dev:generate-client`)

Znovu vygenerujte typovaného klienta API (twenty-client-sdk) ze schématu aktivního vzdáleného serveru, bez sestavování nebo synchronizace aplikace. Použijte jej k získání typovaného klienta v libovolném projektu – například backendové služby v samostatném repozitáři – který komunikuje s vaší instancí 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

Poté klienta importujte ve svém kódu:

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

Spusťte příkaz znovu pokaždé, když se změní váš datový model, abyste aktualizovali vygenerované typy.

Klient je vygenerován uvnitř node_modules, takže není verzován spolu s vaším kódem. Spusťte yarn twenty dev:generate-client po každé instalaci (například ve skriptu postinstall nebo v CI).

Odinstalace aplikace (`yarn twenty app:uninstall`)

Odeberte svou aplikaci z aktivního pracovního prostoru:

yarn twenty app:uninstall

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

Správa vzdálených serverů

Remote je server Twenty, ke kterému se vaše aplikace připojuje. Během nastavení jej generátor kostry automaticky vytvoří. Můžete kdykoli přidat další vzdálené servery nebo mezi nimi přepínat.

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

Vaše přihlašovací údaje jsou uloženy v ~/.twenty/config.json.

Přehled

Aplikace

API

Vlastní hosting

Přispět

Spouštění funkcí (`yarn twenty dev:function:exec`)

Zobrazení logů funkcí (`yarn twenty dev:function:logs`)

Generování typovaného klienta (`yarn twenty dev:generate-client`)

Odinstalace aplikace (`yarn twenty app:uninstall`)

Správa vzdálených serverů

​Spouštění funkcí (yarn twenty dev:function:exec)

​Zobrazení logů funkcí (yarn twenty dev:function:logs)

​Generování typovaného klienta (yarn twenty dev:generate-client)

​Odinstalace aplikace (yarn twenty app:uninstall)

​Správa vzdálených serverů

Spouštění funkcí (`yarn twenty dev:function:exec`)

Zobrazení logů funkcí (`yarn twenty dev:function:logs`)

Generování typovaného klienta (`yarn twenty dev:generate-client`)

Odinstalace aplikace (`yarn twenty app:uninstall`)

Správa vzdálených serverů