Remotes & Authentication - Twenty

This is a Twenty application project bootstrapped with create-twenty-app.

Getting Started

First, authenticate to your workspace:

bash

yarn twenty remote:add --api-url http://localhost:2020 --as local

Then, start development mode to sync your app and watch for changes:

bash

yarn twenty dev

Open your Twenty instance and go to /settings/applications section to see the result.

Available Commands

Run yarn twenty help to list all available commands. Common commands:

bash

# Remotes & Authentication
yarn twenty remote:add --api-url http://localhost:2020 --as local     # Authenticate with Twenty
yarn twenty remote:status         # Check auth status
yarn twenty remote:use            # Set default remote
yarn twenty remote:list           # List all configured remotes
yarn twenty remote:remove <name>  # Remove a remote

# Application
yarn twenty dev            # Start dev mode (watch, build, sync, and auto-generate typed client)
yarn twenty dev:add        # Scaffold a new entity (object, field, function, front-component, role, view, navigation-menu-item)
yarn twenty dev:function:logs    # Stream function logs
yarn twenty dev:function:exec    # Execute a function with JSON payload
yarn twenty app:uninstall  # Uninstall app from workspace

LLMs instructions

Main docs and pitfalls are available in LLMS.md file.

Learn More

To learn more about Twenty applications, take a look at the following resources:

twenty-sdk - learn about twenty-sdk tool.
Twenty doc - Twenty's documentation.
Join our Discord

You can check out the Twenty GitHub repository - your feedback and contributions are welcome!