anypoint-cli-designcenter-plugin

@mulesoft/designcenter

designcenter plugin

• Usage
• Commands

Usage

$ npm install -g @mulesoft/anypoint-cli-designcenter-plugin
$ anypoint-cli-designcenter-plugin COMMAND
running command...
$ anypoint-cli-designcenter-plugin (--version)
@mulesoft/anypoint-cli-designcenter-plugin/1.0.11 darwin-arm64 node-v18.19.1
$ anypoint-cli-designcenter-plugin --help [COMMAND]
USAGE
  $ anypoint-cli-designcenter-plugin COMMAND
...

Commands

• anypoint-cli-designcenter-plugin conf [KEY] [VALUE]
• anypoint-cli-designcenter-plugin designcenter:project:create NAME
• anypoint-cli-designcenter-plugin designcenter:project:delete NAME
• anypoint-cli-designcenter-plugin designcenter:project:download NAME TARGETDIR
• anypoint-cli-designcenter-plugin designcenter:project:list [SEARCHTEXT]
• anypoint-cli-designcenter-plugin designcenter:project:publish NAME
• anypoint-cli-designcenter-plugin designcenter:project:upload NAME PROJDIR
• anypoint-cli-designcenter-plugin help [COMMAND]
• anypoint-cli-designcenter-plugin version

anypoint-cli-designcenter-plugin conf [KEY] [VALUE]

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

USAGE
  $ anypoint-cli-designcenter-plugin 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.
  CLI config file: ~/Library/Preferences/anypoint-cli-v4/config.json

EXAMPLES
  $ anypoint-cli-designcenter-plugin conf username myuser

  $ anypoint-cli-designcenter-plugin conf password mypwd

anypoint-cli-designcenter-plugin designcenter:project:create NAME

Create a new project

USAGE
  $ anypoint-cli-designcenter-plugin designcenter:project:create [NAME] [--password <value> [--username <value> | --client_id
    <value> | ]] [--client_secret <value> ] [--bearer <value> |  | ] [--organization <value>] [--environment <value>]
    [--host <value>] [--collectMetrics] [-h] [-t <value>] [-f <value>] [--format <value>] [-v <value>] [-o <value>]

FLAGS
  -f, --fragmentType=<value>    Fragment type. Always use with --type raml-fragment, even for OAS 3.0 and JSON schema
                                fragments. This field is required if the type option was set as raml-fragment. Supported
                                values are: trait, resource_type, library, type, user_documentation, oas-components,
                                json-schema.
  -h, --help                    Show CLI help.
  -o, --output=<value>          [default: table] Format for commands output. Supported values are table (default) and
                                json
  -t, --type=<value>            Project type. Supported values are: raml, oas, raml-fragment. Default type is raml
  -v, --version=<value>         Version. Only available for OAS APIs. Supported values are 2.0 and 3.0. Default value is
                                2.0
  --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.
  --collectMetrics              collect metrics. You can define this in the COLLECT_METRICS environment variable.
  --environment=<value>         Environment Name. You can define this in the ANYPOINT_ENV environment variable.
  --format=<value>              Format. Only available for OAS APIs. Supported values are: yaml, json. Default value is
                                json
  --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.

DESCRIPTION
  Create a new project

See code: src/commands/designcenter/project/create.ts

anypoint-cli-designcenter-plugin designcenter:project:delete NAME

Delete a project

USAGE
  $ anypoint-cli-designcenter-plugin designcenter:project:delete [NAME] [--password <value> [--username <value> | --client_id
    <value> | ]] [--client_secret <value> ] [--bearer <value> |  | ] [--organization <value>] [--environment <value>]
    [--host <value>] [--collectMetrics] [-h] [-f]

FLAGS
  -f, --force
  -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.
  --collectMetrics              collect metrics. You can define this in the COLLECT_METRICS 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.

DESCRIPTION
  Delete a project

See code: src/commands/designcenter/project/delete.ts

anypoint-cli-designcenter-plugin designcenter:project:download NAME TARGETDIR

Download the content of a project

USAGE
  $ anypoint-cli-designcenter-plugin designcenter:project:download [NAME] [TARGETDIR] [--password <value> [--username <value> |
    --client_id <value> | ]] [--client_secret <value> ] [--bearer <value> |  | ] [--organization <value>] [--environment
    <value>] [--host <value>] [--collectMetrics] [-h] [-b <value>] [--resolveDependenciesTimeout <value>]

