twenty/packages/create-twenty-app/src/constants/base-application/README.md

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

Getting Started

First, authenticate to your workspace:

yarn auth:login

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

yarn app:dev

Or run a one-time sync:

yarn app:sync

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

Available Commands

# Authentication
yarn auth:login     # Authenticate with Twenty
yarn auth:logout    # Remove credentials
yarn auth:status    # Check auth status

# Application
yarn app:dev        # Start dev mode (sync + watch)
yarn app:sync       # One-time sync
yarn entity:add     # Add a new entity (function, object, role)
yarn app:generate   # Generate typed Twenty client
yarn function:logs  # Stream function logs
yarn function:execute  # Execute a function with JSON payload
yarn app:uninstall  # Uninstall app from workspace

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!