Plugin Details
This report describes goals, parameters details, requirements and sample usage of this plugin.
Goals
Goals available for this plugin:
| Goal | Description |
|---|---|
| toolbox:add-core-extension | Adds core extension. |
| toolbox:add-managed-dependency | Adds managed dependency. |
| toolbox:add-managed-plugin | Adds managed plugin. |
| toolbox:affected-by | Lists reactor module artifactIds whose dependency tree contains an artifact matching the given spec. |
| toolbox:check-exclusions | Checks present exclusions. |
| toolbox:classpath | Prints the classpath of current project. |
| toolbox:classpath-list | Prints the classpath of current project as list of artifacts. |
| toolbox:copy-dependencies | Resolves selected dependencies and copies resulting artifacts to target. |
| toolbox:copy-transitive | Resolves selected dependencies transitively and copies all of them to target. |
| toolbox:core-extension-versions | Lists available core extension versions of Maven. |
| toolbox:dependency-versions | Lists available versions of Maven Project dependencies. |
| toolbox:dirty-tree | Displays dependency dirty tree of Maven Project. |
| toolbox:dm-list | Displays dependency management list of Maven Project. |
| toolbox:dm-tree | Displays dependency management tree of Maven Project. |
| toolbox:dump | Dumps the MIMA environment. |
| toolbox:effective-model | Shows effective model for project; is aggregator mojo. |
| toolbox:effective-model-all | Shows effective model for project. |
| toolbox:extension-versions | Lists available versions of Maven Project extensions. |
| toolbox:flatten-bom | Flattens a BOM and attaches it. |
| toolbox:gav-artifact-path | Prints expected relative path for a given Maven Artifact in a local repository. |
| toolbox:gav-classpath | Resolves Maven Artifact and prints out the classpath. |
| toolbox:gav-classpath-conflict | Resolves two Maven Artifact and prints out the classpath conflicts. |
| toolbox:gav-classpath-diff | Resolves two Maven Artifact and prints out the classpath differences. |
| toolbox:gav-classpath-list | Resolves Maven Artifact and prints out the classpath as artifacts. |
| toolbox:gav-copy | Copies artifacts from a specified artifact source to specified artifact sink. |
| toolbox:gav-copy-gav |
Deprecated. Use copy resolve(gav(GAV)) sink instead.Resolves a given GAV and copies resulting artifact to target. |
| toolbox:gav-copy-recorded | Copy all recorded Maven Artifacts to given sink. |
| toolbox:gav-copy-transitive |
Deprecated. Use copy resolveTransitive(gav(GAV), scope)) sink instead.Resolves Maven Artifact transitively and copies all of them to target. |
| toolbox:gav-deploy | Deploys Maven Artifact into remote repository. |
| toolbox:gav-deploy-recorded | Deploys all recorded Maven Artifacts to remote repository. |
| toolbox:gav-dirty-tree | Displays dirty tree of Maven Artifact. |
| toolbox:gav-dm-list | Displays dependency management list of Maven Artifact. |
| toolbox:gav-dm-list-conflict | Displays dependency management list conflicts of Maven Artifact. |
| toolbox:gav-dm-tree | Displays dependency management tree of Maven Artifact. |
| toolbox:gav-dm-tree-diff | Displays dependency management tree diff of Maven Artifact. |
| toolbox:gav-dm-tree-find | Collects and displays paths to matched artifacts in depMgt tree, if exists. |
| toolbox:gav-dump | Dumps MIMA environment. |
| toolbox:gav-effective-model | Shows effective model for given GAV. |
| toolbox:gav-exists | Checks given GAV for existence in a remote repository. |
| toolbox:gav-flatten-bom | Flattens a BOM and outputs it to output. |
| toolbox:gav-identify | Identify artifact, either by provided SHA-1 or calculated SHA-1 of a file pointed at. |
| toolbox:gav-install | Installs an artifact into local repository. |
| toolbox:gav-libyear | Calculates "libyear" for Maven Artifacts (for direct dependencies or transitively). |
| toolbox:gav-list | Lists remote repository by given "gavoid" (G or G:A or G:A:V where V may be a version constraint). |
| toolbox:gav-list-available-plugins | List available plugins for given Gs. |
| toolbox:gav-list-repositories | Lists repositories used to resolve given GAV. |
| toolbox:gav-local-repository-path | Prints Maven Local Repository basedir. |
| toolbox:gav-metadata-path | Prints expected relative path for a given Maven Metadata in a local repository. |
| toolbox:gav-record | Controls recording of resolved Maven Artifacts. |
| toolbox:gav-repl | No description. |
| toolbox:gav-resolve | Resolves Maven Artifacts. |
| toolbox:gav-resolve-transitive | Resolves Maven Artifacts transitively. |
| toolbox:gav-search | Searches Maven Artifacts using SMO service. |
| toolbox:gav-tree | Displays dependency tree of Maven Artifact. |
| toolbox:gav-tree-diff | Displays dependency tree differences of two Maven Artifact. |
| toolbox:gav-tree-find | Collects and displays paths to matched artifacts in tree, if exists. |
| toolbox:gav-verify | Verifies Maven Artifact against known SHA-1 using origin repository. |
| toolbox:gav-versions | Lists available versions for Maven Artifacts. |
| toolbox:help | Display help information on toolbox.
Call mvn toolbox:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. |
| toolbox:libyear | Calculates "libyear" for Maven Projects (for direct dependencies or transitively). |
| toolbox:list-repositories | Resolves transitively current project and outputs used repositories. |
| toolbox:lock-plugin-versions | Locks available versions of Maven Project used plugins. |
| toolbox:new-project | Creates a new project. |
| toolbox:new-subproject | Creates a new subproject. |
| toolbox:parent-child-tree | Displays project inheritance of Maven Projects. |
| toolbox:parent-versions | Lists available parents of Maven Project. |
| toolbox:plugin-classpath | Resolves transitively a project given plugin and outputs its classpath. |
| toolbox:plugin-libyear | Calculates "libyear" for Maven Project (for plugins or transitively). |
| toolbox:plugin-list-repositories | Resolves transitively a project given plugin and outputs used repositories. |
| toolbox:plugin-resolve | Resolves transitively given project build plugin. |
| toolbox:plugin-resolve-transitive | Resolves transitively given project build plugin. |
| toolbox:plugin-tree | Collects project given plugin and output its dependency tree. |
| toolbox:plugin-tree-find | Collects paths to matched artifact from plugins, if exists. |
| toolbox:plugin-versions | Lists available versions of Maven Project plugins. |
| toolbox:project-dependency-graph | Renders project interdependencies of Maven Projects as image. It uses Graphviz Java that is optional dependency of the plugin. If you want to use this goal, you must add Graphviz Java as dependency to plugin. |
| toolbox:project-dependency-tree | Displays project interdependencies of Maven Projects as tree (forest). |
| toolbox:remove-core-extension | Removes core extension. |
| toolbox:resolve | Resolves selected dependencies. |
| toolbox:resolve-transitive | Resolves transitively selected dependencies. |
| toolbox:set-version | Sets version of current project and all children. |
| toolbox:subproject-tree | Displays subproject collection of Maven Projects. |
| toolbox:tree | Displays dependency tree of Maven Project. |
| toolbox:tree-find | Collects paths to matched artifact, if exists. |
| toolbox:versions | Lists available updates to everything of Maven Project (including core extensions). |
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
| Maven | [3.6.3,) |
| JDK | [17,) |
System Requirements History
The following specifies the minimum requirements to run this Maven plugin for historical versions:
| Plugin Version | Maven | JDK |
|---|---|---|
| from 0.11.0 to 0.15.7 | [3.6.3,) | 17 |
| from 0.6.0 to 0.10.2 | [3.6.3,) | 11 |
| 0.5.2 | [3.6.3,) | - |
| from 0.5.0 to 0.5.1 | [3.6.3,) | 11 |
| from 0.2.0 to 0.3.6 | [3.6.3,) | 21 |
| from 0.1.0 to 0.1.33 | 3.6.3 | 11 |
Usage
You should specify the version in your project's plugin configuration:
<project>
...
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>eu.maveniverse.maven.plugins</groupId>
<artifactId>toolbox</artifactId>
<version>0.15.7</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>eu.maveniverse.maven.plugins</groupId>
<artifactId>toolbox</artifactId>
</plugin>
...
</plugins>
</build>
...
</project>For more information, see "Guide to Configuring Plug-ins"