Built by Maven

help:describe

Full name:

org.apache.maven.plugins:maven-help-plugin:3.5.1:describe

Description:

Displays a list of the attributes for a Maven Plugin and/or goals (aka Mojo - Maven plain Old Java Object).
See also: What is a Mojo?

Attributes:

  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0.

Optional Parameters

Name Type Since Description
<artifactId> String - The Maven Plugin artifactId to describe.
Note: Should be used with groupId parameter.
User Property: artifactId
<cmd> String 2.1 A Maven command like a single goal or a single phase following the Maven command line:
mvn [options] [<goal(s)>] [<phase(s)>]
User Property: cmd
<detail> boolean 2.1 This flag specifies that a detailed (verbose) list of goal (Mojo) information should be given.
Default: false
User Property: detail
<goal> String 2.1 The goal name of a Mojo to describe within the specified Maven Plugin. If this parameter is specified, only the corresponding goal (Mojo) will be described, rather than the whole Plugin.
User Property: goal
<groupId> String - The Maven Plugin groupId to describe.
Note: Should be used with artifactId parameter.
User Property: groupId
<minimal> boolean 2.1 This flag specifies that a minimal list of goal (Mojo) information should be given.
Default: false
User Property: minimal
<output> File - Optional parameter to write the output of this help to a given file using UTF-8 encoding, instead of writing to the console.
Note: Could be a relative path.
User Property: output
<plugin> String - The Maven Plugin to describe. This must be specified in one of three ways:
  1. plugin-prefix, i.e. 'help'
  2. groupId:artifactId, i.e. 'org.apache.maven.plugins:maven-help-plugin'
  3. groupId:artifactId:version, i.e. 'org.apache.maven.plugins:maven-help-plugin:2.0'

User Property: plugin
Alias: prefix
<version> String - The Maven Plugin version to describe.
Note: Should be used with groupId/artifactId parameters.
User Property: version

Parameter Details

<artifactId>

The Maven Plugin artifactId to describe.
Note: Should be used with groupId parameter.
  • Type: java.lang.String
  • Required: No
  • User Property: artifactId

<cmd>

A Maven command like a single goal or a single phase following the Maven command line:
mvn [options] [<goal(s)>] [<phase(s)>]
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • User Property: cmd

<detail>

This flag specifies that a detailed (verbose) list of goal (Mojo) information should be given.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: detail
  • Default: false

<goal>

The goal name of a Mojo to describe within the specified Maven Plugin. If this parameter is specified, only the corresponding goal (Mojo) will be described, rather than the whole Plugin.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • User Property: goal

<groupId>

The Maven Plugin groupId to describe.
Note: Should be used with artifactId parameter.
  • Type: java.lang.String
  • Required: No
  • User Property: groupId

<minimal>

This flag specifies that a minimal list of goal (Mojo) information should be given.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: minimal
  • Default: false

<output>

Optional parameter to write the output of this help to a given file using UTF-8 encoding, instead of writing to the console.
Note: Could be a relative path.
  • Type: java.io.File
  • Required: No
  • User Property: output

<plugin>

The Maven Plugin to describe. This must be specified in one of three ways:
  1. plugin-prefix, i.e. 'help'
  2. groupId:artifactId, i.e. 'org.apache.maven.plugins:maven-help-plugin'
  3. groupId:artifactId:version, i.e. 'org.apache.maven.plugins:maven-help-plugin:2.0'
  • Type: java.lang.String
  • Required: No
  • User Property: plugin
  • Alias: prefix

<version>

The Maven Plugin version to describe.
Note: Should be used with groupId/artifactId parameters.
  • Type: java.lang.String
  • Required: No
  • User Property: version