Labsco
medusajs logo

mcloud-projects

โ˜… 195

by medusajs ยท part of medusajs/medusa-agent-skills

Execute mcloud projects commands to list, get, or delete Cloud projects. Use when discovering projects, resolving project handles by name, or retrieving project details including linked environments.

๐Ÿ”ฅ๐Ÿ”ฅ๐Ÿ”ฅโœ“ VerifiedFreeQuick setup
๐Ÿงฉ One of 7 skills in the medusajs/medusa-agent-skills package โ€” works on its own, and pairs well with its siblings.

This is the playbook your agent receives when the skill activates โ€” you don't need to read it to use the skill, but it's here to audit before installing.

Cloud CLI: Projects Commands

Execute mcloud projects commands to manage Cloud projects.

Constraints

  • projects delete is irreversible โ€” removes all associated environments, deployments, and resources. Always confirm the project ID/handle before deleting.
  • Use --yes with delete in non-interactive contexts (scripts, pipelines, agents).

Commands

projects list

List projects in an organization. If --organization is omitted (and no active context org is set), lists projects across all organizations you have access to, grouped by organization.

mcloud projects list --organization <org-id> --json

Options:

  • -o/--organization <id> โ€” Organization ID (falls back to active context; if unset, lists across all your organizations)
  • --json โ€” Output as JSON

projects get

Retrieve a single project by its ID or handle.

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

Arguments:

  • project โ€” Project ID or handle (required)

Options:

  • -o/--organization <id> โ€” Organization ID (falls back to active context; required)
  • --json โ€” Output as JSON

projects delete

Delete a project by its ID or handle. Irreversible.

mcloud projects delete <project-id-or-handle> \
  --organization <org-id> \
  --yes

Arguments:

  • project โ€” Project ID or handle (required)

Options:

  • -o/--organization <id> โ€” Organization ID (falls back to active context; required)
  • -y/--yes โ€” Skip confirmation prompt (required in non-interactive mode)
  • --json โ€” Output as JSON

Project Fields (JSON)

FieldDescription
idProject ID
handleURL-safe project handle (used in most commands)
nameDisplay name
statusready when healthy
regionDeployment region (e.g. us-east-1)
repositoryLinked GitHub repository (owner/repo)
root_pathRoot path within the repository
organizationOwning organization (id, name, created_at)
environmentsArray of associated environments (each may include storefront_environments)

Examples

# List all projects in an organization
mcloud projects list --organization org_123 --json

# Set context to a project by name
PROJECT_HANDLE=$(
  mcloud projects list --organization org_123 --json \
    | jq -r '.[] | select(.name == "My Store") | .handle'
)
mcloud use --project "$PROJECT_HANDLE"

# Get project details including environments
mcloud projects get my-store --organization org_123 --json

# List all environment handles for a project
mcloud projects get my-store --organization org_123 --json \
  | jq -r '.environments[].handle'

# Find project handle by name
mcloud projects list --organization org_123 --json \
  | jq -r '.[] | select(.name == "My Store") | .handle'

# Delete a project (irreversible โ€” confirm before running)
mcloud projects delete old-project --organization org_123 --yes