create-twenty-app 0.7.0-canary.0 → 0.7.0

package/README.md

@@ -43,7 +43,7 @@ yarn twenty auth:login
 yarn twenty entity:add
 
 # Start dev mode: watches, builds, and syncs local changes to your workspace
-# (also auto-generates typed API clients — CoreApiClient and MetadataApiClient — in node_modules/twenty-sdk/generated)
+# (also auto-generates typed CoreApiClient — MetadataApiClient ships pre-built with the SDK — both available via `twenty-sdk/clients`)
 yarn twenty app:dev
 
 # Watch your application's function logs
@@ -58,6 +58,12 @@ yarn twenty function:execute --preInstall
 # Execute the post-install function
 yarn twenty function:execute --postInstall
 
+# Build the app for distribution
+yarn twenty app:build
+
+# Publish the app to npm or directly to a Twenty server
+yarn twenty app:publish
+
 # Uninstall the application from the current workspace
 yarn twenty app:uninstall
 ```
@@ -107,31 +113,42 @@ npx create-twenty-app@latest my-app -m
 - Use `yarn twenty auth:login` to authenticate with your Twenty workspace.
 - Explore the generated project and add your first entity with `yarn twenty entity:add` (logic functions, front components, objects, roles, views, navigation menu items, skills).
 - Use `yarn twenty app:dev` while you iterate — it watches, builds, and syncs changes to your workspace in real time.
-- Two typed API clients are auto‑generated by `yarn twenty app:dev` and stored in `node_modules/twenty-sdk/generated`: `CoreApiClient` (for workspace data via `/graphql`) and `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`).
+- `CoreApiClient` (for workspace data via `/graphql`) is auto-generated by `yarn twenty app:dev`. `MetadataApiClient` (for workspace configuration and file uploads via `/metadata`) ships pre-built with the SDK. Both are available via `import { CoreApiClient, MetadataApiClient } from 'twenty-sdk/clients'`.
+
+## Build and publish your application
+
+Once your app is ready, build and publish it using the CLI:
+
+```bash
+# Build the app (output goes to .twenty/output/)
+yarn twenty app:build
+
+# Build and create a tarball (.tgz) for distribution
+yarn twenty app:build --tarball
 
-## Publish your application
+# Publish to npm (requires npm login)
+yarn twenty app:publish
 
-Applications are currently stored in `twenty/packages/twenty-apps`.
+# Publish with a dist-tag (e.g. beta, next)
+yarn twenty app:publish --tag beta
 
-You can share your application with all Twenty users:
+# Publish directly to a Twenty server (builds, uploads, and installs in one step)
+yarn twenty app:publish --server https://app.twenty.com
+```
+
+### Publish to the Twenty marketplace
+
+You can also contribute your application to the curated marketplace:
 
 ```bash
-# pull the Twenty project
 git clone https://github.com/twentyhq/twenty.git
 cd twenty
-
-# create a new branch
 git checkout -b feature/my-awesome-app
 ```
 
 - Copy your app folder into `twenty/packages/twenty-apps`.
 - Commit your changes and open a pull request on https://github.com/twentyhq/twenty
 
-```bash
-git commit -m "Add new application"
-git push
-```
-
 Our team reviews contributions for quality, security, and reusability before merging.
 
 ## Troubleshooting