@medusajs/mcloud

v0.1.13

Published

22 days ago

Medusa Cloud CLI

0High
0Medium
0Low

mcloud

Medusa Cloud CLI

Usage

$ npm install -g @medusajs/mcloud
$ mcloud COMMAND
running command...
$ mcloud (--version|-v)
@medusajs/mcloud/0.1.13 linux-x64 node-v24.5.0
$ mcloud --help [COMMAND]
USAGE
  $ mcloud COMMAND
...

Commands

`mcloud autocomplete [SHELL]`

Display autocomplete installation instructions.

USAGE
  $ mcloud autocomplete [SHELL] [-r]

ARGUMENTS
  [SHELL]  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ mcloud autocomplete

  $ mcloud autocomplete bash

  $ mcloud autocomplete zsh

  $ mcloud autocomplete powershell

  $ mcloud autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`mcloud deployments build-logs DEPLOYMENT`

Fetch deployment build logs (backend or storefront)

USAGE
  $ mcloud deployments build-logs DEPLOYMENT [--json] [-o <value>] [-p <value>] [--type backend|storefront]

ARGUMENTS
  DEPLOYMENT  Deployment / build ID

FLAGS
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)
      --type=<option>         [default: backend] Which build log stream to read
                              <options: backend|storefront>

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Fetch deployment build logs (backend or storefront)

EXAMPLES
  $ mcloud deployments build-logs build_123 --project proj_1

  $ mcloud deployments build-logs build_123 -p my-store --type storefront

See code: src/commands/deployments/build-logs.ts

`mcloud deployments get DEPLOYMENT`

Get a deployment by ID

USAGE
  $ mcloud deployments get DEPLOYMENT [--json] [-o <value>] [-p <value>]

ARGUMENTS
  DEPLOYMENT  Deployment / build ID

FLAGS
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get a deployment by ID

EXAMPLES
  $ mcloud deployments get bld_123 --project proj_1

  $ mcloud deployments get bld_123 --project my-store

See code: src/commands/deployments/get.ts

`mcloud deployments list`

List deployments for a project

USAGE
  $ mcloud deployments list [--json] [-o <value>] [-p <value>] [-e <value>] [--environment-type
    production|long-lived|preview] [--commit <value>] [--limit <value>] [--offset <value>]

FLAGS
  -e, --environment=<value>        Environment ID, handle, or name (defaults to the environment in the context
                                   configuration)
  -o, --organization=<value>       Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>            Project ID, handle, or name (defaults to the project in the context configuration)
      --commit=<value>             Filter by commit SHA (full or prefix)
      --environment-type=<option>  Filter by environment type
                                   <options: production|long-lived|preview>
      --limit=<value>              [default: 20] Max deployments to return
      --offset=<value>             Pagination offset

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List deployments for a project

EXAMPLES
  $ mcloud deployments list --project my-store

  $ mcloud deployments list -p my-store -e <env-id-or-handle>

  $ mcloud deployments list -p my-store --environment-type preview

  $ mcloud deployments list -p my-store --commit a1b2c3d

See code: src/commands/deployments/list.ts

`mcloud environments create`

Create a long-lived environment

USAGE
  $ mcloud environments create -n <value> -b <value> [--json] [-o <value>] [-p <value>] [--custom-subdomain <value>]

FLAGS
  -b, --branch=<value>            (required) Git branch this environment tracks
  -n, --name=<value>              (required) Display name for the environment
  -o, --organization=<value>      Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>           Project ID, handle, or name (defaults to the project in the context configuration)
      --custom-subdomain=<value>  Subdomain for this environment (optional)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create a long-lived environment

EXAMPLES
  $ mcloud environments create --project proj_123 --name Staging --branch develop --custom-subdomain my-app-staging

See code: src/commands/environments/create.ts

`mcloud environments delete [ENVIRONMENT]`

Delete an environment by ID or handle

USAGE
  $ mcloud environments delete [ENVIRONMENT] [--json] [-o <value>] [-p <value>] [-e <value>] [-y]

ARGUMENTS
  [ENVIRONMENT]  Environment ID, handle, or name (defaults to the environment in the context configuration)

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)
  -y, --yes                   Skip the confirmation prompt and delete the environment

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete an environment by ID or handle

EXAMPLES
  $ mcloud environments delete projenv_123 --project proj_1

  $ mcloud environments delete staging --project my-store --yes

See code: src/commands/environments/delete.ts

`mcloud environments get [ENVIRONMENT]`

Get an environment by ID or handle

USAGE
  $ mcloud environments get [ENVIRONMENT] [--json] [-o <value>] [-p <value>] [-e <value>]

