@salesforce/anypoint-cli-dx-mule-plugin

This is a plugin for Anypoint CLI v4 that adds Mule developer experience tooling — runtime management, project creation, and connector introspection. It is bundled with anypoint-cli-v4 and installed as a plugin into the CLI before its commands become available.

Install

$ npm install -g anypoint-cli-v4-public

Verify the plugin is loaded:

$ anypoint-cli-v4 --version
  anypoint-cli-v4-public/1.6.18 darwin-arm64 node-v18.20.4
$ anypoint-cli-v4 plugins --core
$ anypoint-cli-v4 dx mule --help

Commands

• anypoint-cli-v4 conf [KEY] [VALUE]
• anypoint-cli-v4 dx mule runtime list
• anypoint-cli-v4 dx mule runtime download
• anypoint-cli-v4 dx mule runtime path
• anypoint-cli-v4 dx mule project create PROJECTNAME
• anypoint-cli-v4 dx mule describe-connector

anypoint-cli-v4 conf [KEY] [VALUE]

Manage authentication credentials in a configuration file (config.json)

USAGE
  $ anypoint-cli-v4 conf [KEY] [VALUE] [-h] [-k <value>] [-v <value>] [-d]

ARGUMENTS
  KEY    key of the config
  VALUE  value of the config

FLAGS
  -d, --delete         delete config key
  -h, --help           Show CLI help.
  -k, --key=<value>    key of the config
  -v, --value=<value>  value of the config

DESCRIPTION
  Manage authentication credentials in a configuration file (config.json)
  by adding and removing key value pairs. Set one key value pair per command execution.
  For more information use the oficial documentation site: https://docs.mulesoft.com/anypoint-cli/latest/

EXAMPLES
  $ anypoint-cli-v4 conf username myuser

  $ anypoint-cli-v4 conf password mypwd

Provided by the anypoint-cli-command plugin.

anypoint-cli-v4 dx mule runtime list

List available Mule Runtime versions.

USAGE
  $ anypoint-cli-v4 dx mule runtime list [--password <value> [--username <value> | --client_id <value> | ]]
    [--client_secret <value> ] [--bearer <value> |  | ] [--organization <value>] [--environment <value>]
    [--host <value>] [--output table|json] [-h]

