docs: publish restructure (#3496)
* 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
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
---
|
||||
description: 'Learn how to install the Medusa CLI Tool. Medusa CLI Tool can be used to perform actions such as create a new Medusa server, run migrations, create a new admin user, and more.'
|
||||
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
|
||||
@@ -10,7 +10,7 @@ This document serves as a reference to the Medusa CLI tool including how to inst
|
||||
|
||||
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.
|
||||
To use Medusa, it is required to install the CLI tool as it is used to create a new Medusa backend.
|
||||
|
||||
---
|
||||
|
||||
@@ -57,7 +57,7 @@ Turn on verbose output for detailed logs.
|
||||
**Default:** `false`
|
||||
|
||||
```bash
|
||||
medusa new test-server --verbose
|
||||
medusa new my-backend --verbose
|
||||
```
|
||||
|
||||
### --no-color
|
||||
@@ -69,7 +69,7 @@ Turn off colors in the output.
|
||||
**Default:** `false`
|
||||
|
||||
```bash
|
||||
medusa new test-server --no-color
|
||||
medusa new my-backend --no-color
|
||||
```
|
||||
|
||||
### --json
|
||||
@@ -79,7 +79,7 @@ Turn on JSON logger.
|
||||
**Default:** `false`
|
||||
|
||||
```bash
|
||||
medusa new test-server --json
|
||||
medusa new my-backend --json
|
||||
```
|
||||
|
||||
### --version
|
||||
@@ -98,18 +98,18 @@ medusa --version
|
||||
|
||||
### new
|
||||
|
||||
Create a new Medusa server.
|
||||
Create a new Medusa backend.
|
||||
|
||||
```bash
|
||||
medusa new [<server_name> [<starter_url>]]
|
||||
medusa new [<backend_name> [<starter_url>]]
|
||||
```
|
||||
|
||||
#### Arguments
|
||||
|
||||
| Name | Description | Default |
|
||||
| --- | --- | --- |
|
||||
| `server_name` | 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_url` | The URL of the starter to create the server from. | The default starter is used. |
|
||||
| `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
|
||||
|
||||
@@ -128,7 +128,7 @@ medusa new [<server_name> [<starter_url>]]
|
||||
|
||||
### develop
|
||||
|
||||
Start development server. This command watches files for any changes to rebuild the files and restart the server.
|
||||
Start development backend. This command watches files for any changes to rebuild the files and restart the backend.
|
||||
|
||||
```bash
|
||||
medusa develop
|
||||
@@ -143,7 +143,7 @@ medusa develop
|
||||
|
||||
### start
|
||||
|
||||
Start development server. This command does not watch for file changes or restart the server.
|
||||
Start development backend. This command does not watch for file changes or restart the backend.
|
||||
|
||||
```bash
|
||||
medusa start
|
||||
@@ -220,5 +220,5 @@ medusa telemetry
|
||||
|
||||
## See Also
|
||||
|
||||
- [Configure your Medusa server](../usage/configurations.md)
|
||||
- [Set up your development environment](../tutorial/0-set-up-your-development-environment.mdx)
|
||||
- [Configure Medusa](../development/backend/configurations.md)
|
||||
- [Set up your development environment](../development/backend/prepare-environment.mdx)
|
||||
|
||||
Reference in New Issue
Block a user