mcpField
M
mcloud-deployments

mcloud-deployments

github.com/medusajsCloud & DevOps2341.4k installsUpdated 1w ago
Repository

About mcloud-deployments

A command guide for AI agents using the `mcloud` CLI to inspect Medusa Cloud deployments and build logs. It covers filtering, deployment details, and status-based debugging.

Key features

  1. 01List and filter deployments
  2. 02Retrieve deployment details
  3. 03Fetch build logs
  4. 04Explain deployment statuses

Use cases

  1. 01Review recent project deployments
  2. 02Filter deployments by environment or commit
  3. 03Investigate build failures

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/medusajs/medusa-agent-skills --skill mcloud-deployments

After installing, type/mcloud-deploymentsin Claude Code to confirm it loaded.

Details

From the project README

Cloud CLI: Deployments Commands

Execute mcloud deployments commands to inspect deployments and their build logs.

Constraints

  • Always pass --json when parsing output — plaintext format may change.
  • Always confirm context (mcloud whoami --json) before running commands if org/project are not already known.
  • Use --deployment IDs in the format depl_* or build IDs; build IDs resolve to their latest deployment automatically.

Commands

deployments list

List recent deployments for a project (default: 20 most recent across all environments).

mcloud deployments list --organization <org-id> --project <project-id-or-handle> --json

Options:

  • -o/--organization <id> — Organization ID (falls back to active context)
  • -p/--project <id-or-handle> — Project ID or handle (falls back to active context)
  • -e/--environment <handle> — Filter by environment handle
  • --environment-type <production|long-lived|preview> — Filter by environment type
  • --commit <sha> — Filter by Git commit SHA (full or prefix)
  • --limit <1-200> — Max results (default: 20)
  • --offset <number> — Pagination offset (default: 0)
  • --json — Output as JSON
deployments get

Retrieve a single deployment's details by ID.

mcloud deployments get <deployment-id> --organization <org-id> --project <project-id-or-handle> --json

Arguments:

  • deployment — Deployment ID (required)

Options:

  • -o/--organization <id>, -p/--project <id-or-handle>, --json
deployments build-logs

Fetch build logs for a deployment. Use this to debug build-failed status.

mcloud deployments build-logs <deployment-id> --organization <org-id> --project <project-id-or-handle>

Arguments:

  • deployment — Deployment ID (required)

Options:

  • -o/--organization <id>, -p/--project <id-or-handle>
  • --type <backend|storefront> — Which build log stream to read (default: backend)
  • --json — Output as JSON

Deployment Statuses

StatusMeaning
createdBuild not started yet
buildingBuild running
builtBuild succeeded, awaiting rollout
deployingRolling out to environment
deployedLive and serving traffic
build-failedBuild step failed — read build-logs
deployment-failedBuild succeeded, runtime crashed — read mcloud logs
timed-outExceeded time budget (backend only)
canceledSuperseded by a newer deployment
idleNo longer the active deployment

Examples

# List all deployments (with active context set)
mcloud deployments list --json

# Find most recent build-failed deployment
mcloud deployments list --json \
  | jq -r '[.[] | select(.backend_status == "build-failed")][0].id'

# Get deployment details
mcloud deployments get bld_01ABC123 --json

# Read backend build logs
mcloud deployments build-logs bld_01ABC123

# Read storefront build logs
mcloud deployments build-logs bld_01ABC123 --type storefront

# Filter deployments by commit SHA
mcloud deployments list --commit a1b2c3d --json | jq '.'

# Get deployments for a specific environment
mcloud deployments list --environment production --json

Comments

Markdown supported