Fork me on GitHub

archetype:generate

Full name:

org.apache.maven.plugins:maven-archetype-plugin:2.3:generate

Description:

Generates a new project from an archetype, or updates the actual project if using a partial archetype. If the project is fully generated, it is generated in a directory corresponding to its artifactId. If the project is updated with a partial archetype, it is done in the current directory.

Attributes:

  • Invokes the execution of the lifecycle phase generate-sources prior to executing itself.

Required Parameters

Name Type Since Description
interactiveMode Boolean - User settings used to check the interactiveMode.
Default value is: ${settings.interactiveMode}.
User property is: interactiveMode.

Optional Parameters

Name Type Since Description
archetypeArtifactId String - The archetype's artifactId.
User property is: archetypeArtifactId.
archetypeCatalog String - The archetype catalogs to use to build a list and let the user choose from. It is a comma separated list of catalogs. Catalogs use the following schemes:
  • 'file://...' with archetype-catalog.xml automatically appended when pointing to a directory
  • 'http://...' or 'https://...' with archetype-catalog.xml always appended
  • 'local' which is the shortcut for 'file://~/.m2/archetype-catalog.xml'
  • 'remote' which is the shortcut for Maven Central repository, ie 'http://repo.maven.apache.org/maven2'
  • 'internal' which is an internal catalog
Since 2.0-alpha-5, default value is no longer internal,local but remote,local. If Maven Central repository catalog file is empty, internal catalog is used instead.
Default value is: remote,local.
User property is: archetypeCatalog.
archetypeGroupId String - The archetype's groupId.
User property is: archetypeGroupId.
archetypeRepository String - The archetype's repository.
User property is: archetypeRepository.
archetypeVersion String - The archetype's version.
User property is: archetypeVersion.
basedir File - (no description)
Default value is: ${basedir}.
filter String 2.1 Applying some filter on displayed archetypes list: format is artifactId or groupId:artifactId.
  • org.apache: -> displays all archetypes which contain org.apache in groupId
  • :jee or jee -> displays all archetypes which contain jee in artifactId
  • org.apache:jee -> displays all archetypes which contain org.apache in groupId AND jee in artifactId

User property is: filter.
goals String - Additional goals to immediately run on the project created from the archetype.
User property is: goals.

Parameter Details

archetypeArtifactId:

The archetype's artifactId.
  • Type: java.lang.String
  • Required: No
  • User Property: archetypeArtifactId

archetypeCatalog:

The archetype catalogs to use to build a list and let the user choose from. It is a comma separated list of catalogs. Catalogs use the following schemes:
  • 'file://...' with archetype-catalog.xml automatically appended when pointing to a directory
  • 'http://...' or 'https://...' with archetype-catalog.xml always appended
  • 'local' which is the shortcut for 'file://~/.m2/archetype-catalog.xml'
  • 'remote' which is the shortcut for Maven Central repository, ie 'http://repo.maven.apache.org/maven2'
  • 'internal' which is an internal catalog
Since 2.0-alpha-5, default value is no longer internal,local but remote,local. If Maven Central repository catalog file is empty, internal catalog is used instead.
  • Type: java.lang.String
  • Required: No
  • User Property: archetypeCatalog
  • Default: remote,local

archetypeGroupId:

The archetype's groupId.
  • Type: java.lang.String
  • Required: No
  • User Property: archetypeGroupId

archetypeRepository:

The archetype's repository.
  • Type: java.lang.String
  • Required: No
  • User Property: archetypeRepository

archetypeVersion:

The archetype's version.
  • Type: java.lang.String
  • Required: No
  • User Property: archetypeVersion

basedir:

(no description)
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}

filter:

Applying some filter on displayed archetypes list: format is artifactId or groupId:artifactId.
  • org.apache: -> displays all archetypes which contain org.apache in groupId
  • :jee or jee -> displays all archetypes which contain jee in artifactId
  • org.apache:jee -> displays all archetypes which contain org.apache in groupId AND jee in artifactId
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • User Property: filter

goals:

Additional goals to immediately run on the project created from the archetype.
  • Type: java.lang.String
  • Required: No
  • User Property: goals

interactiveMode:

User settings used to check the interactiveMode.
  • Type: java.lang.Boolean
  • Required: Yes
  • User Property: interactiveMode
  • Default: ${settings.interactiveMode}