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

# CLI

> yarn twenty commands for executing functions, streaming logs, managing app installations, and switching remotes.

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](/developers/extend/apps/getting-started/quick-start)                                 |
| `plan`                                          | Preview metadata changes without applying them                             | [Syncing & recovery](/developers/extend/apps/operations/sync-and-recovery#previewing-changes-plan) |
| `apply`                                         | Apply metadata changes after showing the plan                              | [Syncing & recovery](/developers/extend/apps/operations/sync-and-recovery)                         |
| `dev:build`                                     | Compile the app and generate the API client (`--tarball` to pack a `.tgz`) | [Publishing](/developers/extend/apps/operations/publishing)                                        |
| `dev:typecheck`                                 | Run TypeScript type checking                                               | [Testing](/developers/extend/apps/operations/testing)                                              |
| `dev:add`                                       | Scaffold a new entity                                                      | [Scaffolding](/developers/extend/apps/getting-started/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](/developers/extend/apps/translations/overview)                                      |
| `dev:catalog-sync`                              | Trigger a marketplace catalog sync                                         | [Publishing](/developers/extend/apps/operations/publishing#how-marketplace-discovery-works)        |
| `app:publish` / `app:install` / `app:uninstall` | Release lifecycle                                                          | [Publishing](/developers/extend/apps/operations/publishing) and this page                          |
| `docker:*`                                      | Manage the local Twenty server container                                   | [Local Server](/developers/extend/apps/getting-started/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:

```bash filename="Terminal" theme={null}
# 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:

```bash filename="Terminal" theme={null}
# 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
```

<Note>
  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.
</Note>

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

Regenerate the typed API client (`twenty-client-sdk`) from the active remote's schema, without building or syncing an app. Use it to get a typed client in any project — like a backend service living in a separate repository — that talks to your Twenty instance:

```bash filename="Terminal" theme={null}
# 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
```

Then import the client in your code:

```typescript theme={null}
import { CoreApiClient } from 'twenty-client-sdk/core';
```

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

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

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

Remove your app from the active workspace:

```bash filename="Terminal" theme={null}
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.

```bash filename="Terminal" theme={null}
# 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`.