designcenter plugin
npm install anypoint-cli-designcenter-plugin@mulesoft/designcenter
================
designcenter plugin
sh-session
$ 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-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-designcenterprojectlist-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-help-command)
* anypoint-cli-designcenter-plugin versionanypoint-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 ] [-v ] [-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= key of the config
-v, --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 NAMECreate a new project
`
USAGE
$ anypoint-cli-designcenter-plugin designcenter:project:create [NAME] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [-h] [-t ] [-f ] [--format ] [-v ] [-o ]FLAGS
-f, --fragmentType= 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= [default: table] Format for commands output. Supported values are table (default) and
json
-t, --type= Project type. Supported values are: raml, oas, raml-fragment. Default type is raml
-v, --version= Version. Only available for OAS APIs. Supported values are 2.0 and 3.0. Default value is
2.0
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= 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= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--format= 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= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= 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 NAMEDelete a project
`
USAGE
$ anypoint-cli-designcenter-plugin designcenter:project:delete [NAME] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [-h] [-f]FLAGS
-f, --force
-h, --help Show CLI help.
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= 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= 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= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= 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 TARGETDIRDownload the content of a project
`
USAGE
$ anypoint-cli-designcenter-plugin designcenter:project:download [NAME] [TARGETDIR] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-h] [-b ] [--resolveDependenciesTimeout ]FLAGS
-b, --branch=
-h, --help Show CLI help.
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= 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= 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= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--resolveDependenciesTimeout= [default: 2] Sets amount of minutes before timeout occurs when resolving
Exchange Dependencies.
--username= 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 [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-h] [--pageIndex ] [--pageSize ] [-o ]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= 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= 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= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--pageIndex=
--pageSize= [default: 10]
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= 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 NAMEPublish a project to Exchange. Options that are not specified are extracted from
exchange.json`
USAGE
$ anypoint-cli-designcenter-plugin designcenter:project:publish [NAME] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [-h] [--name ] [--main ] [--apiVersion ] [--groupId
] [--assetId ] [--version ] [-b ] [--status ]FLAGS
-b, --branch=
-h, --help Show CLI help.
--apiVersion=
--assetId=
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= 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= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--groupId=
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--main=
--name=
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--status=
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
--version=
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 PROJDIRUpload 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 [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-h] [-i] [-b ]FLAGS
-b, --branch=
-h, --help Show CLI help.
-i, --include-dot-files
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= 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= 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= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= 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_