@mulesoft/governance
================

governance plugin


* Usage
* Commands

Usage

``sh-session
$ npm install -g @mulesoft/anypoint-cli-governance-plugin
$ anypoint-cli-governance-plugin COMMAND
running command...
$ anypoint-cli-governance-plugin (--version)
@mulesoft/anypoint-cli-governance-plugin/1.0.0 darwin-x64 node-v16.14.2
$ anypoint-cli-governance-plugin --help [COMMAND]
USAGE
$ anypoint-cli-governance-plugin COMMAND
...
`

Commands

* [anypoint-cli-governance-plugin conf [KEY] [VALUE]](#anypoint-cli-governance-plugin-conf-key-value)
* anypoint-cli-governance-plugin governance:api:evaluate
* anypoint-cli-governance-plugin governance:api:inspect INPUT
* anypoint-cli-governance-plugin governance:api:validate SPEC
* anypoint-cli-governance-plugin governance:document RULESET FILE
* anypoint-cli-governance-plugin governance:profile:create PROFILE-NAME RULESET-ASSET-IDENTIFIERS
* anypoint-cli-governance-plugin governance:profile:delete PROFILE-ID
* anypoint-cli-governance-plugin governance:profile:info PROFILEID
* anypoint-cli-governance-plugin governance:profile:list
* anypoint-cli-governance-plugin governance:profile:update PROFILEID
* anypoint-cli-governance-plugin governance:ruleset:clone RULESET TITLE DESCRIPTION
* anypoint-cli-governance-plugin governance:ruleset:info RULESET
* anypoint-cli-governance-plugin governance:ruleset:init SCHEMA
* anypoint-cli-governance-plugin governance:ruleset:validate RULESET
* [anypoint-cli-governance-plugin help [COMMAND]](#anypoint-cli-governance-plugin-help-command)
* anypoint-cli-governance-plugin version

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

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

`
USAGE
$ anypoint-cli-governance-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-nodejs/config.json

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

$ anypoint-cli-governance-plugin conf password mypwd
`

anypoint-cli-governance-plugin governance:api:evaluate

Evaluate rulesets that may apply to the API.

`
USAGE
$ anypoint-cli-governance-plugin governance:api:evaluate [--password [--username | --client_id | ]]
[--client_secret ] [--bearer | | ] [--organization ] [--environment ] [--host
] [--collectMetrics] [--criteria ] [--api ]

FLAGS
--api= The API
--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.
--criteria= A list of filters separated by commas, where each filter has a type and value in the
format filterType:filterValue. Available filters include category, tag, and scope (the
targeted API types). Example: tag:tag1,category:category1:value,category:category2:value
2,scope:async-api,scope:rest-api
--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
Evaluate rulesets that may apply to the API.
`

_See code: src/commands/governance/api/evaluate.ts_

anypoint-cli-governance-plugin governance:api:inspect INPUT

Inspects an API definition to determine the included types.

`
USAGE
$ anypoint-cli-governance-plugin governance:api:inspect [INPUT] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics]

FLAGS
--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
Inspects an API definition to determine the included types.

EXAMPLES
$ anypoint-cli-governance-plugin governance:api:inspect my-healthcare-api.yaml
`

_See code: src/commands/governance/api/inspect.ts_

anypoint-cli-governance-plugin governance:api:validate SPEC

Validate an API definition against the ruleset

`
USAGE
$ anypoint-cli-governance-plugin governance:api:validate [SPEC] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [--rulesets ] [--remote-rulesets ] [--remote] [--force]

FLAGS
--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.
--force force
--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.
--remote Remote API definition. API definition should be specified using group/asset/version
format
--remote-rulesets=... Remote Ruleset files to add to validation, separated by comma
--rulesets=... Ruleset files to add to validation, separated by comma
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.

DESCRIPTION
Validate an API definition against the ruleset
`

_See code: src/commands/governance/api/validate.ts_

anypoint-cli-governance-plugin governance:document RULESET FILE

Document Ruleset definition.

`
USAGE
$ anypoint-cli-governance-plugin governance:document [RULESET] [FILE] [--single-page]

FLAGS
--single-page Create a single page for documentation

DESCRIPTION
Document Ruleset definition.
`

_See code: src/commands/governance/document.ts_

anypoint-cli-governance-plugin governance:profile:create PROFILE-NAME RULESET-ASSET-IDENTIFIERS

Creates a new profile.Argument "ruleset-asset-identifiers" should be a list of ruleset asset identifiers formatted as follows: //,//.

`
USAGE
$ anypoint-cli-governance-plugin governance:profile:create [PROFILE-NAME] [RULESET-ASSET-IDENTIFIERS] [--password
[--username | --client_id | ]] [--client_secret ] [--bearer | | ] [--organization
] [--environment ] [--host ] [--collectMetrics] [-o ] [--description ]
[--criteria ]

