Files
twenty/packages/twenty-cli/schemas/appManifest.schema.json
T
martmull d2e7f2a910 1635 extensibilitytwenty cli app vars (#15143)
- Update twenty-cli to support application env variable definition
- Update twenty-server to create a new `core.applicationVariable` entity
to store env variables and provide env var when executing serverless
function
- Update twenty-front to support application environment variable value
setting

<img width="1044" height="660" alt="image"
src="https://github.com/user-attachments/assets/24c3d323-5370-4a80-8174-fc4653cc3c22"
/>

<img width="1178" height="662" alt="image"
src="https://github.com/user-attachments/assets/c124f423-8ed8-4246-ae5b-a9bd6672c7dc"
/>

<img width="1163" height="823" alt="image"
src="https://github.com/user-attachments/assets/fb7425a3-facc-4895-a5eb-8a8e278e0951"
/>

<img width="1087" height="696" alt="image"
src="https://github.com/user-attachments/assets/113da8a2-5590-433c-b1b3-5ed3137f24ca"
/>

<img width="1512" height="715" alt="image"
src="https://github.com/user-attachments/assets/1d2110b7-301d-4f21-a45c-ddd54d6e3391"
/>

<img width="1287" height="581" alt="image"
src="https://github.com/user-attachments/assets/353b16c6-0527-444c-87d6-51447a96cbc7"
/>
2025-10-17 10:54:38 +02:00

126 lines
4.3 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-cli/schemas/appManifest.schema.json",
"title": "Twenty App Manifest",
"description": "Schema for Twenty application manifest files",
"type": "object",
"required": ["universalIdentifier", "name", "version", "license", "engines", "packageManager"],
"properties": {
"$schema": {
"type": "string",
"description": "JSON Schema reference for validation and IDE support"
},
"universalIdentifier": {
"type": "string",
"description": "Unique identifier (UUID format recommended)",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"name": {
"type": "string",
"description": "Human-readable display name for the application",
"minLength": 1,
"maxLength": 200
},
"description": {
"type": "string",
"description": "Brief description of what the application does",
"maxLength": 1000
},
"icon": {
"type": "string",
"description": "Icon for the application (emoji or icon name)",
"maxLength": 50
},
"license": {
"const": "MIT",
"title": "The application's license",
"description": "Currently only MIT is accepted, although more licenses will probably be available in the future."
},
"env": {
"type": "object",
"title": "Environment Variables",
"description": "Key-value pairs defining environment variables available to all serverless functions.",
"patternProperties": {
"^[A-Z_][A-Z0-9_]*$": {
"type": "object",
"title": "Environment Variable Definition",
"properties": {
"description": {
"type": "string",
"description": "Description for this environment variable."
},
"value": {
"type": "string",
"description": "Default value for this environment variable"
},
"isSecret": {
"type": "boolean",
"description": "If true, the value will be treated as sensitive and hidden from logs or UI."
}
},
"required": ["isSecret"],
"additionalProperties": false
}
},
"additionalProperties": false
},
"engines": {
"type": "object",
"title": "The application's engines",
"description": "Define engines here"
},
"packageManager": {
"const": "yarn@4.9.2",
"title": "Package manager of the application"
},
"version": {
"type": "string",
"description": "Semantic version of the application",
"pattern": "^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9-]+)?$"
},
"dependencies": {
"type": "object",
"title": "The extension's source dependencies",
"description": "Source dependencies following the npm package.json dependency format."
},
"devDependencies": {
"type": "object",
"title": "The extension's source devDependencies",
"description": "Dev dependencies following the npm package.json dependency format."
},
"agents": {
"type": "array",
"description": "Optional inline agent definitions (agents are typically discovered from the agents/ folder)",
"items": {
"type": "object",
"description": "Inline agent definition",
"$ref": "https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-cli/schemas/agent.schema.json"
}
},
"objects": {
"type": "array",
"description": "Optional inline object definitions (objects are typically discovered from the objects/ folder)",
"items": {
"type": "object",
"description": "Inline object definition",
"$ref": "https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-cli/schemas/object.schema.json"
}
}
},
"examples": [
{
"standardId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Customer Support App",
"description": "Comprehensive customer support application with AI agents",
"icon": "🎧",
"version": "1.0.0",
"license": "MIT",
"engines": {
"node": "^24.5.0",
"npm": "please-use-yarn",
"yarn": ">=4.9.2"
}
}
]
}