ARGUMENTS
  [ENVIRONMENT]  Environment ID, handle, or name (defaults to the environment in the context configuration)

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get an environment by ID or handle

EXAMPLES
  $ mcloud environments get projenv_123 --project proj_1

  $ mcloud environments get staging --project my-store

See code: src/commands/environments/get.ts

`mcloud environments list`

List environments in a project

USAGE
  $ mcloud environments list [--json] [-o <value>] [-p <value>]

FLAGS
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List environments in a project

EXAMPLES
  $ mcloud environments list --project proj_123

  $ mcloud environments list --project my-store

See code: src/commands/environments/list.ts

`mcloud environments redeploy [ENVIRONMENT]`

Redeploy the environment using its current active deployment build

USAGE
  $ mcloud environments redeploy [ENVIRONMENT] [--json] [-o <value>] [-p <value>] [-e <value>]

ARGUMENTS
  [ENVIRONMENT]  Environment ID, handle, or name (defaults to the environment in the context configuration)

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Redeploy the environment using its current active deployment build

EXAMPLES
  $ mcloud environments redeploy --project proj_1 --environment projenv_123

  $ mcloud environments redeploy -p my-store -e staging

See code: src/commands/environments/redeploy.ts

`mcloud environments trigger-build [ENVIRONMENT]`

Start a new build for the environment from its tracked branch

USAGE
  $ mcloud environments trigger-build [ENVIRONMENT] [--json] [-o <value>] [-p <value>] [-e <value>]

ARGUMENTS
  [ENVIRONMENT]  Environment ID, handle, or name (defaults to the environment in the context configuration)

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Start a new build for the environment from its tracked branch

EXAMPLES
  $ mcloud environments trigger-build --project proj_1 --environment projenv_123

  $ mcloud environments trigger-build -p my-store -e staging

See code: src/commands/environments/trigger-build.ts

`mcloud help [COMMAND]`

Display help for mcloud.

USAGE
  $ mcloud help [COMMAND...] [-n]

ARGUMENTS
  [COMMAND...]  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for mcloud.

See code: @oclif/plugin-help

`mcloud local build`

Run Medusa Cloud build locally

USAGE
  $ mcloud local build [-o <value>] [-p <value>] [-e <value>] [-t backend|storefront] [--root-path <value>]
    [--storefront-path <value>] [--env-file <value>] [-v <value>...] [--docker-cache]

FLAGS
  -e, --environment=<value>      Environment ID, handle, or name (defaults to the environment in the context
                                 configuration)
  -o, --organization=<value>     Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>          Project ID, handle, or name (defaults to the project in the context configuration)
  -t, --type=<option>            [default: backend] Which build type to run
                                 <options: backend|storefront>
  -v, --var=<value>...           Environment variables to override in the build, in KEY=VALUE format
      --docker-cache             Enable Docker build cache. Disabled by default cause otherwise env var changes won't
                                 bust the cache.
      --env-file=<value>         .env file to use for the build. Optional: environment variables are inferred from the
                                 Cloud environment if not specified.
      --root-path=<value>        The root path of the Medusa project (relative to the repository root). Inferred from
                                 the Cloud project if not specified, or "." if a Cloud project is not found.
      --storefront-path=<value>  The path to the storefront project (relative to the repository root). Inferred from the
                                 Cloud project if not specified.

DESCRIPTION
  Run Medusa Cloud build locally

EXAMPLES
  $ mcloud local build

  $ mcloud local build --type storefront

  $ mcloud local build --var API_KEY=pk_123

See code: src/commands/local/build.ts

`mcloud login`

Authenticate with Medusa Cloud

USAGE
  $ mcloud login [--json] [-t <value>]

FLAGS
  -t, --token=<value>  Medusa Cloud API token (skips browser login)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Authenticate with Medusa Cloud

EXAMPLES
  $ mcloud login --token <token>

  $ mcloud login

See code: src/commands/login/index.ts

`mcloud logout`

Remove stored Medusa Cloud credentials

USAGE
  $ mcloud logout [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Remove stored Medusa Cloud credentials

EXAMPLES
  $ mcloud logout

See code: src/commands/logout/index.ts

`mcloud logs`

Fetch runtime logs for an environment

USAGE
  $ mcloud logs [--json] [-o <value>] [-p <value>] [-e <value>] [-f] [--limit <value>] [--from <value>]
    [--to <value>] [--search <value>] [--deployment <value>] [--source <value>...] [--metadata <value>...] [--type
    backend|storefront]

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -f, --follow                Poll for new logs (from --from or "now" at start) instead of a bounded time window
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)
      --deployment=<value>    Filter by build/deployment ID
      --from=<value>          ISO 8601 start of time range (default: 15 minutes ago, ignored with --follow)
      --limit=<value>         [default: 500] Maximum number of log lines to retrieve (ignored with --follow)
      --metadata=<value>...   Metadata "in" filter as key=value (repeatable; same key repeats merge into one filter)
      --search=<value>        Substring search
      --source=<value>...     Filter by log source
      --to=<value>            ISO 8601 end of time range (ignored with --follow)
      --type=<option>         [default: backend] Log stream type
                              <options: backend|storefront>

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Fetch runtime logs for an environment

EXAMPLES
  $ mcloud logs --project my-store --environment production

  $ mcloud logs -p proj_1 -e staging --search error --limit 100

  $ mcloud logs --follow --deployment dep_123

See code: src/commands/logs/index.ts

`mcloud organizations get [ORGANIZATION]`

Get an organization by ID

USAGE
  $ mcloud organizations get [ORGANIZATION] [--json] [-o <value>]

ARGUMENTS
  [ORGANIZATION]  Organization ID or name (defaults to the organization in the context configuration)

FLAGS
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get an organization by ID

EXAMPLES
  $ mcloud organizations get org_123

See code: src/commands/organizations/get.ts

`mcloud organizations list`

List organizations you have access to

USAGE
  $ mcloud organizations list [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List organizations you have access to

EXAMPLES
  $ mcloud organizations list

See code: src/commands/organizations/list.ts

`mcloud projects delete [PROJECT]`

Delete a project by ID or handle

USAGE
  $ mcloud projects delete [PROJECT] [--json] [-o <value>] [-p <value>] [-y]

ARGUMENTS
  [PROJECT]  Project ID, handle, or name (defaults to the project in the context configuration)

FLAGS
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)
  -y, --yes                   Skip the confirmation prompt and delete the project

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete a project by ID or handle

EXAMPLES
  $ mcloud projects delete proj_123

  $ mcloud projects delete proj_123 --yes

  $ mcloud projects delete my-store --yes

See code: src/commands/projects/delete.ts

`mcloud projects get [PROJECT]`

Get a project by ID or handle

USAGE
  $ mcloud projects get [PROJECT] [--json] [-o <value>] [-p <value>]

ARGUMENTS
  [PROJECT]  Project ID, handle, or name (defaults to the project in the context configuration)

FLAGS
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get a project by ID or handle

EXAMPLES
  $ mcloud projects get proj_123

  $ mcloud projects get my-store

See code: src/commands/projects/get.ts

`mcloud projects list`

List projects in the configured organization

USAGE
  $ mcloud projects list [--json] [-o <value>]

FLAGS
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List projects in the configured organization

EXAMPLES
  $ mcloud projects list

See code: src/commands/projects/list.ts

`mcloud signup`

Open Medusa Cloud in your browser to create an account

USAGE
  $ mcloud signup [--json] [--skip-browser]

FLAGS
  --skip-browser  Print the Medusa Cloud URL without opening a browser (for CI or headless environments)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Open Medusa Cloud in your browser to create an account

EXAMPLES
  $ mcloud signup

  $ mcloud signup --skip-browser

See code: src/commands/signup/index.ts

`mcloud use`

Select active organization, project, and environment (persisted in a context configuration file)

USAGE
  $ mcloud use [--json] [-o <value>] [-p <value>] [-e <value>] [--clear]

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)
      --clear                 Remove the persisted organization / project / environment selection

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Select active organization, project, and environment (persisted in a context configuration file)

EXAMPLES
  $ mcloud use

  $ mcloud use --organization org_1 --project my-store --environment production

  $ mcloud use --clear

See code: src/commands/use/index.ts

`mcloud variables delete VARIABLE`

Delete an environment variable by ID or key

USAGE
  $ mcloud variables delete VARIABLE [--json] [-o <value>] [-p <value>] [-e <value>] [-t backend|storefront] [-y]

ARGUMENTS
  VARIABLE  Variable ID (var_...) or key. Keys require --project and --environment.

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)
  -t, --type=<option>         [default: backend] Type of variable
                              <options: backend|storefront>
  -y, --yes                   Skip the confirmation prompt and delete the variable

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete an environment variable by ID or key

EXAMPLES
  $ mcloud variables delete API_KEY -y

  $ mcloud variables delete var_01XYZ --yes

  $ mcloud variables delete DATABASE_URL --project my-store --environment production --yes

See code: src/commands/variables/delete.ts

`mcloud variables get VARIABLE`

Get an environment variable by ID or key

USAGE
  $ mcloud variables get VARIABLE [--json] [-o <value>] [-p <value>] [-e <value>] [-t backend|storefront] [--reveal]

ARGUMENTS
  VARIABLE  Variable ID (var_...) or key. Keys require --project and --environment.

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)
  -t, --type=<option>         [default: backend] Type of variable
                              <options: backend|storefront>
      --reveal                Print the secret value in plain text (masked by default).

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get an environment variable by ID or key

EXAMPLES
  $ mcloud variables get API_KEY

  $ mcloud variables get var_01XYZ

  $ mcloud variables get API_KEY --project my-store --environment production

  $ mcloud variables get API_KEY -p my-store -e production --reveal

See code: src/commands/variables/get.ts

`mcloud variables list`

List environment variables for a project environment

USAGE
  $ mcloud variables list [--json] [-o <value>] [-p <value>] [-e <value>] [-t backend|storefront] [--reveal]
    [--include-system] [--scope build|runtime...] [--dotenv]

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)
  -t, --type=<option>         [default: backend] Type of variable
                              <options: backend|storefront>
      --dotenv                Output variables in .env file format
      --include-system        Include system variables (auto-injected by Medusa Cloud)
      --reveal                Print secret values in plain text (masked by default)
      --scope=<option>...     Scope of variables to include (defaults to both build and runtime)
                              <options: build|runtime>

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List environment variables for a project environment

EXAMPLES
  $ mcloud variables list --project my-store --environment production

  $ mcloud variables list -p my-store -e staging --reveal

See code: src/commands/variables/list.ts

`mcloud variables set [VARIABLE] [VALUE]`

Set (create/update) an environment variable by ID or key

USAGE
  $ mcloud variables set [VARIABLE] [VALUE] [--json] [-o <value>] [-p <value>] [-e <value>] [-t backend|storefront]
    [-v <value>...] [--env-file <value>] [--secret] [--build] [--runtime]

ARGUMENTS
  [VARIABLE]  Variable ID (var_...) or key. Keys require --project and --environment.
  [VALUE]     Value of the variable

FLAGS
  -e, --environment=<value>   Environment ID, handle, or name (defaults to the environment in the context configuration)
  -o, --organization=<value>  Organization ID or name (defaults to the organization in the context configuration)
  -p, --project=<value>       Project ID, handle, or name (defaults to the project in the context configuration)
  -t, --type=<option>         [default: backend] Type of variable
                              <options: backend|storefront>
  -v, --var=<value>...        Variables in the format ID=VALUE or KEY=VALUE. Keys require --project and --environment.
      --[no-]build            Whether the variable is a build variable (defaults to false for new variables)
      --env-file=<value>      .env file to use for the build. Optional: environment variables are inferred from the
                              Cloud environment if not specified.
      --[no-]runtime          Whether the variable is a runtime variable (defaults to true for new variables)
      --[no-]secret           Whether the variable is a secret (defaults to false for new variables)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Set (create/update) an environment variable by ID or key

EXAMPLES
  $ mcloud variables set API_KEY pk_123

  $ mcloud variables set var_01XYZ pk_123

  $ mcloud variables set API_KEY pk_123 --project my-store --environment production

  $ mcloud variables set -v API_KEY=pk_123 -v CLIENT_ID=my_app

  $ mcloud variables set --env-file .env

See code: src/commands/variables/set.ts

`mcloud version`

Show CLI version

USAGE
  $ mcloud version [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Show CLI version

EXAMPLES
  $ mcloud version

See code: src/commands/version/index.ts

`mcloud whoami`

Show the authenticated user, active organization / project / environment, and CLI metadata

USAGE
  $ mcloud whoami [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Show the authenticated user, active organization / project / environment, and CLI metadata

EXAMPLES
  $ mcloud whoami

  $ mcloud whoami --json

See code: src/commands/whoami/index.ts

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

mcloud

Usage

Commands

mcloud autocomplete [SHELL]

mcloud deployments build-logs DEPLOYMENT

mcloud deployments get DEPLOYMENT

mcloud deployments list

mcloud environments create

mcloud environments delete [ENVIRONMENT]

mcloud environments get [ENVIRONMENT]

mcloud environments list

mcloud environments redeploy [ENVIRONMENT]

mcloud environments trigger-build [ENVIRONMENT]

mcloud help [COMMAND]

mcloud local build

mcloud login

mcloud logout

mcloud logs

mcloud organizations get [ORGANIZATION]

mcloud organizations list

mcloud projects delete [PROJECT]

mcloud projects get [PROJECT]

mcloud projects list

mcloud signup

mcloud use

mcloud variables delete VARIABLE

mcloud variables get VARIABLE

mcloud variables list

mcloud variables set [VARIABLE] [VALUE]

mcloud version

mcloud whoami