FLAGS
-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.
--criteria= A list of filters separated by commas, where each filter has a type and value in the
format filterType:filterValue. Available filters include category, tag, and scope (the
targeted API types). Example: tag:tag1,category:category1:value,category:category2:value
2,scope:async-api,scope:rest-api
--description= Profile description
--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
Creates a new profile.Argument "ruleset-asset-identifiers" should be a list of ruleset asset identifiers formatted as
follows: //,//.
`

_See code: src/commands/governance/profile/create.ts_

anypoint-cli-governance-plugin governance:profile:delete PROFILE-ID

Delete specific profile.

`
USAGE
$ anypoint-cli-governance-plugin governance:profile:delete [PROFILE-ID] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics]

FLAGS
--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 specific profile.
`

_See code: src/commands/governance/profile/delete.ts_

anypoint-cli-governance-plugin governance:profile:info PROFILEID

Show info for specific profile

`
USAGE
$ anypoint-cli-governance-plugin governance:profile:info [PROFILEID] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [-o ]

FLAGS
-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.
--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
Show info for specific profile
`

_See code: src/commands/governance/profile/info.ts_

anypoint-cli-governance-plugin governance:profile:list

List profiles from the organization

`
USAGE
$ anypoint-cli-governance-plugin governance:profile:list [--password [--username | --client_id | ]]
[--client_secret ] [--bearer | | ] [--organization ] [--environment ] [--host
] [--collectMetrics] [-o ]

FLAGS
-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.
--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 profiles from the organization
`

_See code: src/commands/governance/profile/list.ts_

anypoint-cli-governance-plugin governance:profile:update PROFILEID

Modifies the profile

`
USAGE
$ anypoint-cli-governance-plugin governance:profile:update [PROFILEID] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [--ruleset-asset-identifiers ] [--profile-name ] [--criteria
] [--description ]

FLAGS
--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.
--criteria= A list of filters separated by commas, where each filter has a type and value in
the format filterType:filterValue. Available filters include category, tag, and
scope (the targeted API types). Example: tag:tag1,category:category1:value,catego
ry:category2:value2,scope:async-api,scope:rest-api
--description= Profile description
--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.
--profile-name= Profile name
--ruleset-asset-identifiers= Asset identifiersArgument "ruleset-asset-identifiers" should be a list of ruleset
asset identifiers formatted as follows:
//,//.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.

DESCRIPTION
Modifies the profile
`

_See code: src/commands/governance/profile/update.ts_

anypoint-cli-governance-plugin governance:ruleset:clone RULESET TITLE DESCRIPTION

Create a new ruleset from another

`
USAGE
$ anypoint-cli-governance-plugin governance:ruleset:clone [RULESET] [TITLE] [DESCRIPTION] [--password [--username
| --client_id | ]] [--client_secret ] [--bearer | | ] [--organization ]
[--environment ] [--host ] [--collectMetrics] [--remote] [--error ] [--warning ] [--info
] [--remove ]

FLAGS
--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.
--error= List of error rules, separated by comma
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--info= List of info rules, separated by comma
--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.
--remote The ruleset for which to list information is published in Exchange. Ruleset should be
specified using group/asset/version format
--remove= List of rules to remove, separated by comma
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
--warning= List of warning rules, separated by comma

DESCRIPTION
Create a new ruleset from another
`

_See code: src/commands/governance/ruleset/clone.ts_

anypoint-cli-governance-plugin governance:ruleset:info RULESET

List ruleset rules

`
USAGE
$ anypoint-cli-governance-plugin governance:ruleset:info [RULESET] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [--remote]

FLAGS
--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.
--remote The ruleset for which to list information is published in Exchange. Ruleset should be
specified using group/asset/version format
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.

DESCRIPTION
List ruleset rules
`

_See code: src/commands/governance/ruleset/info.ts_

anypoint-cli-governance-plugin governance:ruleset:init SCHEMA

Initializes a governance ruleset definition based on a data schema

`
USAGE
$ anypoint-cli-governance-plugin governance:ruleset:init [SCHEMA] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [--types ] [--name ]

FLAGS
--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.
--name= [default: GeneratedRuleset] Name of the ruleset. Defaults to GeneratedRuleset
--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.
--types=... [default: ] Target API types for which to initialize rules. If no types are specified,
rules for every type are generated
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.

DESCRIPTION
Initializes a governance ruleset definition based on a data schema
`

_See code: src/commands/governance/ruleset/init.ts_

anypoint-cli-governance-plugin governance:ruleset:validate RULESET

Validate Ruleset definition

`
USAGE
$ anypoint-cli-governance-plugin governance:ruleset:validate [RULESET] [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics]

FLAGS
--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
Validate Ruleset definition
`

_See code: src/commands/governance/ruleset/validate.ts_

anypoint-cli-governance-plugin help [COMMAND]

Display help for anypoint-cli-governance-plugin.

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

_See code: @oclif/plugin-help_

anypoint-cli-governance-plugin version

`
USAGE
$ anypoint-cli-governance-plugin version
``

_See code: @oclif/plugin-version_