aem-kit
v2.1.0
Published
AEM Enterprise Engineering Kit CLI — scaffold projects and generate components (aem / aem-kit).
Downloads
773
Readme
aem-kit
The AEM Enterprise Engineering Kit CLI — a productivity tool for enterprise AEM projects (Monolith & Multi-repo; Traditional HTL + JS Use-API, React, or Angular). Code generators, environment checks, Maven-backed deploy, and Multi-repo child scaffolding — an orchestrator that never replaces Maven or Cloud Manager.
Exposes two identical binaries: aem-kit and aem (use whichever you
prefer).
Install
Run ad-hoc with npx (no install):
npx aem-kit init # scaffold a new project
npx aem-kit component Hero # generate a component (inside a project)
npx aem-kit --helpOr add it to a project as a dev dependency, then use the short aem binary:
npm i -D aem-kit
npx aem component HeroCommands
aem init # scaffold a new project (wizard)
aem doctor # check Java / Node / Maven / git / Docker
aem component HeroBanner # HTL + Sling Model + dialog + test
aem model Product # Sling Model + test
aem servlet HealthCheck # OSGi servlet (paths) + test
aem service Greeting # interface + impl + OCD config + test
aem generators # list available generators
aem multirepo create product # generate a child brand repo (Multi-repo only)
aem deploy author # mvn clean install -PautoInstallPackage
aem deploy publish # → publish instance
aem deploy cloud # Cloud Manager pre-flight + local validate
aem package # mvn clean install (no deploy)
aem clean # mvn cleanaem multirepo create <category>
For Multi-repo projects. Generates childs/<category> from the shared
foundation, rewriting parent identity (read from .aemkit.json) and the
category name so the child inherits the General repo's styles, dialogs, base
template, and utilities instead of copying a static folder.
aem multirepo create "Retail Bank" # → childs/retail-bankaem deploy cloud
Runs a Cloud Manager pre-flight (checks for the ui.config module and a
dispatcher configuration, at the root or in general/ for Multi-repo) and then
validates the build locally with mvn clean install. Deployment itself still
goes through Cloud Manager.
The CLI resolves the project root by walking up for .aemkit.json (written by
the scaffolder) or a reactor pom.xml + core/.
Related packages
| Package | Purpose |
|---------|---------|
| @aem-kit/create-project | Scaffold a new AEM project (create-aem-enterprise) |
| aem-kit | The aem CLI (this package) |
| @aem-kit/generators | Component / model / servlet / service generators |
| @aem-kit/templates | AEM project templates (Monolith, Multi-repo, React, Angular, Spring Boot) |
| @aem-kit/shared | Shared utilities |
License
MIT
