using-medusa-cloud
Managing Medusa Cloud Resources
Operational guide for AI agents managing Medusa Cloud infrastructure through the mcloud CLI. Covers setup, deployments, debugging, environments, and variables.
Constraints
- Always pass
--jsonwhen parsing CLI output. Plaintext output is for humans and may change without warning. - Confirm context before mutating. Run
mcloud whoami --jsonbefore any state change. - Read before you write. Run a
getorlistbefore anydelete,redeploy, ortrigger-build. - Use
--yesfor destructive operations.deletecommands require--yesin non-interactive mode. - Production environments cannot be deleted.
mcloud environments deleteerrors on production by design. - Never pass
--revealunless the user explicitly asks. Secret values appear in terminal scrollback and logs. --jsonand--followare incompatible. Use bounded time windows (--from/--to) with--jsonfor programmatic log ingestion.
CRITICAL: Load Reference Files When Needed
Load these references based on what you're doing:
- Setting up the CLI? → MUST load
setup.mdfirst - Debugging a failed deployment? → MUST load
debugging-deployments.mdfirst - Managing environments or variables? → MUST load
environments-and-variables.mdfirst
Minimum requirement: Load at least one reference file before executing multi-step workflows.
Quick Reference
Authentication Check
Always verify auth and scope before mutating state:
mcloud whoami --json | jq -e '.auth.kind != "none" and .organization.id != null'
Exit code 0 = authenticated and scoped. Non-zero = stop and ask the user.
Set Context Once
mcloud use \
--organization org_123 \
--project proj_123 \
--environment production
CRITICAL:
mcloud usewithout flags is interactive and fails in CI/Docker/piped input. Always pass flags.
Deployment Status Routing
Route on backend_status (or storefront_status):
| Status | Meaning | Logs to check |
|---|---|---|
build-failed |
Build step failed | mcloud deployments build-logs <id> |
deployment-failed |
Runtime crashed after build | mcloud logs --deployment <id> |
timed-out |
Exceeded time budget | Both: build-logs first, then runtime logs |
Redeployment Decision
| Command | When to use |
|---|---|
mcloud environments redeploy <env> |
Fix is environment-side (variable change, infra) — reruns existing build |
mcloud environments trigger-build <env> |
Fix is in source code on the tracked branch — starts new build |
Common Pitfalls
- TTY-only commands.
mcloud login,mcloud use(without flags), anddeletewithout--yesrequire a TTY. They fail in CI, Docker, or piped input. MCLOUD_TOKENprecedence. When set, file-based credentials are ignored andmcloud loginis rejected. Unset it to switch accounts.- Personal vs org access keys. Personal keys require
--organization; org keys are pre-scoped. organizations listrequires personal auth. Org access keys return 401 on this command.- Build IDs vs deployment IDs.
depl_*= deployment ID; anything else = build ID (resolved to latest deployment).mcloud logs --deploymentaccepts both; other commands take build IDs only.
Reference Files
setup.md - CLI installation, authentication, context setup
debugging-deployments.md - Build/deployment failure recipes and log analysis
environments-and-variables.md - Environment lifecycle and variable management
More from medusajs/medusa-claude-plugins
building-with-medusa
Load automatically when planning, researching, or implementing ANY Medusa backend features (custom modules, API routes, workflows, data models, module links, business logic). REQUIRED for all Medusa backend work in ALL modes (planning, implementation, exploration). Contains architectural patterns, best practices, and critical rules that MCP servers don't provide.
105building-admin-dashboard-customizations
Load automatically when planning, researching, or implementing Medusa Admin dashboard UI (widgets, custom pages, forms, tables, data loading, navigation). REQUIRED for all admin UI work in ALL modes (planning, implementation, exploration). Contains design patterns, component usage, and data loading patterns that MCP servers don't provide.
92building-storefronts
Load automatically when planning, researching, or implementing Medusa storefront features (calling custom API routes, SDK integration, React Query patterns, data fetching). REQUIRED for all storefront development in ALL modes (planning, implementation, exploration). Contains SDK usage patterns, frontend integration, and critical rules for calling Medusa APIs.
82learning-medusa
Load automatically when user asks to learn Medusa development (e.g., "teach me how to build with medusa", "guide me through medusa", "I want to learn medusa"). Interactive guided tutorial where Claude acts as a coding bootcamp instructor, teaching step-by-step with checkpoints and verification.
52storefront-best-practices
ALWAYS use this skill when working on ecommerce storefronts, online stores, shopping sites. Use for ANY storefront component including checkout pages, cart, payment flows, product pages, product listings, navigation, homepage, or ANY page/component in a storefront. CRITICAL for adding checkout, implementing cart, integrating Medusa backend, or building any ecommerce functionality. Framework-agnostic (Next.js, SvelteKit, TanStack Start, React, Vue). Provides patterns, decision frameworks, backend integration guidance.
13new-user
Create an admin user in Medusa
10