dependency:tree

Full name:

org.apache.maven.plugins:maven-dependency-plugin:3.0.1:tree

Description:

Displays the dependency tree for this project.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency collection of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.0-alpha-5.

Optional Parameters

Name Type Since Description
appendOutput boolean 2.2 Whether to append outputs into the output file or overwrite it.
Default value is: false.
User property is: appendOutput.
excludes String 2.0-alpha-6 A comma-separated list of artifacts to filter from the serialized dependency tree, or null not to filter any artifacts from the dependency tree. The filter syntax is:
[groupId]:[artifactId]:[type]:[version]
where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard.

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.


User property is: excludes.
includes String 2.0-alpha-6 A comma-separated list of artifacts to filter the serialized dependency tree by, or null not to filter the dependency tree. The filter syntax is:
[groupId]:[artifactId]:[type]:[version]
where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard.

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.


User property is: includes.
outputFile File 2.0-alpha-5 If specified, this parameter will cause the dependency tree to be written to the path specified, instead of writing to the console.
User property is: outputFile.
outputType String 2.2 If specified, this parameter will cause the dependency tree to be written using the specified format. Currently supported format are: text, dot, graphml and tgf. These formats can be plotted to image files. An example of how to plot a dot file using pygraphviz can be found here.
Default value is: text.
User property is: outputType.
scope String 2.0-alpha-5 The scope to filter by when resolving the dependency tree, or null to include dependencies from all scopes. Note that this feature does not currently work due to MSHARED-4
User property is: scope.
skip boolean 2.7 Skip plugin execution completely.
Default value is: false.
User property is: skip.
tokens String 2.0-alpha-6 The token set name to use when outputting the dependency tree. Possible values are whitespace, standard or extended, which use whitespace, standard (ie ASCII) or extended character sets respectively.
Default value is: standard.
User property is: tokens.
verbose boolean 2.0-alpha-6 Whether to include omitted nodes in the serialized dependency tree. Notice this feature actually uses Maven 2 algorithm and may give wrong results when used with Maven 3.
Default value is: false.
User property is: verbose.

Parameter Details

appendOutput:

Whether to append outputs into the output file or overwrite it.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • User Property: appendOutput
  • Default: false

excludes:

A comma-separated list of artifacts to filter from the serialized dependency tree, or null not to filter any artifacts from the dependency tree. The filter syntax is:
[groupId]:[artifactId]:[type]:[version]
where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard.

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

  • Type: java.lang.String
  • Since: 2.0-alpha-6
  • Required: No
  • User Property: excludes

includes:

A comma-separated list of artifacts to filter the serialized dependency tree by, or null not to filter the dependency tree. The filter syntax is:
[groupId]:[artifactId]:[type]:[version]
where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard.

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

  • Type: java.lang.String
  • Since: 2.0-alpha-6
  • Required: No
  • User Property: includes

outputFile:

If specified, this parameter will cause the dependency tree to be written to the path specified, instead of writing to the console.
  • Type: java.io.File
  • Since: 2.0-alpha-5
  • Required: No
  • User Property: outputFile

outputType:

If specified, this parameter will cause the dependency tree to be written using the specified format. Currently supported format are: text, dot, graphml and tgf. These formats can be plotted to image files. An example of how to plot a dot file using pygraphviz can be found here.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • User Property: outputType
  • Default: text

scope:

The scope to filter by when resolving the dependency tree, or null to include dependencies from all scopes. Note that this feature does not currently work due to MSHARED-4
  • Type: java.lang.String
  • Since: 2.0-alpha-5
  • Required: No
  • User Property: scope

skip:

Skip plugin execution completely.
  • Type: boolean
  • Since: 2.7
  • Required: No
  • User Property: skip
  • Default: false

tokens:

The token set name to use when outputting the dependency tree. Possible values are whitespace, standard or extended, which use whitespace, standard (ie ASCII) or extended character sets respectively.
  • Type: java.lang.String
  • Since: 2.0-alpha-6
  • Required: No
  • User Property: tokens
  • Default: standard

verbose:

Whether to include omitted nodes in the serialized dependency tree. Notice this feature actually uses Maven 2 algorithm and may give wrong results when used with Maven 3.
  • Type: boolean
  • Since: 2.0-alpha-6
  • Required: No
  • User Property: verbose
  • Default: false