mulesoft-anypoint-cli-agent-fabric-plugin
v1.3.0
Published
Agent Fabric CLI Plugin
Readme
Anypoint CLI Agent Fabric Plugin
This plugin provides CLI commands for managing Agent Fabric projects, specifically Agent Network functionality.
Commands
anypoint-cli-agent-fabric-plugin agent-network project buildanypoint-cli-agent-fabric-plugin agent-network project createanypoint-cli-agent-fabric-plugin agent-network project deployanypoint-cli-agent-fabric-plugin agent-network project publishanypoint-cli-agent-fabric-plugin agent-network project undeployanypoint-cli-agent-fabric-plugin agent-network project unpublishanypoint-cli-agent-fabric-plugin agent-network setup gatewaysanypoint-cli-agent-fabric-plugin conf [KEY] [VALUE]anypoint-cli-agent-fabric-plugin help [COMMAND]anypoint-cli-agent-fabric-plugin version
anypoint-cli-agent-fabric-plugin agent-network project build
Build the current project using the Maven wrapper (mvnw or mvnw.cmd)
USAGE
$ anypoint-cli-agent-fabric-plugin agent-network project build [--password <value> [--username <value> | --client_id <value> |
]] [--client_secret <value> ] [--bearer <value> | | ] [--organization <value>] [--environment <value>] [--host
<value>] [--collectMetrics] [--path <value>] [--debug] [--forceUpdate]
FLAGS
--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.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--debug Enable debug mode
--environment=<value> [default: prod-eu] Environment Name. You can define this in the ANYPOINT_ENV environment
variable.
--forceUpdate Force update the dependencies
--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.
--path=<value> [default: .] The path to the project.
--username=<value> Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Build the current project using the Maven wrapper (mvnw or mvnw.cmd)
EXAMPLES
$ agent-network project buildanypoint-cli-agent-fabric-plugin agent-network project create
Create a new project in the current directory
USAGE
$ anypoint-cli-agent-fabric-plugin agent-network project create -n <value> [--password <value> [--username <value> | --client_id
<value> | ]] [--client_secret <value> ] [--bearer <value> | | ] [--organization <value>] [--environment <value>]
[--host <value>] [--collectMetrics] [-o <value>] [--group-id <value>] [--asset-id <value>] [--asset-version <value>]
[--api-version <value>] [--tab-size <value>] [--create-dir]
FLAGS
-n, --name=<value> (required) Name of the project
-o, --output-dir=<value> Output directory for the project
--api-version=<value> [default: v1] Api Version
--asset-id=<value> Asset Name (GAV). Valid characters are 'A-Z', 'a-z', '0-9', '_' and '-'.
--asset-version=<value> [default: 0.0.0] Asset Version (GAV)
--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.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--[no-]create-dir Create new directory at output-dir for the new project using project's name
--environment=<value> [default: prod-eu] Environment Name. You can define this in the ANYPOINT_ENV environment
variable.
--group-id=<value> Group Id (GAV)
--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.
--tab-size=<value> [default: 2] Tab size to ident Api Specification
--username=<value> Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Create a new project in the current directory
EXAMPLES
$ agent-network project create --name my-projectanypoint-cli-agent-fabric-plugin agent-network project deploy
Deploys the Agent Network application
USAGE
$ anypoint-cli-agent-fabric-plugin agent-network project deploy [--password <value> [--username <value> | --client_id <value> |
]] [--client_secret <value> ] [--bearer <value> | | ] [--organization <value>] [--environment <value>] [--host
<value>] [--collectMetrics] [-g <value>] [-i <value>] [-e <value>] [-t <value>] [--dont-wait-for-agent-network]
[--disable-tracing] [--property <value>] [--path <value>] [--max-retries <value>] [--request-timeout <value>]
[--process-timeout <value>] [--disable-autopublish] [--json]
FLAGS
-e, --egress-gw=<value> Name of the target egress gw (separate-gateways mode; requires --ingress-gw). When no
gateway flags are provided, deploy defaults to single-gateway mode using
agent-network-gw.
-g, --gateway=<value> Name of the gateway for single-gateway mode (recommended). Mutually exclusive with
--ingress-gw and --egress-gw.
-i, --ingress-gw=<value> Name of the target ingress gw. Combine with --egress-gw for separate-gateways mode; on
its own it selects single-gateway mode using this gateway. When no gateway flags are
provided, deploy defaults to single-gateway mode using agent-network-gw.
-t, --target-space=<value> Name of the target space to deploy. In single-gateway mode, optional; when provided it
must match the gateway's target space (validated, not used for lookup). In
separate-gateways mode, defaults to agent-network-space.
--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.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--disable-autopublish Disable automatic publishing when lock file is not found.
--disable-tracing Disable tracing functionalities
--dont-wait-for-agent-network Do not wait for the Agent Network to be ready
--environment=<value> [default: prod-eu] 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.
--max-retries=<value> [default: 3] Max retries to check the status of the deploying application.
--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.
--path=<value> [default: .] The path to the project.
--process-timeout=<value> [default: 900000] Request timeout in millis.
--property=<value>... [default: ] Property to override in format name:value (e.g., --property apiKey:sk-xxx)
--request-timeout=<value> [default: 60000] Request timeout in millis.
--username=<value> Username. You can define this in the ANYPOINT_USERNAME environment variable.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Deploys the Agent Network application
EXAMPLES
$ agent-network project deploy
$ agent-network project deploy --property apiKey:sk-xxx
$ agent-network project deploy --property apiKey:sk-xxx --property role:user
$ agent-network project deploy --path ./my-project --property myAgent.url:https://api.example.comanypoint-cli-agent-fabric-plugin agent-network project publish
Publish current Agent Network project to Anypoint Platform
USAGE
$ anypoint-cli-agent-fabric-plugin agent-network project publish [--password <value> [--username <value> | --client_id <value> |
]] [--client_secret <value> ] [--bearer <value> | | ] [--organization <value>] [--environment <value>] [--host
<value>] [--collectMetrics] [--json] [--path <value>] [--debug]
FLAGS
--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.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--debug Enable debug mode
--environment=<value> [default: prod-eu] 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.
--path=<value> [default: .] The path to the project.
--username=<value> Username. You can define this in the ANYPOINT_USERNAME environment variable.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Publish current Agent Network project to Anypoint Platform
EXAMPLES
$ agent-network project publishanypoint-cli-agent-fabric-plugin agent-network project undeploy
Undeploys the Agent Network application, removing all deployed resources
USAGE
$ anypoint-cli-agent-fabric-plugin agent-network project undeploy [--password <value> [--username <value> | --client_id <value> |
]] [--client_secret <value> ] [--bearer <value> | | ] [--organization <value>] [--environment <value>] [--host
<value>] [--collectMetrics] [--path <value> | --gav <value>] [--api-version <value>] [--request-timeout <value>]
[--process-timeout <value>] [--dry-run | ] [--json]
FLAGS
--api-version=<value> [default: v1] Api Version used to discover remotely deployed resources when using --gav.
--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.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--dry-run Preview the deploy-plane resources that would be undeployed without deleting anything.
--environment=<value> Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--gav=<value> Parent asset GAV (groupId:assetId:version). Discovers deployed resources remotely.
Requires an environment to be selected.
--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.
--path=<value> The path to the project. Discovers deployed resources remotely from the project lock
file. Requires an environment to be selected.
--process-timeout=<value> [default: 900000] Process timeout in millis.
--request-timeout=<value> [default: 60000] Request timeout in millis.
--username=<value> Username. You can define this in the ANYPOINT_USERNAME environment variable.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Undeploys the Agent Network application, removing all deployed resources
EXAMPLES
$ agent-network project undeploy --environment Sandbox
$ agent-network project undeploy --path ./my-project --environment Sandbox
$ agent-network project undeploy --gav myOrgId:my-network:0.0.0 --environment Sandbox
$ agent-network project undeploy --dry-run --environment Sandboxanypoint-cli-agent-fabric-plugin agent-network project unpublish
Removes the Agent Network assets from Anypoint Exchange. By default performs a soft-delete: the asset version is deleted and can no longer be used, but its GAV (groupId, assetId, version) stays reserved and cannot be claimed by a new asset, and the removal cannot be restored or undeleted. To free the GAV for reuse by another asset, use --hard-delete for an irreversible permanent removal.
USAGE
$ anypoint-cli-agent-fabric-plugin agent-network project unpublish [--password <value> [--username <value> | --client_id <value> |
]] [--client_secret <value> ] [--bearer <value> | | ] [--organization <value>] [--environment <value>] [--host
<value>] [--collectMetrics] [--path <value> | --gav <value>] [--api-version <value>] [--hard-delete] [--dry-run | ]
[--json]
FLAGS
--api-version=<value> [default: v1] Api Version used to discover remotely published assets when using --gav.
--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.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--dry-run Preview the Exchange assets that would be unpublished without deleting anything.
--environment=<value> Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--gav=<value> Parent asset GAV (groupId:assetId:version). Discovers assets remotely. Use --environment
to enable the active API instances safety check.
--hard-delete Permanently delete assets from Exchange. Unlike the default soft-delete, this frees the
asset GAV (groupId, assetId, version) so it can be reused by another asset. This cannot
be undone. Assets with dependent versions, API instances, or policies applied to managed
APIs must have those removed first.
--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.
--path=<value> The path to the project. Reads the published assets from the project lock file. Select
an environment to enable the active API instances safety check.
--username=<value> Username. You can define this in the ANYPOINT_USERNAME environment variable.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Removes the Agent Network assets from Anypoint Exchange. By default performs a soft-delete: the asset version is
deleted and can no longer be used, but its GAV (groupId, assetId, version) stays reserved and cannot be claimed by a
new asset, and the removal cannot be restored or undeleted. To free the GAV for reuse by another asset, use
--hard-delete for an irreversible permanent removal.
EXAMPLES
$ agent-network project unpublish --environment Sandbox
$ agent-network project unpublish --path ./my-project --environment Sandbox
$ agent-network project unpublish --hard-delete --environment Sandbox
$ agent-network project unpublish --gav myOrgId:my-network:0.0.0 --environment Sandbox
$ agent-network project unpublish --dry-run --environment Sandboxanypoint-cli-agent-fabric-plugin agent-network setup gateways
Set up the Agent Network environment with the required gateways.
USAGE
$ anypoint-cli-agent-fabric-plugin agent-network setup gateways [--password <value> [--username <value> | --client_id <value> |
]] [--client_secret <value> ] [--bearer <value> | | ] [--organization <value>] [--environment <value>] [--host
<value>] [--collectMetrics] [-t <value>] [-g <value>] [-i <value>] [-e <value>] [--dont-wait-for-gateways-running]
FLAGS
-e, --egress-gw=<value> Name of the egress gw (separate-gateway mode; requires --ingress-gw)
-g, --gateway=<value> Name of the gateway for single-gateway mode (recommended). Mutually exclusive with
--ingress-gw and --egress-gw.
-i, --ingress-gw=<value> Name of the ingress gw (separate-gateway mode)
-t, --target-space=<value> [default: agent-network-space] Name of the target space (private space, RTF, or
shared space) where to setup the Agent Network environment.
--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.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--dont-wait-for-gateways-running Do not wait for the Gateways to be running
--environment=<value> [default: prod-eu] 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
Set up the Agent Network environment with the required gateways.anypoint-cli-agent-fabric-plugin conf [KEY] [VALUE]
Manage authentication credentials in a configuration file (config.json)
USAGE
$ anypoint-cli-agent-fabric-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/oclif-nodejs/config.json
EXAMPLES
$ anypoint-cli-agent-fabric-plugin conf username myuser
$ anypoint-cli-agent-fabric-plugin conf password mypwdanypoint-cli-agent-fabric-plugin help [COMMAND]
Display help for anypoint-cli-agent-fabric-plugin.
USAGE
$ anypoint-cli-agent-fabric-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-agent-fabric-plugin.See code: @oclif/plugin-help
anypoint-cli-agent-fabric-plugin version
USAGE
$ anypoint-cli-agent-fabric-plugin versionSee code: @oclif/plugin-version
Installation
npm install -g @mulesoft/anypoint-cli-agent-fabric-pluginUsage
$ npm install -g @mulesoft/anypoint-cli-agent-fabric-plugin
$ anypoint-cli-agent-fabric-plugin COMMAND
running command...
$ anypoint-cli-agent-fabric-plugin (--version)
@mulesoft/anypoint-cli-agent-fabric-plugin/1.2.0 darwin-arm64 node-v20.19.3
$ anypoint-cli-agent-fabric-plugin --help [COMMAND]
USAGE
$ anypoint-cli-agent-fabric-plugin COMMAND
...After installation, you can use the commands directly:
# Create a new agent network project
anypoint-cli-agent-fabric-plugin agent-network project create --name my-agent-network
# Build the project
anypoint-cli-agent-fabric-plugin agent-network project build
# Publish to exchange
anypoint-cli-agent-fabric-plugin agent-network project publish
# Deploy the application
anypoint-cli-agent-fabric-plugin agent-network project deployDevelopment
Prerequisites
- Node.js >= 20.0.0
- npm
Setup
npm installBuild
npm run buildTest
npm testLint
npm run lintLicense
MIT
