1774 extensibility v1 create an exhaustive documentation readme or dedicated section in twenty contributing doc (#16751)

As title

<img width="1108" height="894" alt="image"
src="https://github.com/user-attachments/assets/e2dc7e12-72e3-4ca3-ac7b-a94de547f82a"
/>

Author: martmull

packages/create-twenty-app/README.md

@@ -23,6 +23,7 @@ Create Twenty App is the official scaffolding CLI for building apps on top of [T
 - A Twenty workspace and an API key (create one at https://app.twenty.com/settings/api-webhooks)
 
 ## Quick start
+
 ```bash
 npx create-twenty-app@latest my-twenty-app
 cd my-twenty-app

packages/create-twenty-app/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-twenty-app",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Command-line interface to create Twenty application",
   "main": "dist/cli.cjs",
   "bin": "dist/cli.cjs",

packages/create-twenty-app/src/constants/base-application/eslint.config.mjs

@@ -1,137 +1,29 @@
 import js from '@eslint/js';
-import typescriptEslint from '@typescript-eslint/eslint-plugin';
-import typescriptParser from '@typescript-eslint/parser';
-import importPlugin from 'eslint-plugin-import';
-import preferArrowPlugin from 'eslint-plugin-prefer-arrow';
-import prettierPlugin from 'eslint-plugin-prettier';
-import unusedImportsPlugin from 'eslint-plugin-unused-imports';
+import tseslint from 'typescript-eslint';
 
 export default [
-  // Base JS rules
+  // Base JS recommended rules
   js.configs.recommended,
 
-  // Global ignores
-  {
-    ignores: ['**/node_modules/**', '**/dist/**', '**/coverage/**'],
-  },
+  // TypeScript recommended rules
+  ...tseslint.configs.recommended,
 
-  // Base config for TS/JS files
   {
-    files: ['**/*.{js,jsx,ts,tsx}'],
+    files: ['**/*.ts', '**/*.tsx'],
     languageOptions: {
-      ecmaVersion: 'latest',
-      sourceType: 'module',
-    },
-    plugins: {
-      prettier: prettierPlugin,
-      import: importPlugin,
-      'prefer-arrow': preferArrowPlugin,
-      'unused-imports': unusedImportsPlugin,
-    },
-    rules: {
-      // General rules (aligned with main project)
-      'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
-      'no-console': [
-        'warn',
-        { allow: ['group', 'groupCollapsed', 'groupEnd'] },
-      ],
-      'no-control-regex': 0,
-      'no-debugger': 'error',
-      'no-duplicate-imports': 'error',
-      'no-undef': 'off',
-      'no-unused-vars': 'off',
-
-      // Import rules
-      'import/no-relative-packages': 'error',
-      'import/no-useless-path-segments': 'error',
-      'import/no-duplicates': ['error', { considerQueryString: true }],
-
-      // Prefer arrow functions
-      'prefer-arrow/prefer-arrow-functions': [
-        'error',
-        {
-          disallowPrototype: true,
-          singleReturnOnly: false,
-          classPropertiesAllowed: false,
-        },
-      ],
-
-      // Unused imports
-      'unused-imports/no-unused-imports': 'warn',
-      'unused-imports/no-unused-vars': [
-        'warn',
-        {
-          vars: 'all',
-          varsIgnorePattern: '^_',
-          args: 'after-used',
-          argsIgnorePattern: '^_',
-        },
-      ],
-
-      // Prettier (formatting as lint errors if you want)
-      'prettier/prettier': 'error',
-    },
-  },
-
-  // TypeScript-specific configuration
-  {
-    files: ['**/*.{ts,tsx}'],
-    languageOptions: {
-      parser: typescriptParser,
       parserOptions: {
-        ecmaFeatures: {
-          jsx: true,
-        },
+        project: true,
+        tsconfigRootDir: import.meta.dirname,
       },
     },
-    plugins: {
-      '@typescript-eslint': typescriptEslint,
-    },
     rules: {
-      // Turn off base rule and use TS-aware versions
-      'no-redeclare': 'off',
-      '@typescript-eslint/no-redeclare': 'error',
-
-      '@typescript-eslint/ban-ts-comment': 'error',
-      '@typescript-eslint/consistent-type-imports': [
-        'error',
-        {
-          prefer: 'type-imports',
-          fixStyle: 'inline-type-imports',
-        },
-      ],
-      '@typescript-eslint/explicit-function-return-type': 'off',
-      '@typescript-eslint/explicit-module-boundary-types': 'off',
-      '@typescript-eslint/interface-name-prefix': 'off',
-      '@typescript-eslint/no-empty-interface': [
-        'error',
-        {
-          allowSingleExtends: true,
-        },
+      // Common TypeScript-friendly tweaks
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        { argsIgnorePattern: '^_' },
       ],
       '@typescript-eslint/no-explicit-any': 'off',
-      '@typescript-eslint/no-empty-function': 'off',
-      '@typescript-eslint/no-unused-vars': 'off',
-    },
-  },
-
-  // Test files (Jest)
-  {
-    files: ['**/*.spec.@(ts|tsx|js|jsx)', '**/*.test.@(ts|tsx|js|jsx)'],
-    languageOptions: {
-      globals: {
-        jest: true,
-        describe: true,
-        it: true,
-        expect: true,
-        beforeEach: true,
-        afterEach: true,
-        beforeAll: true,
-        afterAll: true,
-      },
-    },
-    rules: {
-      '@typescript-eslint/no-non-null-assertion': 'off',
+      'no-unused-vars': 'off', // handled by TS rule
     },
   },
 ];

packages/create-twenty-app/src/utils/app-template.ts

@@ -100,7 +100,7 @@ const createDefaultServerlessFunctionRoleConfig = async ({
   appDirectory: string;
   defaultServerlessFunctionRoleUniversalIdentifier: string;
 }) => {
-  const content = `import { PermissionFlag, type RoleConfig } from 'twenty-sdk';
+  const content = `import { type RoleConfig } from 'twenty-sdk';
 
 export const functionRole: RoleConfig = {
   universalIdentifier: '${defaultServerlessFunctionRoleUniversalIdentifier}',
@@ -168,13 +168,17 @@ const createPackageJson = async ({
       uninstall: 'twenty app uninstall',
       help: 'twenty help',
       auth: 'twenty auth login',
+      lint: 'eslint',
+      'lint-fix': 'eslint --fix',
     },
     dependencies: {
-      'twenty-sdk': '0.2.3',
+      'twenty-sdk': '0.2.4',
     },
     devDependencies: {
-      '@types/node': '^24.7.2',
       typescript: '^5.9.3',
+      '@types/node': '^24.7.2',
+      eslint: '^9.32.0',
+      'typescript-eslint': '^8.50.0',
     },
   };
 

packages/twenty-apps/hello-world/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hello-world",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "license": "MIT",
   "engines": {
     "node": "^24.5.0",
@@ -17,7 +17,7 @@
     "auth": "twenty auth login"
   },
   "dependencies": {
-    "twenty-sdk": "0.2.2"
+    "twenty-sdk": "0.2.4"
   },
   "devDependencies": {
     "@types/node": "^24.7.2"

packages/twenty-apps/hello-world/src/roles/function-role.ts

@@ -12,7 +12,6 @@ export const functionRole: RoleConfig = {
   canBeAssignedToAgents: false,
   canBeAssignedToUsers: false,
   canBeAssignedToApiKeys: false,
-  canBeAssignedToApplications: true,
   objectPermissions: [
     {
       objectNameSingular: 'postCard',

packages/twenty-cli/README.md

@@ -1,89 +1,8 @@
 # Deprecated: twenty-cli
 
-This package is deprecated. Please install and use twenty-sdk instead:
+This package is deprecated. Please install and use [twenty-sdk](https://www.npmjs.com/package/twenty-sdk) instead:
 
 ```bash
 npm uninstall twenty-cli
 npm install -g twenty-sdk
 ```
-
-The command name remains the same: twenty.
-
-A command-line interface to easily scaffold, develop, and publish applications that extend Twenty CRM (now provided by twenty-sdk).
-
-## Requirements
-- yarn >= 4.9.2
-- an `apiKey`. Go to `https://twenty.com/settings/api-webhooks` to generate one
-
-## Quick example project
-
-```bash
-# Authenticate using your apiKey (CLI will prompt for your <apiKey>)
-twenty auth login
-
-# Init a new application called hello-world
-twenty app init hello-world
-
-# Go to your app
-cd hello-world
-
-# Add a serverless function to your application
-twenty app add serverlessFunction
-
-# Add a trigger to your serverless function
-twenty app add trigger
-
-# Add axios to your application
-yarn add axios
-
-# Start dev mode: automatically syncs changes to your Twenty workspace, so you can test new functions/objects instantly.
-twenty app dev
-
-# Or use one time sync (also generates SDK automatically)
-twenty app sync
-
-# List all available commands
-twenty help
-```
-
-## Application Structure
-
-Each application in this package follows the standard application structure:
-
-```
-app-name/
-├── package.json
-├── README.md
-├── serverlessFunctions  # Custom backend logic (runs on demand)
-└── ...
-```
-
-## Publish your application
-
-Applications are currently stored in twenty/packages/twenty-apps.
-
-You can share your application with all twenty users.
-
-```bash
-# pull 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.
-
-## Contributing
-
-- see our [Hacktoberfest 2025 notion page](https://twentycrm.notion.site/Hacktoberfest-27711d8417038037a149d4638a9cc510)
-- our [Discord](https://discord.gg/cx5n4Jzs57)

packages/twenty-cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "twenty-cli",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "[DEPRECATED] Use twenty-sdk instead: https://www.npmjs.com/package/twenty-sdk",
   "scripts": {
     "build": "echo 'use npx nx build'",