@mulesoft/pdk

pdk plugin

• Usage
• Commands

Usage

$ npm install -g @mulesoft/anypoint-cli-pdk-plugin
$ @mulesoft/anypoint-cli-pdk-plugin COMMAND
running command...
$ @mulesoft/anypoint-cli-pdk-plugin (--version|-v)
@mulesoft/anypoint-cli-pdk-plugin/1.2.0 darwin-arm64 node-v16.20.2
$ @mulesoft/anypoint-cli-pdk-plugin --help [COMMAND]
USAGE
  $ @mulesoft/anypoint-cli-pdk-plugin COMMAND
...

Commands

• @mulesoft/anypoint-cli-pdk-plugin conf [KEY] [VALUE]
• @mulesoft/anypoint-cli-pdk-plugin help [COMMAND]
• @mulesoft/anypoint-cli-pdk-plugin pdk policy-project create
• @mulesoft/anypoint-cli-pdk-plugin version

@mulesoft/anypoint-cli-pdk-plugin conf [KEY] [VALUE]

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

USAGE
  $ @mulesoft/anypoint-cli-pdk-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: /Users/jatadia/Library/Preferences/oclif-nodejs/config.json

EXAMPLES
  $ @mulesoft/anypoint-cli-pdk-plugin conf username myuser

  $ @mulesoft/anypoint-cli-pdk-plugin conf password mypwd

@mulesoft/anypoint-cli-pdk-plugin help [COMMAND]

Display help for @mulesoft/anypoint-cli-pdk-plugin.

USAGE
  $ @mulesoft/anypoint-cli-pdk-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 @mulesoft/anypoint-cli-pdk-plugin.

See code: @oclif/plugin-help

@mulesoft/anypoint-cli-pdk-plugin pdk policy-project create

Create a project to develop a new Policy

USAGE
  $ @mulesoft/anypoint-cli-pdk-plugin pdk policy-project create [--password <value> [--username <value> | --client_id <value> |
    ]] [--client_secret <value> ] [--bearer <value> |  | ] [--organization <value>] [--environment <value>] [--host
    <value>] [--collectMetrics] [-h] [-o <value>] [-n <value>] [-d <value>] [--version <value>] [--category <value>]
    [--provided-characteristics <value>] [--interface-scope <value>] [--is-sla-based] [--requires-spec]
    [--injection-point inbound|outbound] [--identity-management-type OpenAM|PingFederate|OpenIdConnect]
    [--interface-transformation-raml <value>] [--interface-transformation-raml-v1 <value>]
    [--interface-transformation-oas-v2 <value>] [--interface-transformation-oas-v3 <value>]

FLAGS
  -d, --description=<value>
      The description of the policy to generate. You can define this in the POLICY_DESCRIPTION environment variable.

  -h, --help
      Show CLI help.

  -n, --name=<value>
      The name of the policy to generate. It accepts letters, numbers, whitespaces, underscores and dashes. You can define
      this in the POLICY_NAME environment variable.

  -o, --output-dir=<value>
      The directory in which the policy will be created. If the directory does not exists, it will be created. If not
      provided, the policy will be created in a directory that matches the policy definition assetId. You can define this
      in the POLICY_PROJECT_PATH environment variable.

  --bearer=<value>
      Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.

  --category=<value>
      [default: Custom] The category of the policy to initialize. You can define this in the POLICY_CATEGORY 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.

  --identity-management-type=(OpenAM|PingFederate|OpenIdConnect)
      If applicable, classify the type of identity management provided by the policy. You can define this in the
      POLICY_IDENTITY_MANAGEMENT_TYPE environment variable.

  --injection-point=(inbound|outbound)
      Specifies if the policy injection point is inbound or outbound. You can define this in the POLICY_INJECTION_POINT
      environment variable.

  --interface-scope=<value>...
      [default: api,resource] The scopes where the policy can be applied. Possible scopes are "api" and "resource". You
      can define this in the POLICY_INTERFACE_SCOPE environment variable, using comma (",") to separate values.

  --interface-transformation-oas-v2=<value>
      An OAS v2 snippet that shows how the policy affects an API specification, in markdown format. You can define this in
      the POLICY_INTERFACE_TRANSFORMATION_OAS_V2 environment variable.

  --interface-transformation-oas-v3=<value>
      An OAS v3 snippet that shows how the policy affects an API specification, in markdown format. You can define this in
      the POLICY_INTERFACE_TRANSFORMATION_OAS_V3 environment variable.

  --interface-transformation-raml=<value>
      A RAML v0.8 snippet that shows how the policy affects an API specification, in markdown format. You can define this
      in the POLICY_INTERFACE_TRANSFORMATION_RAML environment variable.

  --interface-transformation-raml-v1=<value>
      A RAML v1.0 snippet that shows how the policy affects an API specification, in markdown format. You can define this
      in the POLICY_INTERFACE_TRANSFORMATION_RAML_V1 environment variable.

  --is-sla-based
      Whether the policy is based on API consumption SLA tiers or not. You can define this in the POLICY_IS_SLA_BASED
      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.

  --provided-characteristics=<value>...
      [default: ] The characteristics that will be provided by the policy. You can define this in the
      POLICY_PROVIDED_CHARACTERISTICS environment variable, using comma (",") to separate values.

  --requires-spec
      Whether the policy requires an API specification or not. You can define this in the POLICY_REQUIRES_SPEC environment
      variable.

  --username=<value>
      Username. You can define this in the ANYPOINT_USERNAME environment variable.

  --version=<value>
      [default: 1.0.0] The initial version of the policy to generate, with format <major>.<minor>.<patch>. You can define
      this in the POLICY_VERSION environment variable.

DESCRIPTION
  Create a project to develop a new Policy

@mulesoft/anypoint-cli-pdk-plugin version

USAGE
  $ @mulesoft/anypoint-cli-pdk-plugin version

See code: @oclif/plugin-version