CLI

The yarn twenty CLI is your interface to everything app-related. Full command list:

Command	What it does	Documented in
`dev`	Watch source files and live-sync changes	Quick Start
`plan`	Preview metadata changes without applying them	Syncing & recovery
`apply`	Apply metadata changes after showing the plan	Syncing & recovery
`pull`	Experimental. Write the installed application back to local source files	Syncing & recovery
`dev:build`	Compile the app and generate the API client (`--tarball` to pack a `.tgz`)	Publishing
`dev:typecheck`	Run TypeScript type checking	Testing
`dev:add`	Scaffold a new entity	Scaffolding
`dev:generate-client`	Regenerate the typed API client	this page
`dev:function:exec` / `dev:function:logs`	Execute functions and stream their logs	this page
`dev:translations-extract`	Extract translatable strings into `locales/` catalogs	Translations
`dev:catalog-sync`	Trigger a marketplace catalog sync	Publishing
`app:publish` / `app:install` / `app:uninstall`	Release lifecycle	Publishing and this page
`docker:*`	Manage the local Twenty server container	Local Server
`remote:*`	Manage server connections	this page

Every command accepts -r, --remote <name> to target a specific remote instead of the default one.

Executing functions (`yarn twenty dev:function:exec`)

Run a logic function manually without triggering it via HTTP, cron, or database event:

# 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

Viewing function logs (`yarn twenty dev:function:logs`)

Stream execution logs for your app’s logic functions:

# 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

This is different from yarn twenty docker:logs, which shows the Docker container logs. yarn twenty dev:function:logs shows your app’s function execution logs from the Twenty server.

Generating the typed client (`yarn twenty dev:generate-client`)

Regenerate the typed API client (twenty-client-sdk) for your app from the active remote. The client is scoped to the application declared in your manifest, so the command reads the build output: run yarn twenty dev:build (or yarn twenty dev) first.

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

# Build the app so the manifest exists
yarn twenty dev:build

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

Then import the client in your code:

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

Re-run the command whenever your data model changes to refresh the generated types.

The client is generated inside node_modules, so it is not committed with your code. Run yarn twenty dev:build then yarn twenty dev:generate-client after every install (for example in a postinstall script or in CI).

Uninstalling an app (`yarn twenty app:uninstall`)

Remove your app from the active workspace:

yarn twenty app:uninstall

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

Managing remotes

A remote is a Twenty server that your app connects to. During setup, the scaffolder creates one for you automatically. You can add more remotes or switch between them at any time.

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

Your credentials are stored in ~/.twenty/config.json.

Overview

Apps

API

Self-Host

Contribute

UI Library

Executing functions (`yarn twenty dev:function:exec`)

Viewing function logs (`yarn twenty dev:function:logs`)

Generating the typed client (`yarn twenty dev:generate-client`)

Uninstalling an app (`yarn twenty app:uninstall`)

Managing remotes

​Executing functions (yarn twenty dev:function:exec)

​Viewing function logs (yarn twenty dev:function:logs)

​Generating the typed client (yarn twenty dev:generate-client)

​Uninstalling an app (yarn twenty app:uninstall)

​Managing remotes

Executing functions (`yarn twenty dev:function:exec`)

Viewing function logs (`yarn twenty dev:function:logs`)

Generating the typed client (`yarn twenty dev:generate-client`)

Uninstalling an app (`yarn twenty app:uninstall`)

Managing remotes