create-twenty-app 0.6.0 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -31,10 +31,6 @@ See Twenty application documentation https://docs.twenty.com/developers/extend/c
31
31
  npx create-twenty-app@latest my-twenty-app
32
32
  cd my-twenty-app
33
33
 
34
- # If you don't use yarn@4
35
- corepack enable
36
- yarn install
37
-
38
34
  # Get help and list all available commands
39
35
  yarn twenty help
40
36
 
@@ -45,7 +41,7 @@ yarn twenty auth:login
45
41
  yarn twenty entity:add
46
42
 
47
43
  # Start dev mode: watches, builds, and syncs local changes to your workspace
48
- # (also auto-generates a typed API client in node_modules/twenty-sdk/generated)
44
+ # (also auto-generates typed API clients — CoreApiClient and MetadataApiClient — in node_modules/twenty-sdk/generated)
49
45
  yarn twenty app:dev
50
46
 
51
47
  # Watch your application's function logs
@@ -54,6 +50,9 @@ yarn twenty function:logs
54
50
  # Execute a function with a JSON payload
55
51
  yarn twenty function:execute -n my-function -p '{"key": "value"}'
56
52
 
53
+ # Execute the pre-install function
54
+ yarn twenty function:execute --preInstall
55
+
57
56
  # Execute the post-install function
58
57
  yarn twenty function:execute --postInstall
59
58
 
@@ -96,6 +95,7 @@ In interactive mode, you can pick from:
96
95
  **Core files (always created):**
97
96
  - `application-config.ts` — Application metadata configuration
98
97
  - `roles/default-role.ts` — Default role for logic functions
98
+ - `logic-functions/pre-install.ts` — Pre-install logic function (runs before app installation)
99
99
  - `logic-functions/post-install.ts` — Post-install logic function (runs after app installation)
100
100
  - TypeScript configuration, ESLint, package.json, .gitignore
101
101
  - A prewired `twenty` script that delegates to the `twenty` CLI from twenty-sdk
@@ -114,7 +114,7 @@ In interactive mode, you can pick from:
114
114
  - Use `yarn twenty auth:login` to authenticate with your Twenty workspace.
115
115
  - 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).
116
116
  - Use `yarn twenty app:dev` while you iterate — it watches, builds, and syncs changes to your workspace in real time.
117
- - Types are auto‑generated by `yarn twenty app:dev` and stored in `node_modules/twenty-sdk/generated`.
117
+ - 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`).
118
118
 
119
119
 
120
120
  ## Publish your application