ContextQMD
Back to Twenty

CLI

packages/twenty-docs/developers/extend/apps/operations/cli.mdx

2.7.32.2 KB
Original Source

Beyond dev, dev:build, dev:add, and dev:typecheck, the yarn twenty CLI provides commands for executing functions, viewing logs, and managing app installations.

Executing functions (yarn twenty dev:function:exec)

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

bash
# 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 post-install function
yarn twenty dev:function:exec --postInstall

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

Stream execution logs for your app's logic functions:

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

Uninstalling an app (yarn twenty app:uninstall)

Remove your app from the active workspace:

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

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