create-twenty-app 0.7.0 → 0.8.0-canary.0
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 +23 -23
- package/dist/cli.cjs +56 -54
- package/dist/cli.mjs +6442 -6230
- package/dist/constants/base-application/LLMS.md +1 -0
- package/dist/constants/base-application/README.md +19 -21
- package/dist/create-app.command.d.ts +2 -0
- package/dist/utils/setup-local-instance.d.ts +5 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -36,36 +36,36 @@ cd my-twenty-app
|
|
|
36
36
|
# Get help and list all available commands
|
|
37
37
|
yarn twenty help
|
|
38
38
|
|
|
39
|
-
# Authenticate
|
|
40
|
-
yarn twenty
|
|
39
|
+
# Authenticate with your Twenty server
|
|
40
|
+
yarn twenty remote add --local
|
|
41
41
|
|
|
42
42
|
# Add a new entity to your application (guided)
|
|
43
|
-
yarn twenty
|
|
43
|
+
yarn twenty add
|
|
44
44
|
|
|
45
45
|
# Start dev mode: watches, builds, and syncs local changes to your workspace
|
|
46
46
|
# (also auto-generates typed CoreApiClient — MetadataApiClient ships pre-built with the SDK — both available via `twenty-sdk/clients`)
|
|
47
|
-
yarn twenty
|
|
47
|
+
yarn twenty dev
|
|
48
48
|
|
|
49
49
|
# Watch your application's function logs
|
|
50
|
-
yarn twenty
|
|
50
|
+
yarn twenty logs
|
|
51
51
|
|
|
52
52
|
# Execute a function with a JSON payload
|
|
53
|
-
yarn twenty
|
|
53
|
+
yarn twenty exec -n my-function -p '{"key": "value"}'
|
|
54
54
|
|
|
55
55
|
# Execute the pre-install function
|
|
56
|
-
yarn twenty
|
|
56
|
+
yarn twenty exec --preInstall
|
|
57
57
|
|
|
58
58
|
# Execute the post-install function
|
|
59
|
-
yarn twenty
|
|
59
|
+
yarn twenty exec --postInstall
|
|
60
60
|
|
|
61
61
|
# Build the app for distribution
|
|
62
|
-
yarn twenty
|
|
62
|
+
yarn twenty build
|
|
63
63
|
|
|
64
64
|
# Publish the app to npm or directly to a Twenty server
|
|
65
|
-
yarn twenty
|
|
65
|
+
yarn twenty publish
|
|
66
66
|
|
|
67
67
|
# Uninstall the application from the current workspace
|
|
68
|
-
yarn twenty
|
|
68
|
+
yarn twenty uninstall
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
## Scaffolding modes
|
|
@@ -110,10 +110,10 @@ npx create-twenty-app@latest my-app -m
|
|
|
110
110
|
## Next steps
|
|
111
111
|
|
|
112
112
|
- Run `yarn twenty help` to see all available commands.
|
|
113
|
-
- Use `yarn twenty
|
|
114
|
-
- Explore the generated project and add your first entity with `yarn twenty
|
|
115
|
-
- Use `yarn twenty
|
|
116
|
-
- `CoreApiClient` (for workspace data via `/graphql`) is auto-generated by `yarn twenty
|
|
113
|
+
- Use `yarn twenty remote add --local` to authenticate with your Twenty workspace.
|
|
114
|
+
- Explore the generated project and add your first entity with `yarn twenty add` (logic functions, front components, objects, roles, views, navigation menu items, skills).
|
|
115
|
+
- Use `yarn twenty dev` while you iterate — it watches, builds, and syncs changes to your workspace in real time.
|
|
116
|
+
- `CoreApiClient` (for workspace data via `/graphql`) is auto-generated by `yarn twenty 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'`.
|
|
117
117
|
|
|
118
118
|
## Build and publish your application
|
|
119
119
|
|
|
@@ -121,19 +121,19 @@ Once your app is ready, build and publish it using the CLI:
|
|
|
121
121
|
|
|
122
122
|
```bash
|
|
123
123
|
# Build the app (output goes to .twenty/output/)
|
|
124
|
-
yarn twenty
|
|
124
|
+
yarn twenty build
|
|
125
125
|
|
|
126
126
|
# Build and create a tarball (.tgz) for distribution
|
|
127
|
-
yarn twenty
|
|
127
|
+
yarn twenty build --tarball
|
|
128
128
|
|
|
129
129
|
# Publish to npm (requires npm login)
|
|
130
|
-
yarn twenty
|
|
130
|
+
yarn twenty publish
|
|
131
131
|
|
|
132
132
|
# Publish with a dist-tag (e.g. beta, next)
|
|
133
|
-
yarn twenty
|
|
133
|
+
yarn twenty publish --tag beta
|
|
134
134
|
|
|
135
|
-
#
|
|
136
|
-
yarn twenty
|
|
135
|
+
# Deploy directly to a Twenty server (builds, uploads, and installs in one step)
|
|
136
|
+
yarn twenty deploy
|
|
137
137
|
```
|
|
138
138
|
|
|
139
139
|
### Publish to the Twenty marketplace
|
|
@@ -153,8 +153,8 @@ Our team reviews contributions for quality, security, and reusability before mer
|
|
|
153
153
|
|
|
154
154
|
## Troubleshooting
|
|
155
155
|
|
|
156
|
-
- Auth prompts not appearing: run `yarn twenty
|
|
157
|
-
- Types not generated: ensure `yarn twenty
|
|
156
|
+
- Auth prompts not appearing: run `yarn twenty remote add --local` again and verify the API key permissions.
|
|
157
|
+
- Types not generated: ensure `yarn twenty dev` is running — it auto‑generates the typed client.
|
|
158
158
|
|
|
159
159
|
## Contributing
|
|
160
160
|
|