build Command - Medusa CLI Reference

Create a standalone build of the Medusa application.

This creates a build that:

  • Doesn't rely on the source TypeScript files.
  • Can be copied to a production server reliably.

The build is outputted to a new .medusa/server directory.

Terminal
npx medusa build

Refer to this section for next steps.

Options#

OptionDescription

--admin-only

Whether to only build the admin to host it separately. If this option is not passed, the admin is built to the .medusa/server/public/admin. When this option is passed, the admin is built to the .medusa/admin directory instead.


Run Built Medusa Application#

After running the build command, use the following step to run the built Medusa application:

  • Change to the .medusa/server directory and install the dependencies:
  • When running the application locally, make sure to copy the .env file from the root project's directory. In production, use system environment variables instead.
  • In the system environment variables, set NODE_ENV to production:
Terminal
NODE_ENV=production
  • Use the start command to run the application:

Build Medusa Admin#

By default, the Medusa Admin is built to the .medusa/server/public/admin directory.

If you want a separate build to host the admin standalone, such as on Vercel, pass the --admin-only option as explained in the Options section. This outputs the admin to the .medusa/admin directory instead.

Was this page helpful?
Edit this page
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break