CLI Reference
This document serves as a reference to the Medusa CLI tool including how to install it and what commands are available.
Overview
The Medusa CLI serves as a tool that allows you to perform important commands while developing with Medusa.
To use Medusa, it is required to install the CLI tool as it is used to create a new Medusa server.
How to Install CLI Tool
To install the CLI tool, run the following command in your terminal:
- npm
- Yarn
npm install @medusajs/medusa-cli -g
Report Incorrect Code
Copy to Clipboardyarn global add @medusajs/medusa-cli
If you run into any errors while installing the CLI tool, check out the troubleshooting guide.
The CLI tool is then available under the medusaCopy to Clipboard command. You can see all commands and options with the following command:
medusa --help
Common Options
The following options can be used with all available commands.
--help
Learn more about what you can do with the CLI tool or with a specific command.
Alias: -hCopy to Clipboard
medusa new --help
--verbose
Turn on verbose output for detailed logs.
Default: falseCopy to Clipboard
medusa new test-server --verbose
--no-color
Turn off colors in the output.
Alias: --no-colorsCopy to Clipboard
Default: falseCopy to Clipboard
medusa new test-server --no-color
--json
Turn on JSON logger.
Default: falseCopy to Clipboard
medusa new test-server --json
--version
If used inside a Medusa project, the version of the Medusa CLI and Medusa project is shown. Otherwise, the version of the Medusa CLI is shown.
Alias: -vCopy to Clipboard
medusa --version
Available Commands
new
Create a new Medusa server.
medusa new [<server_name> [<starter_url>]]
Arguments
| Name | Description | Default |
|---|---|---|
server_nameCopy to Clipboard | The name of the Medusa server. It will be used as the name of the directory created. | If not provided, you’ll be prompted to enter it. |
starter_urlCopy to Clipboard | The URL of the starter to create the server from. | The default starter is used. |
Options
| Name | Description |
|---|---|
--seedCopy to Clipboard | If the flag is set the command will attempt to seed the database after setup. |
-yCopy to Clipboard, --useDefaultsCopy to Clipboard | If the flag is set the command will not interactively collect database credentials. |
--skip-dbCopy to Clipboard | If the flag is set the command will not attempt to complete the database setup. |
--skip-migrationsCopy to Clipboard | If the flag is set the command will not attempt to complete the database migration. |
--skip-envCopy to Clipboard | If the flag is set the command will not attempt to populate .env. |
--db-userCopy to Clipboard | The database user to use for database setup and migrations. |
--db-databaseCopy to Clipboard | The database used for database setup and migrations. |
--db-passCopy to Clipboard | The database password to use for database setup and migrations. |
--db-portCopy to Clipboard | The database port to use for database setup and migrations. |
--db-hostCopy to Clipboard | The database host to use for database setup and migrations. |
develop
Start development server. This command watches files for any changes to rebuild the files and restart the server.
medusa develop
Options
| Name | Description |
|---|---|
-HCopy to Clipboard, --hostCopy to Clipboard | Set host. Defaults to localhost. |
-pCopy to Clipboard, --portCopy to Clipboard | Set port. Defaults to 9000. |
start
Start development server. This command does not watch for file changes or restart the server.
medusa start
Options
| Name | Description |
|---|---|
-HCopy to Clipboard, --hostCopy to Clipboard | Set host. Defaults to localhost. |
-pCopy to Clipboard, --portCopy to Clipboard | Set port. Defaults to 9000. |
migrations
Migrate the database to the most recent version.
medusa migrations <action>
Arguments
| Name | Description | Default |
|---|---|---|
actionCopy to Clipboard | The action to perform. Values can be runCopy to Clipboard, showCopy to Clipboard, or revertCopy to Clipboard. runCopy to Clipboard is used to run the migrations; showCopy to Clipboard is used to only show what migrations are available to run; and revertCopy to Clipboard is to undo the last migration. | This argument is required and does not have a default value. |
seed
Migrates and populates the database with the provided file.
medusa seed --seed-file=<file_path>
Options
| Name | Description |
|---|---|
-fCopy to Clipboard, --seed-fileCopy to Clipboard | Path to the file where the seed is defined. (required) |
-mCopy to Clipboard, --migrateCopy to Clipboard | Flag to indicate if migrations should be run prior to seeding the database. Default is true. |
user
Creates a new admin user.
medusa user --email <email> [--password <password>]
Options
| Name | Description |
|---|---|
-eCopy to Clipboard, --emailCopy to Clipboard | The email to create a user with. (required) |
-pCopy to Clipboard, --passwordCopy to Clipboard | The password to use with the user. If not included, the user will not have a password. |
-iCopy to Clipboard, --idCopy to Clipboard | The user’s ID. By default it is automatically generated. |
telemetry
Enable or disable the collection of anonymous data usage. If no option is provided, the command will enable the collection of anonymous data usage.
medusa telemetry
Options
| Name | Description |
|---|---|
--enableCopy to Clipboard | Enable telemetry (default) |
--disableCopy to Clipboard | Disable telemetry |