asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: updates for v1.19 (#5868)

Browse Source 
* docs: updates for v1.19

* Update www/apps/docs/content/upgrade-guides/medusa-core/1-19.mdx

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>

* Update www/apps/docs/content/upgrade-guides/medusa-core/1-19.mdx

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
Shahed Nasser
2023-12-14 15:52:41 +01:00
committed by GitHub
co-authored by Oli Juhl
parent 9623fcafe6
commit a6c8490fc3
6 changed files with 102 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/cli/reference.mdx
+28 -10
View File
@@ -127,11 +127,11 @@ medusa new [<backend_name> [<starter_url>]]
| `--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. |
| `--db-user <user>` | The database user to use for database setup and migrations. |
| `--db-database <database>` | The database used for database setup and migrations. |
| `--db-pass <password>` | The database password to use for database setup and migrations. |
| `--db-port <port>` | The database port to use for database setup and migrations. |
| `--db-host <host>` | The database host to use for database setup and migrations. |
### develop
@@ -145,8 +145,8 @@ medusa develop
| Name | Description |
| --- | --- |
| `-H`, `--host` | Set host. Defaults to localhost. |
| `-p`, `--port` | Set port. Defaults to 9000. |
| `-H <host>`, `--host <host>` | Set host. Defaults to `localhost`. |
| `-p <port>`, `--port <port>` | Set port. Defaults to `9000`. |
### start
@@ -160,8 +160,8 @@ medusa start
| Name | Description |
| --- | --- |
| `-H`, `--host` | Set host. Defaults to localhost. |
| `-p`, `--port` | Set port. Defaults to 9000. |
| `-H <host>`, `--host <host>` | Set host. Defaults to `localhost`. |
| `-p <port>`, `--port <port>` | Set port. Defaults to `9000`. |
### migrations
@@ -189,7 +189,7 @@ medusa seed --seed-file=<file_path>
| Name | Description |
| --- | --- |
| `-f`, `--seed-file` | Path to the file where the seed is defined. (required) |
| `-f=<file_path>`, `--seed-file=<file_path>` | 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
@@ -209,6 +209,24 @@ medusa user --email <email> [--password <password>]
| `-i <id>`, `--id <id>` | The user’s ID. By default it is automatically generated. |
| `--invite` | Whether to create an invite instead of a user. When using this option, you don't need to specify a password. If ran successfully, you'll receive the invite token in the output. |
### start-cluster
Starts the Medusa backend in [cluster mode](https://expressjs.com/en/advanced/best-practice-performance.html#run-your-app-in-a-cluster). Running in cluster mode will likely significantly improve performance as the workload and tasks are distributed among all available instances instead of a single one.
```bash
medusa start-cluster
```
#### Options
| Name | Description |
| --- | --- |
| `--cpus <number>` | The number of CPUs that Medusa can consume. By default, Medusa will try to consume all CPUs in cluster mode if this option isn't specified. |
| `--cpus <number>` | The number of CPUs that Medusa can consume. By default, Medusa will try to consume all CPUs in cluster mode if this option isn't specified. |
| `-c <number>`, `--cpus <number>` | The number of CPUs that Medusa can consume. By default, Medusa will try to consume all CPUs in cluster mode if this option isn't specified. |
| `-H <host>`, `--host <host>` | Set host. Defaults to `localhost`. |
| `-p <port>`, `--port <port>` | Set port. Defaults to `9000`. |
### 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.