Scaffold an Adobe Commerce module
scaffold-moduleGenerate registration.php, etc/module.xml, and composer.json for a new Adobe Commerce module; returns file paths and contents for you to write, without writing to disk.
Instructions
Generate registration.php, etc/module.xml and composer.json for a new Adobe Commerce module (Vendor_Module), adapted from the official docs. Returns the files (path and content) for the caller to write; the server never writes to disk. Use it when starting a module.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| php | No | PHP constraint for composer.json require (e.g. "~8.3.0||~8.4.0"). Omitted when not given. | |
| module | Yes | Module name as Vendor_Module (e.g. "Acme_Reviews"), as registered in registration.php | |
| license | No | composer.json license list (default ["proprietary"]) | |
| version | No | composer.json version (default "1.0.0") | |
| basePath | No | Module directory relative to the Commerce root (default "app/code/<Vendor>/<Module>") | |
| sequence | No | Modules that must load before this one, for <sequence> in module.xml (e.g. ["Magento_Catalog"]) | |
| description | No | composer.json description | |
| packageName | No | Composer package name (default "<vendor>/module-<module>", lowercase) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| files | Yes | Files to write. The server never writes to disk. | |
| notes | Yes | Next steps and caveats |