FLAGS
  -h, --help                    Show CLI help.
  --bearer=<value>              Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
  --client_id=<value>           Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
  --client_secret=<value>       Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
  --environment=<value>         Environment Name. You can define this in the ANYPOINT_ENV environment variable.
  --host=anypoint.mulesoft.com  [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
                                environment variable.
  --organization=<value>        Organization Name. You can define this in the ANYPOINT_ORG environment variable.
  --output=<option>             [default: table] Output format
                                <options: table|json>
  --password=<value>            Password. You can define this in the ANYPOINT_PASSWORD environment variable.
  --username=<value>            Username. You can define this in the ANYPOINT_USERNAME environment variable.

DESCRIPTION
  List available Mule Runtime versions.

EXAMPLES
  $ anypoint-cli-v4 dx mule runtime list

  $ anypoint-cli-v4 dx mule runtime list --output json

anypoint-cli-v4 dx mule runtime download

Download a Mule runtime version.

USAGE
  $ anypoint-cli-v4 dx mule runtime download [--password <value> [--username <value> | --client_id <value> | ]]
    [--client_secret <value> ] [--bearer <value> |  | ] [--organization <value>] [--environment <value>]
    [--host <value>] [--version <value>] [-h]

FLAGS
  -h, --help                    Show CLI help.
  --bearer=<value>              Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
  --client_id=<value>           Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
  --client_secret=<value>       Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
  --environment=<value>         Environment Name. You can define this in the ANYPOINT_ENV environment variable.
  --host=anypoint.mulesoft.com  [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
                                environment variable.
  --organization=<value>        Organization Name. You can define this in the ANYPOINT_ORG environment variable.
  --password=<value>            Password. You can define this in the ANYPOINT_PASSWORD environment variable.
  --username=<value>            Username. You can define this in the ANYPOINT_USERNAME environment variable.
  --version=<value>             Specific runtime version to download (if not specified, downloads latest)

DESCRIPTION
  Download a Mule runtime version. Installs into ~/AnypointCodeBuilder/runtime/mule-enterprise-standalone-<version>.

EXAMPLES
  $ anypoint-cli-v4 dx mule runtime download

  $ anypoint-cli-v4 dx mule runtime download --version 4.6.0

anypoint-cli-v4 dx mule runtime path

Show or set Mule Runtime path.

USAGE
  $ anypoint-cli-v4 dx mule runtime path [--set <value>] [-h]

FLAGS
  -h, --help        Show CLI help.
  --set=<value>     Set runtime path

DESCRIPTION
  Show or set the Mule Runtime path. The configured path is persisted to ~/.mule-dx/config.json and is used by
  describe-connector when resolving connector metadata.

EXAMPLES
  $ anypoint-cli-v4 dx mule runtime path

  $ anypoint-cli-v4 dx mule runtime path --set ~/mule-enterprise-standalone-4.11.2

anypoint-cli-v4 dx mule project create PROJECTNAME

Create a new Mule project with dependencies.

USAGE
  $ anypoint-cli-v4 dx mule project create PROJECTNAME --group-id <value> [--mule-version <value>]
    [--dependencies <value>] [-h]

ARGUMENTS
  PROJECTNAME  Name of the project to create

FLAGS
  -h, --help               Show CLI help.
  --group-id=<value>       (required) Maven group ID for the project
  --mule-version=<value>   [default: 4.4.0] Mule runtime version (e.g., 4.4.0, 4.6.0)
  --dependencies=<value>   Comma-separated list of GAV coordinates (groupId:artifactId:version)

DESCRIPTION
  Create a new Mule project with dependencies.

EXAMPLES
  $ anypoint-cli-v4 dx mule project create my-integration \
      --group-id com.example \
      --dependencies "com.mulesoft.connectors:mule-salesforce-connector:10.20.0"

  $ anypoint-cli-v4 dx mule project create my-integration \
      --group-id com.example \
      --dependencies "com.mulesoft.connectors:mule-salesforce-connector:10.20.0" \
      --mule-version 4.6.0

anypoint-cli-v4 dx mule describe-connector

Describe a connector: namespace, operations, sources, configs, and detailed type-specific information.

USAGE
  $ anypoint-cli-v4 dx mule describe-connector --connector <value> [--type connection-provider|operation|source]
    [--name <value>] [--config-name <value>] [--output table|json] [-h]

FLAGS
  -h, --help              Show CLI help.
  --connector=<value>     (required) Connector GAV (groupId:artifactId:version)
  --type=<option>         Detail type
                          <options: connection-provider|operation|source>
  --name=<value>          Component name (required for operation/source, optional for connection-provider)
  --config-name=<value>   Configuration name (required when --type is connection-provider)
  --output=<option>       [default: table] Output format
                          <options: table|json>

DESCRIPTION
  Describe a connector: namespace, operations, sources, configs, and detailed type-specific information.

EXAMPLES
  $ anypoint-cli-v4 dx mule describe-connector \
      --connector com.mulesoft.connectors:mule-salesforce-connector:10.20.0 \
      --output json

  $ anypoint-cli-v4 dx mule describe-connector \
      --connector com.mulesoft.connectors:mule-salesforce-connector:10.20.0 \
      --type operation --name query --output json

  $ anypoint-cli-v4 dx mule describe-connector \
      --connector com.mulesoft.connectors:mule-salesforce-connector:10.20.0 \
      --type source --name new-object-listener --output json

  $ anypoint-cli-v4 dx mule describe-connector \
      --connector com.mulesoft.connectors:mule-salesforce-connector:10.20.0 \
      --type connection-provider --name basic --config-name sfdc-config --output json