CtrlK
BlogDocsLog inGet started
Tessl Logo
PluginPublic

adobe/aem-cloud-service

All AEM as a Cloud Service skills: component development, Workflow model design, development, triggering, launchers, debugging, and triaging, Dispatcher config authoring, advisory, incident response, performance tuning, and security hardening, Rapid Development Environment (RDE) deployment, log inspection, snapshots, and troubleshooting via `aio aem rde`, Jackrabbit Oak query/index tuning (property, Lucene index definitions), and extracting/inventorying JCR queries (XPath, SQL2, QueryBuilder) across a codebase.

Quality

85%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Low

Low-risk findings worth noting

Overview
Quality
Evals
Security
Files

module-catalog.mdskills/ensure-agents-md/references/

Module & Add-on Catalog

Use this catalog when generating AGENTS.md. Only include entries whose directories actually exist in the project.

Core modules

ModuleDescription
coreOSGi bundle. Contains the Java code for backend services, models, and business logic. Uses OSGi for dependency injection, Sling models for exposing content to Sling scripts and JUnit for unit testing.
dispatcherContains the cloud-optimized Dispatcher configuration, including caching and security settings. Uses immutable files that are validated by the Dispatcher SDK.
ui.appsFileVault content package. Contains the application code, including components, templates, client libraries, and content structure. Uses HTL as the scripting engine.
ui.apps.structureFileVault content package. Empty module that defines the structure of the repository content.
ui.configFileVault content package. Contains OSGi configurations for the application.
ui.contentFileVault content package. Contains the mutable content for the application, such as the initial site structure, templates, sample assets.
it.testsIntegration tests module. Uses the AEM Testing clients to run tests against running AEM instances. Executed by Cloud Manager during the Custom Functional Testing step of a full stack pipeline.
ui.testsUI tests module. Uses Cypress to run end-to-end tests against running AEM instances. Executed by Cloud Manager during the Custom UI Testing step of a full stack pipeline.
allFileVault content package. Includes all other FileVault packages for easy deployment.

Frontend module variants

Only ONE of these applies per project. Match by detected frontend type.

VariantModule nameDescription
General (Webpack)ui.frontendFrontend module built with Webpack. Compiles TypeScript/JavaScript and Sass/SCSS. During the build it's copied to the ui.apps module as client libraries. Uses Node.js, npm, and webpack.
React SPAui.frontendReact-based SPA module built with Create React App. Uses @adobe/aem-react-editable-components for SPA Editor integration. During the build it's copied to the ui.apps module as client libraries. Run npm start to develop locally with a proxy to AEM (port 3000). Uses Node.js, npm, and webpack.
Angular SPAui.frontendAngular-based SPA module built with Angular CLI. Uses @adobe/aem-angular-editable-components for SPA Editor integration. During the build it's copied to the ui.apps module as client libraries. Run npm start to develop locally with a proxy to AEM (port 4200). Uses Node.js, npm, and webpack.
Decoupledui.frontendDecoupled frontend module (headless). Consumes AEM content via JSON model APIs. Deployed via the AEM as a Cloud Service Frontend Pipeline separately from backend code. No client libraries are generated in ui.apps.

Add-ons (include only if detected)

Add-onSection text for AGENTS.md
CIF (Commerce)Commerce Integration Framework (CIF): The commerce backend endpoint is configured in ui.config OSGi configurations. CIF Core Components are included for building commerce experiences (product pages, catalog, search, cart, checkout).
AEM FormsAEM Forms: Forms Core Components are provided OOTB in AEM as a Cloud Service. The project contains Adaptive Forms components, templates, themes, and configurations for building form experiences.
Headless FormsHeadless Adaptive Forms: The ui.frontend.react.forms.af module provides a React-based rendering layer for forms consumed via the form model JSON. Forms can be rendered in external applications while leveraging AEM Forms capabilities for form logic and data handling.
Precompiled ScriptsPrecompiled Scripts: HTL scripts from ui.apps are precompiled into a bundle during the build and attached as a secondary bundle artifact for improved performance.

When an add-on is detected, add a ## Add-ons and extensions section between the intro paragraph and ## Modules, listing each detected add-on as a bullet.

CIF-specific module note

If CIF is detected, append to the core module description: , including commerce-specific models and servlets.

Headless Forms module

If Headless Forms is detected, add this module to the Modules list:

  • ui.frontend.react.forms.af: React-based headless Adaptive Forms rendering module. Consumes form models and renders forms in a headless manner. Uses Node.js, npm, and webpack.

Conditional resources

Base resources (always include)

These are already in the AGENTS.md template. Always keep them.

SPA resources (React or Angular detected)

Add after the base resources:

  • SPA Editor Overview
  • Developing SPAs for AEM

If React:

If Angular:

Decoupled frontend resources

CIF resources

Forms resources

Headless Forms resources

Precompiled Scripts resources

skills

ensure-agents-md

README.md

tile.json