Skip to content

Commit 66f8bb7

Browse files
authored
docs: add note clarifying pnpm support (#14896)
1 parent 6ac9524 commit 66f8bb7

File tree

5 files changed

+50
-28
lines changed

5 files changed

+50
-28
lines changed

www/apps/book/app/learn/configurations/pnpm/page.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ pnpm dlx create-medusa-app@latest
2626

2727
This guide is intended for developers who want to switch an existing Medusa project from `npm` or `yarn` to `pnpm`.
2828

29+
### Monorepo Support
30+
31+
At the moment, `pnpm` is only supported in single-package Medusa projects. If you're using a monorepo setup, these steps may not work as expected. We recommend using `yarn` or `npm` for monorepo setups until we add support for `pnpm` in monorepos.
32+
2933
---
3034

3135
<Prerequisites

www/apps/book/generated/edit-dates.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,6 @@ export const generatedEditDates = {
140140
"app/learn/best-practices/third-party-sync/page.mdx": "2025-12-03T11:48:58.209Z",
141141
"app/learn/fundamentals/api-routes/localization/page.mdx": "2026-01-06T15:51:48.131Z",
142142
"app/learn/codemods/replace-zod-imports/page.mdx": "2026-01-12T13:51:52.324Z",
143-
"app/learn/configurations/pnpm/page.mdx": "2026-01-12T13:39:17.549Z",
143+
"app/learn/configurations/pnpm/page.mdx": "2026-03-16T14:36:36.335Z",
144144
"app/learn/fundamentals/events-and-subscribers/event-priority/page.mdx": "2026-01-20T08:32:57.574Z"
145145
}

www/apps/book/public/llms-full.txt

Lines changed: 42 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2831,6 +2831,10 @@ pnpm dlx create-medusa-app@latest
28312831

28322832
This guide is intended for developers who want to switch an existing Medusa project from `npm` or `yarn` to `pnpm`.
28332833

2834+
### Monorepo Support
2835+
2836+
At the moment, `pnpm` is only supported in single-package Medusa projects. If you're using a monorepo setup, these steps may not work as expected. We recommend using `yarn` or `npm` for monorepo setups until we add support for `pnpm` in monorepos.
2837+
28342838
***
28352839

28362840
### Prerequisites
@@ -26307,7 +26311,8 @@ FROM node:20-alpine
2630726311
WORKDIR /server
2630826312

2630926313
# Copy package files and yarn config
26310-
COPY package.json yarn.lock .yarnrc.yml .yarn/releases ./
26314+
COPY package.json yarn.lock .yarnrc.yml ./
26315+
COPY .yarn/releases .yarn/releases
2631126316

2631226317
# Install all dependencies using yarn
2631326318
RUN yarn install
@@ -26577,7 +26582,7 @@ docker compose run --rm medusa pnpm medusa user -e [email protected] -p supersec
2657726582
### npm
2657826583

2657926584
```bash
26580-
docker compose run --rm medusa npx medusa user -e [email protected] -p supersecret
26585+
docker compose exec medusa npx medusa user -e [email protected] -p supersecret
2658126586
```
2658226587

2658326588
Make sure to replace `[email protected]` and `supersecret` with your desired email and password.
@@ -26993,23 +26998,35 @@ The following diagram illustrates Medusa's architecture including all its layers
2699326998

2699426999
In this chapter, you'll learn how you can use AI assistants and LLMs effectively in your Medusa development.
2699527000

26996-
## Agent Skills for Medusa
27001+
## Bloom: AI-Powered Commerce Assistant
2699727002

26998-
Medusa provides [Claude Code plugins](https://github.com/medusajs/medusa-agent-skills) to assist you in learning and building with Medusa. These plugins include skills that you can use in Claude Code, or copy into other AI tools that support custom skills.
27003+
[Bloom](https://bloom.medusajs.com/) is an AI-powered commerce assistant built by Medusa to help you build, manage, and scale your ecommerce store.
2699927004

27000-
If you use AI agents in your development workflow, our team recommends installing these plugins to enhance your development experience with Medusa.
27005+
Bloom has the ecommerce expertise to build your store following best practices and using Medusa's rich commerce features. You can build a complete ecommerce store that has a storefront, admin dashboard, and backend with a single prompt.
2700127006

27002-
The following sections explain how to use the plugins with Claude Code or other AI agents.
27007+
Bloom helps you design your store, implement custom features, integrate third-party services, and more. It's ideal for:
2700327008

27004-
|Plugin|Description|Example Prompt|
27005-
|---|---|---|
27006-
|\`medusa-dev\`|Knowledge to help you build Medusa features, fix bugs, and more.|Implement a product reviews feature.|
27007-
|\`ecommerce-storefront\`|Knowledge to help you build storefronts for any ecommerce platform, including Medusa.|Implement a product reviews feature.|
27008-
|\`learn-medusa\`|An interactive learning experience to learn Medusa concepts step-by-step by building a brands feature.|I want to learn Medusa.|
27009+
1. **Developers:** Build showcases for business ideas, speed up store development, and focus on advanced customizations.
27010+
2. **Side Hustlers:** Start your ecommerce journey with minimal investment.
27011+
3. **Business Owners:** Launch your online store quickly without technical expertise.
27012+
4. **Designers:** Build production-ready storefronts with your unique design vision.
27013+
5. **Marketers:** Test new store concepts and campaigns rapidly.
27014+
27015+
Go to [Bloom](https://bloom.medusajs.com/) to get started. You'll start with free credits to try out Bloom's features and upgrade your plan as needed.
27016+
27017+
***
27018+
27019+
## Agent Skills for Medusa
27020+
27021+
Medusa provides [agent skills](https://github.com/medusajs/medusa-agent-skills) to assist you in learning and building with Medusa. You can use them as plugins in Claude Code, or copy them into other AI tools that support custom skills.
27022+
27023+
If you use AI agents in your development workflow, our team recommends installing these skills to enhance your development experience with Medusa.
27024+
27025+
The following sections explain how to use the skills with Claude Code or other AI agents.
2700927026

2701027027
### Medusa Development Assistance
2701127028

27012-
If you want assistance in your Medusa development, install the `medusa-dev` plugin:
27029+
If you want assistance in your Medusa development, install the `medusa-dev` plugin and its skills:
2701327030

2701427031
### Claude Code
2701527032

@@ -27084,7 +27101,7 @@ Add a megamenu to the storefront's header that displays product categories and s
2708427101

2708527102
### Interactive Learning
2708627103

27087-
If you're a Medusa beginner, install the `learn-medusa` plugin to start an interactive learning experience:
27104+
If you're a Medusa beginner, install the `learn-medusa` plugin or its skill to start an interactive learning experience:
2708827105

2708927106
### Claude Code
2709027107

@@ -27169,12 +27186,14 @@ For example, you can ask:
2716927186

2717027187
The Medusa documentation includes an AI Assistant that answers your questions and helps you build customizations with Medusa.
2717127188

27189+
The AI Assistant in the docs is different from [Bloom](https://bloom.medusajs.com/), our AI-powered commerce assistant that helps you build, manage, and scale your ecommerce store. The AI Assistant in the docs is specifically designed to help you with Medusa development by providing relevant documentation links, code snippets, and explanations.
27190+
2717227191
### Open the AI Assistant
2717327192

2717427193
To open the AI Assistant, either:
2717527194

2717627195
- Use the keyboard shortcut `Ctrl + I` for Windows/Linux, or `Cmd + I` for macOS.
27177-
- Click the <InlineIcon Icon={AiAssistent} alt="AI Assistant" /> icon in the top right corner of the documentation.
27196+
- Click the <InlineIcon Icon={BloomIcon} alt="Bloom" /> icon in the top right corner of the documentation.
2717827197

2717927198
You can then ask the AI Assistant any questions about Medusa, such as:
2718027199

@@ -27187,13 +27206,13 @@ The AI Assistant will provide you with relevant documentation links, code snippe
2718727206

2718827207
### Ask About Code Snippets
2718927208

27190-
While browsing the documentation, you'll find a <InlineIcon Icon={AiAssistentLuminosity} alt="AI Assistant" /> icon in the header of code snippets. You can click this icon to ask the AI Assistant about the code snippet.
27209+
While browsing the documentation, you'll find a <InlineIcon Icon={BloomIcon} alt="Bloom" /> icon in the header of code snippets. You can click this icon to ask the AI Assistant about the code snippet.
2719127210

2719227211
The AI Assistant will analyze the code and provide explanations, usage examples, and any additional information you need to understand how the code works.
2719327212

2719427213
### Ask About Documentation Pages
2719527214

27196-
If you need more help understanding a specific documentation page, you can click the "Explain with AI Assistant" link in the page's right sidebar. This will open the AI Assistant and provide context about the current page, allowing you to ask questions related to the content.
27215+
If you need more help understanding a specific documentation page, you can click the "Explain this page" link in the page's right sidebar. This will open the AI Assistant and provide context about the current page, allowing you to ask questions related to the content.
2719727216

2719827217
### Formatting and Code Blocks
2719927218

@@ -50841,7 +50860,7 @@ Connection to Redis in module 'workflow-engine-redis' established
5084150860
- [setTaxRateRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/setTaxRateRulesWorkflow/index.html.md)
5084250861
- [updateTaxRatesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateTaxRatesWorkflow/index.html.md)
5084350862
- [updateTaxRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateTaxRegionsWorkflow/index.html.md)
50844-
- [batchTranslationSettingsWorkflow](https://docs.medusajs.com/references/core_flows/Translation/Workflows_Translation/functions/core_flows.Translation.Workflows_Translation.batchTranslationSettingsWorkflow/index.html.md)
50863+
- [batchTranslationSettingsWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchTranslationSettingsWorkflow/index.html.md)
5084550864
- [batchTranslationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchTranslationsWorkflow/index.html.md)
5084650865
- [createTranslationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createTranslationsWorkflow/index.html.md)
5084750866
- [deleteTranslationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteTranslationsWorkflow/index.html.md)
@@ -51060,7 +51079,7 @@ Connection to Redis in module 'workflow-engine-redis' established
5106051079
- [deleteProductVariantsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductVariantsStep/index.html.md)
5106151080
- [deleteProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductsStep/index.html.md)
5106251081
- [dismissProductVariantsInventoryStep](https://docs.medusajs.com/references/medusa-workflows/steps/dismissProductVariantsInventoryStep/index.html.md)
51063-
- [exportProductsStep](https://docs.medusajs.com/references/core_flows/Product/Steps_Product/functions/core_flows.Product.Steps_Product.exportProductsStep/index.html.md)
51082+
- [exportProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/exportProductsStep/index.html.md)
5106451083
- [generateProductCsvStep](https://docs.medusajs.com/references/medusa-workflows/steps/generateProductCsvStep/index.html.md)
5106551084
- [getAllProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getAllProductsStep/index.html.md)
5106651085
- [getProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getProductsStep/index.html.md)
@@ -51137,11 +51156,11 @@ Connection to Redis in module 'workflow-engine-redis' established
5113751156
- [listTaxRateRuleIdsStep](https://docs.medusajs.com/references/medusa-workflows/steps/listTaxRateRuleIdsStep/index.html.md)
5113851157
- [updateTaxRatesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateTaxRatesStep/index.html.md)
5113951158
- [updateTaxRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateTaxRegionsStep/index.html.md)
51140-
- [createTranslationSettingsStep](https://docs.medusajs.com/references/core_flows/Translation/Steps_Translation/functions/core_flows.Translation.Steps_Translation.createTranslationSettingsStep/index.html.md)
51159+
- [createTranslationSettingsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createTranslationSettingsStep/index.html.md)
5114151160
- [createTranslationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createTranslationsStep/index.html.md)
51142-
- [deleteTranslationSettingsStep](https://docs.medusajs.com/references/core_flows/Translation/Steps_Translation/functions/core_flows.Translation.Steps_Translation.deleteTranslationSettingsStep/index.html.md)
51161+
- [deleteTranslationSettingsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteTranslationSettingsStep/index.html.md)
5114351162
- [deleteTranslationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteTranslationsStep/index.html.md)
51144-
- [updateTranslationSettingsStep](https://docs.medusajs.com/references/core_flows/Translation/Steps_Translation/functions/core_flows.Translation.Steps_Translation.updateTranslationSettingsStep/index.html.md)
51163+
- [updateTranslationSettingsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateTranslationSettingsStep/index.html.md)
5114551164
- [updateTranslationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateTranslationsStep/index.html.md)
5114651165
- [validateTranslationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateTranslationsStep/index.html.md)
5114751166
- [createUsersStep](https://docs.medusajs.com/references/medusa-workflows/steps/createUsersStep/index.html.md)
@@ -96418,6 +96437,7 @@ Start by adding the necessary imports at the top of `src/admin/routes/reviews/pa
9641896437
import {
9641996438
createDataTableCommandHelper,
9642096439
DataTableRowSelectionState,
96440+
toast
9642196441
} from "@medusajs/ui"
9642296442
```
9642396443

@@ -133259,7 +133279,6 @@ Download this reference as an OpenApi YAML file. You can import this file to too
133259133279
- [GET /admin/gift-cards/{id}](https://docs.medusajs.com/api/admin#gift-cards_getgiftcardsid)
133260133280
- [POST /admin/gift-cards/{id}](https://docs.medusajs.com/api/admin#gift-cards_postgiftcardsid)
133261133281
- [GET /admin/gift-cards/{id}/orders](https://docs.medusajs.com/api/admin#gift-cards_getgiftcardsidorders)
133262-
- [POST /admin/gift-cards/{id}/redeem](https://docs.medusajs.com/api/admin#gift-cards_postgiftcardsidredeem)
133263133282
- [GET /admin/index/details](https://docs.medusajs.com/api/admin#index_getindexdetails)
133264133283
- [POST /admin/index/sync](https://docs.medusajs.com/api/admin#index_postindexsync)
133265133284
- [GET /admin/inventory-items](https://docs.medusajs.com/api/admin#inventory-items_getinventoryitems)
@@ -133483,7 +133502,6 @@ Download this reference as an OpenApi YAML file. You can import this file to too
133483133502
- [GET /admin/tax-regions/{id}](https://docs.medusajs.com/api/admin#tax-regions_gettaxregionsid)
133484133503
- [POST /admin/tax-regions/{id}](https://docs.medusajs.com/api/admin#tax-regions_posttaxregionsid)
133485133504
- [DELETE /admin/tax-regions/{id}](https://docs.medusajs.com/api/admin#tax-regions_deletetaxregionsid)
133486-
- [GET /admin/transaction-groups](https://docs.medusajs.com/api/admin#transaction-groups_gettransactiongroups)
133487133505
- [GET /admin/translations](https://docs.medusajs.com/api/admin#translations_gettranslations)
133488133506
- [POST /admin/translations/batch](https://docs.medusajs.com/api/admin#translations_posttranslationsbatch)
133489133507
- [GET /admin/translations/entities](https://docs.medusajs.com/api/admin#translations_gettranslationsentities)
@@ -133563,7 +133581,6 @@ Download this reference as an OpenApi YAML file. You can import this file to too
133563133581
- [POST /store/customers/me/addresses/{address_id}](https://docs.medusajs.com/api/store#customers_postcustomersmeaddressesaddress_id)
133564133582
- [DELETE /store/customers/me/addresses/{address_id}](https://docs.medusajs.com/api/store#customers_deletecustomersmeaddressesaddress_id)
133565133583
- [GET /store/gift-cards/{idOrCode}](https://docs.medusajs.com/api/store#gift-cards_getgiftcardsidorcode)
133566-
- [POST /store/gift-cards/{idOrCode}/redeem](https://docs.medusajs.com/api/store#gift-cards_postgiftcardsidorcoderedeem)
133567133584
- [GET /store/locales](https://docs.medusajs.com/api/store#locales_getlocales)
133568133585
- [GET /store/orders](https://docs.medusajs.com/api/store#orders_getorders)
133569133586
- [GET /store/orders/{id}](https://docs.medusajs.com/api/store#orders_getordersid)
@@ -160810,7 +160827,7 @@ import {
160810160827
defineMiddlewares,
160811160828
validateAndTransformBody,
160812160829
} from "@medusajs/framework/http"
160813-
import { CreateTicketProductSchema } from "./admin/ticket-products/route"
160830+
import { CreateVenueSchema } from "./admin/venues/route"
160814160831

160815160832
export default defineMiddlewares({
160816160833
routes: [

www/apps/resources/app/troubleshooting/pnpm/page.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ export const metadata = {
88

99
<Note>
1010

11-
Medusa supports `pnpm` as of [v2.13.0](https://github.com/medusajs/medusa/releases/tag/v2.13.0). Refer to the [Use pnpm with Medusa](!docs!/learn/configurations/pnpm) guide for instructions on how to set up `pnpm` in your Medusa project.
11+
- Medusa supports `pnpm` as of [v2.13.0](https://github.com/medusajs/medusa/releases/tag/v2.13.0). Refer to the [Use pnpm with Medusa](!docs!/learn/configurations/pnpm) guide for instructions on how to set up `pnpm` in your Medusa project.
12+
- At the moment, `pnpm` is only supported in single-package Medusa projects. If you're using a monorepo setup, these steps may not work as expected. We recommend using `yarn` or `npm` for monorepo setups until we add support for `pnpm` in monorepos.
1213

1314
</Note>
1415

www/apps/resources/generated/edit-dates.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6559,7 +6559,7 @@ export const generatedEditDates = {
65596559
"references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getToken/page.mdx": "2025-08-14T12:59:55.678Z",
65606560
"app/commerce-modules/order/draft-orders/page.mdx": "2025-12-10T15:06:37.701Z",
65616561
"app/troubleshooting/scheduled-job-not-running/page.mdx": "2025-12-04T14:15:34.338Z",
6562-
"app/troubleshooting/pnpm/page.mdx": "2026-01-12T13:41:26.196Z",
6562+
"app/troubleshooting/pnpm/page.mdx": "2026-03-16T14:36:54.157Z",
65636563
"app/how-to-tutorials/tutorials/product-feed/page.mdx": "2026-01-12T12:22:16.122Z",
65646564
"app/storefront-development/cart/manage-promotions/page.mdx": "2025-09-11T14:11:40.904Z",
65656565
"app/recipes/ticket-booking/examples/page.mdx": "2025-09-10T14:11:55.063Z",

0 commit comments

Comments
 (0)