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.

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

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

• Basic usage

  npx create-medusa-plugin

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

• With options

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

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

  /
  └── my-plugin-monorepo/
      ├── examples/
      │   └── my-plugin-example/
      │      ├── medusa/
      │      └── medusa-storefront/
      ├── packages/
      │   └── my-plugin/
      ├── package.json
      └── README.md

• With a plugin scope

  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:

  /
  └── my-plugin-monorepo/
      ├── examples/
      │   └── my-plugin-example/
      │      ├── medusa/
      │      └── medusa-storefront/
      ├── packages/
      │   └── @my-scope/
      │      └── my-plugin/
      ├── package.json
      └── README.md