docs: document create-medusa-app new project name argument (#10834)

2025-01-07 15:02:55 +02:00
parent 936954e0b4
commit ff3df907ce
4 changed files with 29 additions and 6 deletions
@@ -35,9 +35,32 @@ The `create-medusa-app` CLI tool simplifies the process of creating a new Medusa
 ## Usage

 ```bash
-npx create-medusa-app@latest
+npx create-medusa-app@latest [project-name]
 ```

+### Arguments
+
+<Table>
+  <Table.Header>
+    <Table.Row>
+      <Table.HeaderCell>Option</Table.HeaderCell>
+      <Table.HeaderCell>Description</Table.HeaderCell>
+    </Table.Row>
+  </Table.Header>
+  <Table.Body>
+    <Table.Row>
+      <Table.Cell>
+
+        `project-name`
+
+      </Table.Cell>
+      <Table.Cell>
+        The name of the project's directory and PostgreSQL database to be created. For example, `my-medusa-store`. If not provided, you'll be prompted to enter a project name.
+      </Table.Cell>
+    </Table.Row>
+  </Table.Body>
+</Table>
+
 ### Command Options

 <Table>
@@ -100,7 +100,7 @@ export const generatedEditDates = {
  "app/commerce-modules/user/page.mdx": "2024-12-25T16:24:26.837Z",
  "app/commerce-modules/page.mdx": "2024-12-23T14:38:21.064Z",
  "app/contribution-guidelines/docs/page.mdx": "2024-12-12T11:06:12.250Z",
-  "app/create-medusa-app/page.mdx": "2024-08-05T11:10:55+03:00",
+  "app/create-medusa-app/page.mdx": "2025-01-06T09:14:55.483Z",
  "app/deployment/admin/vercel/page.mdx": "2024-10-16T08:10:29.377Z",
  "app/deployment/medusa-application/railway/page.mdx": "2024-11-11T11:50:10.517Z",
  "app/deployment/storefront/vercel/page.mdx": "2025-01-06T12:19:31.142Z",