- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
create-medusa-app CLI Tool
The create-medusa-app
CLI tool simplifies the process of creating a new Medusa project and provides an onboarding experience.
Usage#
Command Options#
Option | Description | Default |
---|---|---|
| The repository URL to create the project from. |
|
| Whether to seed the database with demo data. |
|
| Disables opening the browser at the end of the project creation and only shows success message. |
|
| Skips creating the database, running migrations, and seeding, and subsequently skips opening the browser. Useful if you want to set the database URL with the |
|
| Skips database creation and sets the database URL to the provided URL. Throws an error if connection to the database fails. Will still run migrations and open the admin after project creation. Useful if you already have a database created, locally or remotely. | - |
| Skips running migrations, creating admin user, and seeding. If used, it's expected that you pass the |
|
| Allows specifying the parent directory path to create the directory of the new project in. | The current directory the command is running in. |
| Installs the Next.js Starter storefront under the |
|
| Shows detailed logs. Useful when you're reporting an issue with the tool. |
|
| Installs Medusa v2, which is still not ready for production. |
|
Examples#
Connect to a Vercel PostgreSQL Database#
To use a PostgreSQL database hosted on Vercel, use the --db-url
option and add to the end of your connection URL ?sslmode=require
. For example:
Connect to a Supabase Database#
To connect to a Supabase database, use the --db-url
option with its value being the connection URL to your Supabase database. For example: