Medusa Platform CLI

• Medusa Platform CLI
• Usage
• Commands

Usage

$ npm install -g mcld
$ mcld COMMAND
running command...
$ mcld (--version)
mcld/0.0.7 darwin-arm64 node-v20.11.0
$ mcld --help [COMMAND]
USAGE
  $ mcld COMMAND
...

Commands

• mcld accounts
• mcld accounts create
• mcld accounts invite
• mcld accounts select
• mcld autocomplete [SHELL]
• mcld builds list
• mcld builds subscribe [BUILD_ID]
• mcld config get [KEY]
• mcld config list
• mcld config set KEY VALUE
• mcld environments create
• mcld environments delete
• mcld help [COMMAND]
• mcld invite accept
• mcld login
• mcld logs
• mcld logs build [BUILD_ID]
• mcld projects build
• mcld projects create
• mcld projects delete
• mcld projects list
• mcld signup
• mcld update [CHANNEL]

mcld accounts

View the accounts you have access to

USAGE
  $ mcld accounts

DESCRIPTION
  View the accounts you have access to

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

mcld accounts create

View the accounts you have access to

USAGE
  $ mcld accounts create -n <value> [-b <value>]

FLAGS
  -b, --billing_email=<value>  Billing email of the account
  -n, --name=<value>           (required) Name of the account

DESCRIPTION
  View the accounts you have access to

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

mcld accounts invite

Get an invite token for the account

USAGE
  $ mcld accounts invite

DESCRIPTION
  Get an invite token for the account

See code: src/commands/accounts/invite.ts

mcld accounts select

Open browser to log into MCLOUD

USAGE
  $ mcld accounts select

DESCRIPTION
  Open browser to log into MCLOUD

See code: src/commands/accounts/select.ts

mcld autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ mcld 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
  $ mcld autocomplete

  $ mcld autocomplete bash

  $ mcld autocomplete zsh

  $ mcld autocomplete powershell

  $ mcld autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

mcld builds list

View recent builds for a project

USAGE
  $ mcld builds list [-p <value>] [-e <value>]

FLAGS
  -e, --env=<value>      Environment id or alias
  -p, --project=<value>  Project id or alias

DESCRIPTION
  View recent builds for a project

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

mcld builds subscribe [BUILD_ID]

Follow the build progress

USAGE
  $ mcld builds subscribe [BUILD_ID] -p <value> -e <value>

FLAGS
  -e, --env=<value>      (required) Environment id or alias
  -p, --project=<value>  (required) Project id or alias

DESCRIPTION
  Follow the build progress

See code: src/commands/builds/subscribe.ts

mcld config get [KEY]

View the projects you have accesss to

USAGE
  $ mcld config get [KEY] [-p <value>] [-e <value>]

FLAGS
  -e, --env=<value>      Environment id or alias
  -p, --project=<value>  Project id or alias

DESCRIPTION
  View the projects you have accesss to

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

mcld config list

View the projects you have accesss to

USAGE
  $ mcld config list [-p <value>] [-e <value>]

FLAGS
  -e, --env=<value>      Environment id or alias
  -p, --project=<value>  Project id or alias

DESCRIPTION
  View the projects you have accesss to

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

mcld config set KEY VALUE

View the projects you have accesss to

USAGE
  $ mcld config set KEY VALUE -p <value> -e <value>

FLAGS
  -e, --env=<value>      (required) Environment id or alias
  -p, --project=<value>  (required) Project id or alias

DESCRIPTION
  View the projects you have accesss to

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

mcld environments create

Create a new environment for a project

USAGE
  $ mcld environments create -p <value> -a <value> -b <value> [-t prod|dev]

FLAGS
  -a, --alias=<value>    (required)
  -b, --branch=<value>   (required)
  -p, --project=<value>  (required)
  -t, --type=<option>    [default: dev]
                         <options: prod|dev>

DESCRIPTION
  Create a new environment for a project

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

mcld environments delete

Create a new environment for a project

USAGE
  $ mcld environments delete -p <value> -e <value>

FLAGS
  -e, --env=<value>      (required)
  -p, --project=<value>  (required)

DESCRIPTION
  Create a new environment for a project

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

mcld help [COMMAND]

Display help for mcld.

USAGE
  $ mcld 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 mcld.

See code: @oclif/plugin-help

mcld invite accept

View the accounts you have access to

USAGE
  $ mcld invite accept -t <value>

FLAGS
  -t, --invite_token=<value>  (required) The invite token

DESCRIPTION
  View the accounts you have access to

See code: src/commands/invite/accept.ts

mcld login

Open browser to log into MCLOUD

USAGE
  $ mcld login

DESCRIPTION
  Open browser to log into MCLOUD

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

mcld logs

View application logs

USAGE
  $ mcld logs -p <value> -e <value>

FLAGS
  -e, --env=<value>      (required) Environment id or alias
  -p, --project=<value>  (required) Project id or alias

DESCRIPTION
  View application logs

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

mcld logs build [BUILD_ID]

View the projects you have accesss to

USAGE
  $ mcld logs build [BUILD_ID] -p <value> -e <value>

FLAGS
  -e, --env=<value>      (required) Environment id or alias
  -p, --project=<value>  (required) Project id or alias

DESCRIPTION
  View the projects you have accesss to

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

mcld projects build

Build a project environment.

USAGE
  $ mcld projects build -p <value> -e <value>

FLAGS
  -e, --env=<value>      (required) Environment id or alias.
  -p, --project=<value>  (required) Project id or alias. View your projects with `projects list`

DESCRIPTION
  Build a project environment.

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

mcld projects create

Create a new project from a GitHub repository

USAGE
  $ mcld projects create -o <value> -r <value> -R <value>

FLAGS
  -R, --region=<value>  (required) The region to deploy the project to.
  -o, --owner=<value>   (required) The GitHub repository owner. (Organization or username)
  -r, --repo=<value>    (required) The GitHub repository name.

DESCRIPTION
  Create a new project from a GitHub repository

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

mcld projects delete

Delete a project and its environments.

USAGE
  $ mcld projects delete -p <value>

FLAGS
  -p, --project=<value>  (required) Project id or alias

DESCRIPTION
  Delete a project and its environments.

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

mcld projects list

View the projects you have accesss to

USAGE
  $ mcld projects list

DESCRIPTION
  View the projects you have accesss to

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

mcld signup

Create a new platform user

USAGE
  $ mcld signup -e <value> -p <value> [-t <value>]

FLAGS
  -e, --email=<value>         (required) Email for the new user
  -p, --password=<value>      (required) Password for the new user
  -t, --invite_token=<value>  An invite token for an account

DESCRIPTION
  Create a new platform user

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

mcld update [CHANNEL]

update the mcld CLI

USAGE
  $ mcld update [CHANNEL] [-a] [--force] [-i | -v <value>]

FLAGS
  -a, --available        See available versions.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
      --force            Force a re-download of the requested version.

DESCRIPTION
  update the mcld CLI

EXAMPLES
  Update to the stable channel:

    $ mcld update stable

  Update to a specific version:

    $ mcld update --version 1.0.0

  Interactively select version:

    $ mcld update --interactive

  See available versions:

    $ mcld update --available

See code: @oclif/plugin-update