Built by Maven

install:install-file

Full name:

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

Description:

Installs a file in the local repository.

Attributes:

  • Executes as an aggregator goal.
  • 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: 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: 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: classifier
<extension> String 3.1.3 Extension of the artifact to be installed. If set, will override plugin own logic to detect extension. If not set, as Maven expected, packaging determines the artifact extension.
User Property: extension
<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: 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: groupId
<javadoc> File 2.3 The bundled API docs for the artifact.
User Property: 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: 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: 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: pomFile
<sources> File 2.3 The bundled sources for the artifact.
User Property: 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: 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

<extension>

Extension of the artifact to be installed. If set, will override plugin own logic to detect extension. If not set, as Maven expected, packaging determines the artifact extension.
  • Type: java.lang.String
  • Since: 3.1.3
  • Required: No
  • User Property: extension

<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