create-twenty-app 0.8.0-canary.8 → 0.8.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.
Files changed (28) hide show
  1. package/README.md +15 -12
  2. package/dist/cli.cjs +55 -564
  3. package/dist/cli.mjs +9504 -10154
  4. package/dist/constants/template/AGENT.md +14 -0
  5. package/dist/constants/template/CLAUDE.md +14 -0
  6. package/dist/constants/{base-application → template}/LLMS.md +2 -2
  7. package/{src/constants/base-application → dist/constants/template}/README.md +1 -1
  8. package/dist/constants/template/gitignore +38 -0
  9. package/dist/constants/template/package.json +35 -0
  10. package/dist/constants/template/src/__tests__/app-install.integration-test.ts +70 -0
  11. package/dist/constants/template/src/__tests__/setup-test.ts +45 -0
  12. package/dist/constants/template/src/application-config.ts +15 -0
  13. package/dist/constants/template/src/constants/universal-identifiers.ts +4 -0
  14. package/dist/constants/template/src/default-role.ts +16 -0
  15. package/dist/constants/{base-application → template}/tsconfig.json +5 -0
  16. package/dist/constants/template/tsconfig.spec.json +9 -0
  17. package/dist/constants/template/vitest.config.ts +21 -0
  18. package/dist/constants/template/yarn.lock +2 -0
  19. package/dist/create-app.command.d.ts +2 -3
  20. package/dist/utils/app-template.d.ts +1 -3
  21. package/dist/utils/download-example.d.ts +1 -0
  22. package/package.json +2 -2
  23. package/{dist/constants/base-application → src/constants/template}/README.md +1 -1
  24. package/src/constants/template/package.json +35 -0
  25. package/dist/types/scaffolding-options.d.ts +0 -12
  26. package/dist/utils/test-template.d.ts +0 -4
  27. /package/dist/constants/{base-application → template}/.nvmrc +0 -0
  28. /package/dist/constants/{base-application → template}/.oxlintrc.json +0 -0
package/README.md CHANGED
@@ -24,24 +24,27 @@ yarn twenty dev
24
24
 
25
25
  The scaffolder will:
26
26
 
27
- 1. Create a new project with TypeScript, linting, and a preconfigured `twenty` CLI
27
+ 1. Create a new project with TypeScript, linting, tests, and a preconfigured `twenty` CLI
28
28
  2. Optionally start a local Twenty server (Docker)
29
29
  3. Open the browser for OAuth authentication
30
- 4. Scaffold example entities and an integration test
31
30
 
32
- ## Scaffolding modes
31
+ ## Options
33
32
 
34
- | Flag | Behavior |
35
- | -------------- | -------------------------------------------------------------------------------------------------------------- |
36
- | `--minimal` | **(default)** Creates only core files (`application-config.ts`, `default-role.ts`, pre/post-install functions) |
37
- | `--exhaustive` | Creates all example entities |
33
+ | Flag | Description |
34
+ | ------------------------------ | --------------------------------------- |
35
+ | `--example <name>` | Initialize from an example |
36
+ | `--name <name>` | Set the app name (skips the prompt) |
37
+ | `--display-name <displayName>` | Set the display name (skips the prompt) |
38
+ | `--description <description>` | Set the description (skips the prompt) |
39
+ | `--skip-local-instance` | Skip the local server setup prompt |
38
40
 
39
- Other flags:
41
+ By default (no flags), a minimal app is generated with core files and an integration test. Use `--example` to start from a richer example:
40
42
 
41
- - `--name <name>` — set the app name (skips the prompt)
42
- - `--display-name <displayName>` — set the display name (skips the prompt)
43
- - `--description <description>` — set the description (skips the prompt)
44
- - `--skip-local-instance` — skip the local server setup prompt
43
+ ```bash
44
+ npx create-twenty-app@latest my-twenty-app --example hello-world
45
+ ```
46
+
47
+ Examples are sourced from [twentyhq/twenty/packages/twenty-apps/examples](https://github.com/twentyhq/twenty/tree/main/packages/twenty-apps/examples).
45
48
 
46
49
  ## Documentation
47
50