archetype:generate

Full name:

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

Description:

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

Attributes:

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

Required Parameters

NameTypeSinceDescriptioninteractiveModeBoolean-User settings use to check the interactiveMode.
Default value is: ${settings.interactiveMode}.

Optional Parameters

NameTypeSinceDescriptionarchetypeArtifactIdString-The archetype's artifactId.archetypeCatalogString-The archetype catalogs to use to build a list and let the userchoose from. It is a comma separated list of catalogs. Catalogs usefollowing schemes:

• 'file://...' witharchetype-catalog.xml automatically appended whenpointing to a directory
• 'http://...' or 'https://...' witharchetype-catalog.xml always appended
• 'local' which is the shortcut for'file://~/.m2/archetype-catalog.xml'
• 'remote' which is the shortcut for Maven Centralrepository, ie 'http://repo1.maven.org/maven2'
• 'internal' which is an internal catalog

Since 2.0-alpha-5, default value is no longerinternal,local but remote,local. If MavenCentral repository catalog file is empty,internalcatalog is used instead.
Default value is: remote,local.archetypeGroupIdString-The archetype's groupId.archetypeRepositoryString-The archetype's repository.archetypeVersionString-The archetype's version.basedirFile-(no description)filterString2.1Applying some filter on displayed archetypes list: format isartifactId orgroupId:artifactId.

• org.apache: -> displays all archetypes which contain org.apache in groupId
• :jee or jee -> displays allarchetypes which contain jee in artifactId
• org.apache:jee -> displays all archetypes which contain org.apache in groupId AND jee in artifactId

goalsString-Additional goals to immediately run on the project created from thearchetype.

Parameter Details

archetypeArtifactId:

The archetype's artifactId.

• Type: java.lang.String
• Required: No
• Expression: ${archetypeArtifactId}

---

archetypeCatalog:

The archetype catalogs to use to build a list and let the userchoose from. It is a comma separated list of catalogs. Catalogs usefollowing schemes:

• 'file://...' witharchetype-catalog.xml automatically appended whenpointing to a directory
• 'http://...' or 'https://...' witharchetype-catalog.xml always appended
• 'local' which is the shortcut for'file://~/.m2/archetype-catalog.xml'
• 'remote' which is the shortcut for Maven Centralrepository, ie 'http://repo1.maven.org/maven2'
• 'internal' which is an internal catalog

Since 2.0-alpha-5, default value is no longerinternal,local but remote,local. If MavenCentral repository catalog file is empty,internalcatalog is used instead.

• Type: java.lang.String
• Required: No
• Expression: ${archetypeCatalog}
• Default: remote,local

---

archetypeGroupId:

The archetype's groupId.

• Type: java.lang.String
• Required: No
• Expression: ${archetypeGroupId}

---

archetypeRepository:

The archetype's repository.

• Type: java.lang.String
• Required: No
• Expression: ${archetypeRepository}

---

archetypeVersion:

The archetype's version.

• Type: java.lang.String
• Required: No
• Expression: ${archetypeVersion}

---

basedir:

(no description)

• Type: java.io.File
• Required: No
• Expression: ${basedir}

---

filter:

Applying some filter on displayed archetypes list: format isartifactId orgroupId:artifactId.

• org.apache: -> displays all archetypes whichcontain org.apache in groupId
• :jee or jee -> displays allarchetypes which contain jee in artifactId
• org.apache:jee -> displays all archetypes whichcontain org.apache in groupId AND jee in artifactId

• Type: java.lang.String
• Since: 2.1
• Required: No
• Expression: ${filter}

---

goals:

Additional goals to immediately run on the project created from thearchetype.

• Type: java.lang.String
• Required: No
• Expression: ${goals}

---

interactiveMode:

User settings use to check the interactiveMode.

• Type: java.lang.Boolean
• Required: Yes
• Expression: ${interactiveMode}
• Default: ${settings.interactiveMode}