Roo Command Reference Guide Maven Plugin

This plugin is for generating Spring Roo command reference guide as part of Maven build process. It will perform a bootstrap based on user provided Spring context XML file, find all Spring Roo command classes and generate reference guide based on Roo command annotations. This plugin also supports class filter parameter which can make it only generate reference guide on a specified set of Roo commands.

This plugin is based on Spring Roo shell command "reference guide" and has been used as part of Spring Surf project.

Goals Overview

Goals available for this plugin:

  • generate-doc Generates DocBook Xml for Spring Roo command reference guide.


General instructions on how to use the Plugin Name can be found on the usage page. Some more specific use cases are described in the examples given below.

In case you still have questions regarding the plugin's usage, please have a look at the FAQ.


To provide you with better understanding on some usages of the Roo Command Documentation Maven Plugin, you can take a look into the following examples: