Maven Archetype Plugin - Introduction

Apache > Maven > Maven Archetype > Maven Archetype Plugin

Last Published: 2010-03-27 | Version: 2.0-alpha-5-SNAPSHOT

Overview

Project Documentation

Maven Projects

Built by Maven

Maven 2 Archetype Plugin

The Archetype Plugin allows the user to create a Maven 2 project from an existing template called an archetype.

It also allows the user to create an archetype from an existing project.

Usage

Instructions on how to use the Archetype Plugin to create a project can be found on the usage page.

The Archetype Plugin is embedded in IDEs Eclipse, NetBeans, IDEA.

Instructions on how to use the Archetype Plugin to create an archetype from an existing project can be found on the advanced usage page.

Goals Overview

The archetype plugin has four goals:

archetype:create creates a Maven 2 project from an archetype. It use the behaviour of the Archetype Plugin version 1.0-alpha-7.
archetype:generate ask the user to choose an archetype from the archetype catalog, and retrieves it from the remote repository. Once retrieved, it is processed to create a working Maven project.
archetype:create-from-project creates an archetype from an existing project.
archetype:crawl search a repository for archetypes and updates a catalog.

Examples

The following examples show how to use the Archetype Plugin in more advanced usecases:

Generate projects in batch mode
Generate project using an alternative catalog
Create an archetype from a multi module project
Create an archetype with a property file
Handcrafting an archetype or features available to an archetype when not created by create-from-project - TBD
Generate a sub module from an archetype - TBD
Create an archetype in interactive mode - TBD

Specification

The specification page contains the specification of the main parts of the Archetype Plugin.