A CLI tool to quickly scaffold a Medusa plugin and example projects in a ready-to-develop monorepo structure.

create-medusa-plugin uses the official create-medusa-app under the hood to scaffold Medusa projects—including the plugin, backend and storefront folders. This ensures your setup follows official best practices and remains fully compatible with the Medusa ecosystem by leveraging the official Medusa app generator.

Terminal
npx create-medusa-plugin [plugin-name] [options]

Replace [plugin-name] with your desired plugin name.

---

Terminal
npx create-medusa-plugin

This command will prompt you for the plugin name and other configuration options interactively.

Terminal
npx create-medusa-plugin my-plugin -r my-plugin-monorepo -e my-plugin-example --skip-example-db

This command scaffolds the following monorepo structure, installing the Medusa projects within it:

Monorepo structure
1|
2└── my-plugin-monorepo/
3    ├── examples/
4    │   └── my-plugin-example/
5    │      ├── medusa/
6    │      └── medusa-storefront/
7    ├── packages/
8    │   └── my-plugin/
9    ├── package.json
10    └── README.md

Terminal
npx create-medusa-plugin @my-scope/my-plugin -r my-plugin-monorepo -e my-plugin-example --skip-example-db

This command scaffolds the following monorepo structure, placing your scoped plugin in a nested folder under packages and installing the Medusa projects within it:

Monorepo structure
1|
2└── my-plugin-monorepo/
3    ├── examples/
4    │   └── my-plugin-example/
5    │      ├── medusa/
6    │      └── medusa-storefront/
7    ├── packages/
8    │   └── @my-scope/
9    │      └── my-plugin/
10    ├── package.json
11    └── README.md