anypoint-cli-agent-fabric-plugin
v1.0.4
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 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> 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>]
[--tab-size <value>] [--create-dir]
FLAGS
-n, --name=<value> (required) Name of the project
-o, --output-dir=<value> Output directory for the project
--asset-id=<value> Asset Name (GAV)
--asset-version=<value> [default: 1.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> 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] [-i <value>] [-e <value>] [-t <value>] [--dont-wait-for-agent-network]
[--disable-tracing] [--property <value>] [--path <value>] [--max-retries <value>] [--json]
FLAGS
-e, --egress-gw=<value> [default: agent-network-egress-gw] Name of the target egress gw
-i, --ingress-gw=<value> [default: agent-network-ingress-gw] Name of the target ingress gw
-t, --target-space=<value> [default: agent-network-space] Name of the target private space to deploy
--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-tracing Disable tracing functionalities
--dont-wait-for-agent-network Do not wait for the Agent Network to be ready
--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.
--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.
--property=<value>... [default: ] Name and value for the properties. Name:Value
--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 deployanypoint-cli-agent-fabric-plugin agent-network project publish
Publish current Agent Network project into Exchange
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> 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 into Exchange
EXAMPLES
$ agent-network project publishanypoint-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>] [-i <value>] [-e <value>]
FLAGS
-e, --egress-gw=<value> [default: agent-network-egress-gw] Name of the egress gw
-i, --ingress-gw=<value> [default: agent-network-ingress-gw] Name of the ingress gw
-t, --target-space=<value> [default: agent-network-space] Name of the target private 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.
--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
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.0.0 darwin-arm64 node-v20.19.2
$ 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
