create-twenty-app 0.5.2 → 0.6.0

package/dist/constants/base-application/LLMS.md

@@ -0,0 +1,9 @@
+## Base documentation
+
+- Documentation: https://docs.twenty.com/developers/extend/capabilities/apps
+- Rich app example: https://github.com/twentyhq/twenty/tree/main/packages/twenty-sdk/src/cli/__tests__/apps/rich-app
+
+## Common Pitfalls
+
+- Creating an object without an index view associated. Unless this is a technical object, user will need to visualize it.
+- Creating a view without a navigationMenuItem associated. This will make the view available on the left sidebar.

package/dist/constants/base-application/README.md

@@ -5,36 +5,41 @@ This is a [Twenty](https://twenty.com) application project bootstrapped with [`c
 First, authenticate to your workspace:
 
 ```bash
-yarn auth:login
+yarn twenty auth:login
 ```
 
 Then, start development mode to sync your app and watch for changes:
 
 ```bash
-yarn app:dev
+yarn twenty app:dev
 ```
 
 Open your Twenty instance and go to `/settings/applications` section to see the result.
 
 ## Available Commands
 
+Run `yarn twenty help` to list all available commands. Common commands:
+
 ```bash
 # Authentication
-yarn auth:login     # Authenticate with Twenty
-yarn auth:logout    # Remove credentials
-yarn auth:status    # Check auth status
-yarn auth:switch    # Switch default workspace
-yarn auth:list      # List all configured workspaces
+yarn twenty auth:login     # Authenticate with Twenty
+yarn twenty auth:logout    # Remove credentials
+yarn twenty auth:status    # Check auth status
+yarn twenty auth:switch    # Switch default workspace
+yarn twenty auth:list      # List all configured workspaces
 
 # Application
-yarn app:dev        # Start dev mode (watch, build, and sync)
-yarn entity:add     # Add a new entity (function, front-component, 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
+yarn twenty app:dev        # Start dev mode (watch, build, sync, and auto-generate typed client)
+yarn twenty entity:add     # Add a new entity (object, field, function, front-component, role, view, navigation-menu-item)
+yarn twenty function:logs  # Stream function logs
+yarn twenty function:execute  # Execute a function with JSON payload
+yarn twenty app:uninstall  # Uninstall app from workspace
 ```
 
+## LLMs instructions
+
+Main docs and pitfalls are available in LLMS.md file.
+
 ## Learn More
 
 To learn more about Twenty applications, take a look at the following resources:

package/dist/create-app.command.d.ts

@@ -1,6 +1,8 @@
+import { ScaffoldingMode } from './types/scaffolding-options';
 export declare class CreateAppCommand {
-    execute(directory?: string): Promise<void>;
+    execute(directory?: string, mode?: ScaffoldingMode): Promise<void>;
     private getAppInfos;
+    private resolveExampleOptions;
     private validateDirectory;
     private logCreationInfo;
     private logSuccess;

package/dist/types/scaffolding-options.d.ts

@@ -0,0 +1,10 @@
+export type ScaffoldingMode = 'exhaustive' | 'minimal' | 'interactive';
+export type ExampleOptions = {
+    includeExampleObject: boolean;
+    includeExampleField: boolean;
+    includeExampleLogicFunction: boolean;
+    includeExampleFrontComponent: boolean;
+    includeExampleView: boolean;
+    includeExampleNavigationMenuItem: boolean;
+    includeExampleSkill: boolean;
+};

package/dist/utils/app-template.d.ts

@@ -1,6 +1,8 @@
-export declare const copyBaseApplicationProject: ({ appName, appDisplayName, appDescription, appDirectory, }: {
+import { ExampleOptions } from '../types/scaffolding-options';
+export declare const copyBaseApplicationProject: ({ appName, appDisplayName, appDescription, appDirectory, exampleOptions, }: {
     appName: string;
     appDisplayName: string;
     appDescription: string;
     appDirectory: string;
+    exampleOptions: ExampleOptions;
 }) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-twenty-app",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "Command-line interface to create Twenty application",
   "main": "dist/cli.cjs",
   "bin": "dist/cli.cjs",
@@ -10,9 +10,7 @@
     "package.json"
   ],
   "scripts": {
-    "build": "npx rimraf dist && npx vite build",
-    "prepublishOnly": "tsx ../twenty-utils/pack-scripts/pre-publish-only.ts",
-    "postpublish": "tsx ../twenty-utils/pack-scripts/post-publish.ts"
+    "build": "npx rimraf dist && npx vite build"
   },
   "keywords": [
     "twenty",
@@ -40,6 +38,20 @@
     "lodash.startcase": "^4.4.0",
     "uuid": "^13.0.0"
   },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.0",
+    "@types/inquirer": "^9.0.0",
+    "@types/lodash.camelcase": "^4.3.7",
+    "@types/lodash.kebabcase": "^4.1.7",
+    "@types/lodash.startcase": "^4",
+    "@types/node": "^20.0.0",
+    "twenty-sdk": "workspace:*",
+    "twenty-shared": "workspace:*",
+    "typescript": "^5.9.2",
+    "vite": "^7.0.0",
+    "vite-plugin-dts": "^4.5.4",
+    "vite-tsconfig-paths": "^4.2.1"
+  },
   "engines": {
     "node": "^24.5.0",
     "yarn": "^4.0.2"