FLAGS
  -b, --branch=<value>
  -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.
  --collectMetrics                      collect metrics. You can define this in the COLLECT_METRICS 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.
  --resolveDependenciesTimeout=<value>  [default: 2] Sets amount of minutes before timeout occurs when resolving
                                        Exchange Dependencies.
  --username=<value>                    Username. You can define this in the ANYPOINT_USERNAME environment variable.

DESCRIPTION
  Download the content of a project

See code: src/commands/designcenter/project/download.ts

anypoint-cli-designcenter-plugin designcenter:project:list [SEARCHTEXT]

List all projects

USAGE
  $ anypoint-cli-designcenter-plugin designcenter:project:list [SEARCHTEXT] [--password <value> [--username <value> |
    --client_id <value> | ]] [--client_secret <value> ] [--bearer <value> |  | ] [--organization <value>] [--environment
    <value>] [--host <value>] [--collectMetrics] [-h] [--pageIndex <value>] [--pageSize <value>] [-o <value>]

FLAGS
  -h, --help                    Show CLI help.
  -o, --output=<value>          [default: table] Format for commands output. Supported values are table (default) and
                                json
  --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.
  --collectMetrics              collect metrics. You can define this in the COLLECT_METRICS 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.
  --pageIndex=<value>
  --pageSize=<value>            [default: 10]
  --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 all projects

See code: src/commands/designcenter/project/list.ts

anypoint-cli-designcenter-plugin designcenter:project:publish NAME

Publish a project to Exchange. Options that are not specified are extracted from exchange.json

USAGE
  $ anypoint-cli-designcenter-plugin designcenter:project:publish [NAME] [--password <value> [--username <value> | --client_id
    <value> | ]] [--client_secret <value> ] [--bearer <value> |  | ] [--organization <value>] [--environment <value>]
    [--host <value>] [--collectMetrics] [-h] [--name <value>] [--main <value>] [--apiVersion <value>] [--groupId
    <value>] [--assetId <value>] [--version <value>] [-b <value>] [--status <value>]

FLAGS
  -b, --branch=<value>
  -h, --help                    Show CLI help.
  --apiVersion=<value>
  --assetId=<value>
  --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.
  --collectMetrics              collect metrics. You can define this in the COLLECT_METRICS environment variable.
  --environment=<value>         Environment Name. You can define this in the ANYPOINT_ENV environment variable.
  --groupId=<value>
  --host=anypoint.mulesoft.com  [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
                                environment variable.
  --main=<value>
  --name=<value>
  --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.
  --status=<value>
  --username=<value>            Username. You can define this in the ANYPOINT_USERNAME environment variable.
  --version=<value>

DESCRIPTION
  Publish a project to Exchange. Options that are not specified are extracted from `exchange.json`

See code: src/commands/designcenter/project/publish.ts

anypoint-cli-designcenter-plugin designcenter:project:upload NAME PROJDIR

Upload the content of a project. File/folder names starting with a dot are excluded unless --include-dot-files is passed

USAGE
  $ anypoint-cli-designcenter-plugin designcenter:project:upload [NAME] [PROJDIR] [--password <value> [--username <value> |
    --client_id <value> | ]] [--client_secret <value> ] [--bearer <value> |  | ] [--organization <value>] [--environment
    <value>] [--host <value>] [--collectMetrics] [-h] [-i] [-b <value>]

FLAGS
  -b, --branch=<value>
  -h, --help                    Show CLI help.
  -i, --include-dot-files
  --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.
  --collectMetrics              collect metrics. You can define this in the COLLECT_METRICS 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.

DESCRIPTION
  Upload the content of a project. File/folder names starting with a dot are excluded unless `--include-dot-files` is
  passed

See code: src/commands/designcenter/project/upload.ts

anypoint-cli-designcenter-plugin help [COMMAND]

Display help for anypoint-cli-designcenter-plugin.

USAGE
  $ anypoint-cli-designcenter-plugin 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 anypoint-cli-designcenter-plugin.

See code: @oclif/plugin-help

anypoint-cli-designcenter-plugin version

USAGE
  $ anypoint-cli-designcenter-plugin version

See code: @oclif/plugin-version