Built by Maven

install:install-file

Full name:

org.apache.maven.plugins:maven-install-plugin:3.1.0:install-file

Description:

Installs a file in the local repository.

Attributes:

  • Executes as an aggregator plugin.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<file> File - The file to be installed in the local repository.
User property is: file.

Optional Parameters

Name Type Since Description
<artifactId> String - ArtifactId of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.
User property is: artifactId.
<classifier> String 2.2 Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main artifact.
User property is: classifier.
<generatePom> Boolean 2.1 Generate a minimal POM for the artifact if none is supplied via the parameter pomFile. Defaults to true if there is no existing POM in the local repository yet.
User property is: generatePom.
<groupId> String - GroupId of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.
User property is: groupId.
<javadoc> File 2.3 The bundled API docs for the artifact.
User property is: javadoc.
<localRepositoryPath> File 2.2 The path for a specific local repository directory. If not specified the local repository path configured in the Maven settings will be used.
User property is: localRepositoryPath.
<packaging> String - Packaging type of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.
User property is: packaging.
<pomFile> File 2.1 Location of an existing POM file to be installed alongside the main artifact, given by the file parameter.
User property is: pomFile.
<sources> File 2.3 The bundled sources for the artifact.
User property is: sources.
<version> String - Version of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.
User property is: version.

Parameter Details

<artifactId>

ArtifactId of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.
  • Type: java.lang.String
  • Required: No
  • User Property: artifactId

<classifier>

Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main artifact.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • User Property: classifier

<file>

The file to be installed in the local repository.
  • Type: java.io.File
  • Required: Yes
  • User Property: file

<generatePom>

Generate a minimal POM for the artifact if none is supplied via the parameter pomFile. Defaults to true if there is no existing POM in the local repository yet.
  • Type: java.lang.Boolean
  • Since: 2.1
  • Required: No
  • User Property: generatePom

<groupId>

GroupId of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.
  • Type: java.lang.String
  • Required: No
  • User Property: groupId

<javadoc>

The bundled API docs for the artifact.
  • Type: java.io.File
  • Since: 2.3
  • Required: No
  • User Property: javadoc

<localRepositoryPath>

The path for a specific local repository directory. If not specified the local repository path configured in the Maven settings will be used.
  • Type: java.io.File
  • Since: 2.2
  • Required: No
  • User Property: localRepositoryPath

<packaging>

Packaging type of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.
  • Type: java.lang.String
  • Required: No
  • User Property: packaging

<pomFile>

Location of an existing POM file to be installed alongside the main artifact, given by the file parameter.
  • Type: java.io.File
  • Since: 2.1
  • Required: No
  • User Property: pomFile

<sources>

The bundled sources for the artifact.
  • Type: java.io.File
  • Since: 2.3
  • Required: No
  • User Property: sources

<version>

Version of the artifact to be installed. Retrieved from POM file if one is specified or extracted from pom.xml in jar if available.
  • Type: java.lang.String
  • Required: No
  • User Property: version