1decaa27c7
* docs: added features and guides overview page * added image * added version 2 * added version 3 * added version 4 * docs: implemented new color scheme * docs: redesigned sidebar (#3193) * docs: redesigned navbar for restructure (#3199) * docs: redesigned footer (#3209) * docs: redesigned cards (#3230) * docs: redesigned admonitions (#3231) * docs: redesign announcement bar (#3236) * docs: redesigned large cards (#3239) * docs: redesigned code blocks (#3253) * docs: redesigned search modal and page (#3264) * docs: redesigned doc footer (#3268) * docs: added new sidebars + refactored css and assets (#3279) * docs: redesigned api reference sidebar * docs: refactored css * docs: added code tabs transition * docs: added new sidebars * removed unused assets * remove unusued assets * Fix deploy errors * fix incorrect link * docs: fixed code responsivity + missing icons (#3283) * docs: changed icons (#3296) * docs: design fixes to the sidebar (#3297) * redesign fixes * docs: small design fixes * docs: several design fixes after restructure (#3299) * docs: bordered icon fixes * docs: desgin fixes * fixes to code blocks and sidebar scroll * design adjustments * docs: restructured homepage (#3305) * docs: restructured homepage * design fixes * fixed core concepts icon * docs: added core concepts page (#3318) * docs: restructured homepage * design fixes * docs: added core concepts page * changed text of different components * docs: added architecture link * added missing prop for user guide * docs: added regions overview page (#3327) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page (#3331) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page * fix link * resolve link issues * docs: updated regions architecture image * docs: second-iteration fixes (#3347) * docs: redesigned document * design fixes * docs: added products overview page (#3354) * docs: added carts overview page (#3363) * docs: added orders overview (#3364) * docs: added orders overview * added links in overview * docs: added vercel redirects * docs: added soon badge for cards (#3389) * docs: resolved feedback changes + organized troubleshooting pages (#3409) * docs: resolved feedback changes * added extra line * docs: changed icons for restructure (#3421) * docs: added taxes overview page (#3422) * docs: added taxes overview page * docs: fix sidebar label * added link to taxes overview page * fixed link * docs: fixed sidebar scroll (#3429) * docs: added discounts overview (#3432) * docs: added discounts overview * fixed links * docs: added gift cards overview (#3433) * docs: added price lists overview page (#3440) * docs: added price lists overview page * fixed links * docs: added sales channels overview page (#3441) * docs: added sales overview page * fixed links * docs: added users overview (#3443) * docs: fixed sidebar border height (#3444) * docs: fixed sidebar border height * fixed svg markup * docs: added possible solutions to feedback component (#3449) * docs: added several overview pages + restructured files (#3463) * docs: added several overview pages * fixed links * docs: added feature flags + PAK overview pages (#3464) * docs: added feature flags + PAK overview pages * fixed links * fix link * fix link * fixed links colors * docs: added strategies overview page (#3468) * docs: automated upgrade guide (#3470) * docs: automated upgrade guide * fixed vercel redirect * docs: restructured files in docs codebase (#3475) * docs: restructured files * docs: fixed eslint exception * docs: finished restructure loose-ends (#3493) * fixed uses of backend * docs: finished loose ends * eslint fixes * fixed links * merged master * added update instructions for v1.7.12
5.4 KiB
5.4 KiB
description
| description |
|---|
| Learn how to install the Medusa CLI Tool. Medusa CLI Tool can be used to perform actions such as create a new Medusa backend, run migrations, create a new admin user, and more. |
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 backend.
How to Install CLI Tool
To install the CLI tool, run the following command in your terminal:
npm install @medusajs/medusa-cli -g
:::note
If you run into any errors while installing the CLI tool, check out the troubleshooting guide.
:::
The CLI tool is then available under the medusa 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: -h
medusa new --help
--verbose
Turn on verbose output for detailed logs.
Default: false
medusa new my-backend --verbose
--no-color
Turn off colors in the output.
Alias: --no-colors
Default: false
medusa new my-backend --no-color
--json
Turn on JSON logger.
Default: false
medusa new my-backend --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: -v
medusa --version
Available Commands
new
Create a new Medusa backend.
medusa new [<backend_name> [<starter_url>]]
Arguments
| Name | Description | Default |
|---|---|---|
backend_name |
The name of the Medusa backend. It will be used as the name of the directory created. | If not provided, you’ll be prompted to enter it. |
starter_url |
The URL of the starter to create the backend from. | The default starter is used. |
Options
| Name | Description |
|---|---|
--seed |
If the flag is set the command will attempt to seed the database after setup. |
-y, --useDefaults |
If the flag is set the command will not interactively collect database credentials. |
--skip-db |
If the flag is set the command will not attempt to complete the database setup. |
--skip-migrations |
If the flag is set the command will not attempt to complete the database migration. |
--skip-env |
If the flag is set the command will not attempt to populate .env. |
--db-user |
The database user to use for database setup and migrations. |
--db-database |
The database used for database setup and migrations. |
--db-pass |
The database password to use for database setup and migrations. |
--db-port |
The database port to use for database setup and migrations. |
--db-host |
The database host to use for database setup and migrations. |
develop
Start development backend. This command watches files for any changes to rebuild the files and restart the backend.
medusa develop
Options
| Name | Description |
|---|---|
-H, --host |
Set host. Defaults to localhost. |
-p, --port |
Set port. Defaults to 9000. |
start
Start development backend. This command does not watch for file changes or restart the backend.
medusa start
Options
| Name | Description |
|---|---|
-H, --host |
Set host. Defaults to localhost. |
-p, --port |
Set port. Defaults to 9000. |
migrations
Migrate the database to the most recent version.
medusa migrations <action>
Arguments
| Name | Description | Default |
|---|---|---|
action |
The action to perform. Values can be run, show, or revert. run is used to run the migrations; show is used to only show what migrations are available to run; and revert 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 |
|---|---|
-f, --seed-file |
Path to the file where the seed is defined. (required) |
-m, --migrate |
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 |
|---|---|
-e, --email |
The email to create a user with. (required) |
-p, --password |
The password to use with the user. If not included, the user will not have a password. |
-i, --id |
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 |
|---|---|
--enable |
Enable telemetry (default) |
--disable |
Disable telemetry |