This appendix was automatically built from Roo 1.2.5.RELEASE [rev 8341dc2].
Commands are listed in alphabetic order, and are shown in monospaced font with any mandatory options you must specify when using the command. Most commands accept a large number of options, and all of the possible options for each command are presented in this appendix.
Add On Commands are contained in org.springframework.roo.addon.roobot.client.AddOnCommands.
Provide anonymous ratings and comments on a Spring Roo Add-on (your feedback will be published publicly)
addon feedback bundle --bundleSymbolicName --rating
The bundle symbolic name for the add-on of interest; no default value (mandatory)
How much did you like this add-on?; no default value (mandatory)
Your comments on this add-on eg "this is my comment!"; limit of 140 characters; no default value
Provide information about a specific Spring Roo Add-on
addon info bundle --bundleSymbolicName
The bundle symbolic name for the add-on of interest; no default value (mandatory)
Provide information about a specific Spring Roo Add-on
addon info id --searchResultId
The bundle ID as presented via the addon list or addon search command; no default value (mandatory)
Install Spring Roo Add-on
addon install bundle --bundleSymbolicName
The bundle symbolic name for the add-on of interest; no default value (mandatory)
Install Spring Roo Add-on
addon install id --searchResultId
The bundle ID as presented via the addon list or addon search command; no default value (mandatory)
List all known Spring Roo Add-ons (up to the maximum number displayed on a single page)
addon list
Refresh the add-on index from the Internet; default if option present: 'true'; default if option not present: 'false'
The maximum number of lines displayed per add-on; default: '2'
The maximum number of add-ons to list; default: '99'
Only display trusted add-ons in search results; default if option present: 'true'; default if option not present: 'false'
Only display community provided add-ons in search results; default if option present: 'true'; default if option not present: 'false'
Only display compatible add-ons in search results; default if option present: 'true'; default if option not present: 'false'
Remove Spring Roo Add-on
addon remove --bundleSymbolicName
The bundle symbolic name for the add-on of interest; no default value (mandatory)
Search all known Spring Roo Add-ons
addon search
A comma separated list of search terms; default: '*'
Refresh the add-on index from the Internet; default if option present: 'true'; default if option not present: 'false'
The maximum number of lines displayed per add-on; default: '2'
The maximum number of add-ons to list; default: '20'
Only display trusted add-ons in search results; default if option present: 'true'; default if option not present: 'false'
Only display compatible add-ons in search results; default if option present: 'true'; default if option not present: 'false'
Only display community provided add-ons in search results; default if option present: 'true'; default if option not present: 'false'
Only display add-ons in search results that offer this command; no default value
Upgrade all relevant Spring Roo Add-ons / Components for the current stability level
addon upgrade all
This command does not accept any options.
List available Spring Roo Add-on / Component upgrades
addon upgrade available
The stability level of add-ons or components which are presented for upgrading (default: ANY); no default value
Upgrade a specific Spring Roo Add-on / Component
addon upgrade bundle --bundleSymbolicName
The bundle symbolic name for the add-on to upgrade; no default value (mandatory)
Upgrade a specific Spring Roo Add-on / Component from a search result ID
addon upgrade id --searchResultId
The bundle ID as presented via the addon list or addon search command; no default value (mandatory)
Backup Commands are contained in org.springframework.roo.addon.backup.BackupCommands.
Classpath Commands are contained in org.springframework.roo.classpath.operations.ClasspathCommands.
Creates a new Java class source file in any project path
class --class
The name of the class to create; no default value (mandatory)
Whether the generated class should have common Roo annotations; default if option present: 'true'; default if option not present: 'false'
Source directory to create the class in; default: 'FOCUSED|SRC_MAIN_JAVA'
The superclass (defaults to java.lang.Object); default if option not present: 'java.lang.Object'
The interface to implement; no default value
Whether the generated class should be marked as abstract; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Creates a class constructor
constructor
The name of the class to receive this constructor; default if option not present: '*'
The fields to include in the constructor. Multiple field names must be a double-quoted list separated by spaces
Inserts a new enum constant into an enum
enum constant --name
The name of the enum class to receive this field; default if option not present: '*'
The name of the constant; no default value (mandatory)
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Creates a new Java enum source file in any project path
enum type --class
The name of the enum to create; no default value (mandatory)
Source directory to create the enum in; default: 'FOCUSED|SRC_MAIN_JAVA'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Changes focus to a different type
focus --class
The type to focus on; no default value (mandatory)
Creates a new Java interface source file in any project path
interface --class
The name of the interface to create; no default value (mandatory)
Source directory to create the interface in; default: 'FOCUSED|SRC_MAIN_JAVA'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Controller Commands are contained in org.springframework.roo.addon.web.mvc.controller.ControllerCommands.
Scaffold controllers for all project entities without an existing controller - deprecated, use 'web mvc setup' + 'web mvc all' instead
controller all --package
The package in which new controllers will be placed; no default value (mandatory)
Create a new scaffold Controller (ie where we maintain CRUD automatically) - deprecated, use 'web mvc scaffold' instead
controller scaffold --class
The path and name of the controller object to be created; no default value (mandatory)
The name of the entity object which the controller exposes to the web tier; default if option not present: '*'
The base path under which the controller listens for RESTful requests (defaults to the simple name of the form backing object); no default value
A comma separated list of operations (only create, update, delete allowed) that should not be generated in the controller; no default value
Scaffold Spring MVC controllers for all project entities without an existing controller
web mvc all --package
The package in which new controllers will be placed; no default value (mandatory)
Create a new scaffold Controller (ie where Roo maintains CRUD functionality automatically)
web mvc scaffold --class
The path and name of the controller object to be created; no default value (mandatory)
The name of the form backing type which the controller exposes to the web tier; default if option not present: '*'
The base path under which the controller listens for RESTful requests (defaults to the simple name of the form backing object); no default value
A comma separated list of operations (only create, update, delete allowed) that should not be generated in the controller; no default value
Creator Commands are contained in org.springframework.roo.addon.creator.CreatorCommands.
Create a new advanced add-on for Spring Roo (commands + operations + metadata + trigger annotation + dependencies)
addon create advanced --topLevelPackage
The top level package of the new addon; no default value (mandatory)
Description of your addon (surround text with double quotes); no default value
Provide a custom project name (if not provided the top level package name will be used instead); no default value
Create a new Internationalization add-on for Spring Roo
addon create i18n --topLevelPackage --locale --messageBundle
The top level package of the new addon; no default value (mandatory)
The locale abbreviation (ie: en, or more specific like en_AU, or de_DE); no default value (mandatory)
Fully qualified path to the messages_xx.properties file; no default value (mandatory)
The full name of the language (used as a label for the UI); no default value
Fully qualified path to flag xx.png file; no default value
Description of your addon (surround text with double quotes); no default value
Provide a custom project name (if not provided the top level package name will be used instead); no default value
Create a new simple add-on for Spring Roo (commands + operations)
addon create simple --topLevelPackage
The top level package of the new addon; no default value (mandatory)
Description of your addon (surround text with double quotes); no default value
Provide a custom project name (if not provided the top level package name will be used instead); no default value
Create a new add-on for Spring Roo which wraps a maven artifact to create a OSGi compliant bundle
addon create wrapper --topLevelPackage --groupId --artifactId --version --vendorName --licenseUrl
The top level package of the new wrapper bundle; no default value (mandatory)
Dependency group id; no default value (mandatory)
Dependency artifact id); no default value (mandatory)
Dependency version; no default value (mandatory)
Dependency vendor name); no default value (mandatory)
Dependency license URL; no default value (mandatory)
Dependency documentation URL; no default value
Description of the bundle (use keywords with #-tags for better search integration); no default value
Provide a custom project name (if not provided the top level package name will be used instead); no default value
Contents of Import-Package in OSGi manifest; no default value
Data On Demand Commands are contained in org.springframework.roo.addon.dod.DataOnDemandCommands.
Creates a new data on demand for the specified entity
dod
The entity which this data on demand class will create and modify as required; default if option not present: '*'
The class which will be created to hold this data on demand provider (defaults to the entity name + 'DataOnDemand'); no default value
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Dbre Commands are contained in org.springframework.roo.addon.dbre.DbreCommands.
Displays database metadata
database introspect --schema
The database schema names. Multiple schema names must be a double-quoted list separated by spaces; no default value (mandatory)
The file to save the metadata to; no default value
Display database views; default if option present: 'true'; default if option not present: 'false'
Create and update entities based on database metadata
database reverse engineer --schema
The database schema names. Multiple schema names must be a double-quoted list separated by spaces; no default value (mandatory)
The package in which new entities will be placed; no default value
Create automatic integration tests for entities; default if option present: 'true'; default if option not present: 'false'
Reverse engineer database views; default if option present: 'true'; default if option not present: 'false'
The tables to include in reverse engineering. Multiple table names must be a double-quoted list separated by spaces
The tables to exclude from reverse engineering. Multiple table names must be a double-quoted list separated by spaces
Include non-portable JPA @Column attributes such as 'columnDefinition'; default if option present: 'true'; default if option not present: 'false'
Disable 'version' field; default if option present: 'true'; default if option not present: 'false'
Disable identifier auto generation; default if option present: 'true'; default if option not present: 'false'
Generate CRUD active record methods for each entity; default: 'true'
Generate a repository for each entity; default if option present: 'true'; default if option not present: 'false'
Generate a service for each entity; default if option present: 'true'; default if option not present: 'false'
Embedded Commands are contained in org.springframework.roo.addon.web.mvc.embedded.EmbeddedCommands.
Embed a document for your WEB MVC application
web mvc embed document --provider --documentId
The id of the document; no default value (mandatory)
The id of the document; no default value (mandatory)
The name of the jspx view; no default value
Embed media by URL into your WEB MVC application
web mvc embed generic --url
The url of the source to be embedded; no default value (mandatory)
The name of the jspx view; no default value
Embed a map for your WEB MVC application
web mvc embed map --location
The location of the map (ie "Sydney, Australia"); no default value (mandatory)
The name of the jspx view; no default value
Embed a photo gallery for your WEB MVC application
web mvc embed photos --provider --userId --albumId
The provider of the photo gallery; no default value (mandatory)
The user id; no default value (mandatory)
The album id; no default value (mandatory)
The name of the jspx view; no default value
Embed a video stream into your WEB MVC application
web mvc embed stream video --provider --streamId
The provider of the video stream; no default value (mandatory)
The stream id; no default value (mandatory)
The name of the jspx view; no default value
Embed twitter messages into your WEB MVC application
web mvc embed twitter --searchTerm
The search term to display results for; no default value (mandatory)
The name of the jspx view; no default value
Embed a video for your WEB MVC application
web mvc embed video --provider --videoId
The id of the video; no default value (mandatory)
The id of the video; no default value (mandatory)
The name of the jspx view; no default value
Equals Commands are contained in org.springframework.roo.addon.equals.EqualsCommands.
Add equals and hashCode methods to a class
equals
The name of the class; default if option not present: '*'
Whether to call the super class equals and hashCode methods; default if option present: 'true'; default if option not present: 'false'
The fields to exclude in the equals and hashcode methods. Multiple field names must be a double-quoted list separated by spaces
Felix Delegator are contained in org.springframework.roo.felix.FelixDelegator.
Finds bundles by name
osgi find --bundleSymbolicName
A bundle symbolic name to find; no default value (mandatory)
Passes a command directly through to the Felix shell infrastructure
osgi framework command
The command to pass to Felix (WARNING: no validation or security checks are performed); default: 'help'
Display headers for a specific bundle
osgi headers
Limit results to a specific bundle symbolic name; no default value
Installs a bundle JAR from a given URL
osgi install --url
The URL to obtain the bundle from; no default value (mandatory)
Displays the OSGi log information
osgi log
The maximum number of log messages to display; no default value
The minimum level of messages to display; no default value
Deploys a specific OSGi Bundle Repository (OBR) bundle
osgi obr deploy --bundleSymbolicName
The specific bundle to deploy; no default value (mandatory)
Displays information on a specific OSGi Bundle Repository (OBR) bundle
osgi obr info --bundleSymbolicName
The specific bundle to display information for; no default value (mandatory)
Lists all available bundles from the OSGi Bundle Repository (OBR) system
osgi obr list
Keywords to locate; no default value
Starts a specific OSGi Bundle Repository (OBR) bundle
osgi obr start --bundleSymbolicName
The specific bundle to start; no default value (mandatory)
Adds a new OSGi Bundle Repository (OBR) repository file URL
osgi obr url add --url
The URL to add (eg http://felix.apache.org/obr/releases.xml); no default value (mandatory)
Lists the currently-configured OSGi Bundle Repository (OBR) repository file URLs
osgi obr url list
This command does not accept any options.
Refreshes an existing OSGi Bundle Repository (OBR) repository file URL
osgi obr url refresh --url
The URL to refresh (list existing URLs via 'osgi obr url list'); no default value (mandatory)
Removes an existing OSGi Bundle Repository (OBR) repository file URL
osgi obr url remove --url
The URL to remove (list existing URLs via 'osgi obr url list'); no default value (mandatory)
Displays OSGi bundle information
osgi ps
The format of bundle information; default: 'BUNDLE_NAME'
Resolves a specific bundle ID
osgi resolve --bundleSymbolicName
The specific bundle to resolve; no default value (mandatory)
Lists the current SCR configuration
osgi scr config
This command does not accept any options.
Disables a specific SCR-defined component
osgi scr disable --componentId
The specific component identifier (use 'osgi scr list' to list component identifiers); no default value (mandatory)
Enables a specific SCR-defined component
osgi scr enable --componentId
The specific component identifier (use 'osgi scr list' to list component identifiers); no default value (mandatory)
Lists information about a specific SCR-defined component
osgi scr info --componentId
The specific component identifier (use 'osgi scr list' to list component identifiers); no default value (mandatory)
Lists all SCR-defined components
osgi scr list
Limit results to a specific bundle; no default value
Starts a bundle JAR from a given URL
osgi start --url
The URL to obtain the bundle from; no default value (mandatory)
Uninstalls a specific bundle
osgi uninstall --bundleSymbolicName
The specific bundle to uninstall; no default value (mandatory)
Updates a specific bundle
osgi update --bundleSymbolicName
The specific bundle to update ; no default value (mandatory)
The URL to obtain the updated bundle from; no default value
Field Commands are contained in org.springframework.roo.classpath.operations.FieldCommands.
Adds a private boolean field to an existing Java source file
field boolean --fieldName
The name of the field to add; no default value (mandatory)
The name of the class to receive this field; default if option not present: '*'
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must assert false; default if option present: 'true'; default if option not present: 'false'
Whether this value must assert true; default if option present: 'true'; default if option not present: 'false'
The JPA @Column name; no default value
Inserts an optional Spring @Value annotation with the given content; no default value
An optional comment for JavaDocs; no default value
Indicates to use a primitive type; default if option present: 'true'; default if option not present: 'false'
Indicates to mark the field as transient; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Adds a private date field to an existing Java source file
field date --fieldName --type
The name of the field to add; no default value (mandatory)
The Java type of the entity; no default value (mandatory)
The type of persistent storage to be used; no default value
The name of the class to receive this field; default if option not present: '*'
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be in the future; default if option present: 'true'; default if option not present: 'false'
Whether this value must be in the past; default if option present: 'true'; default if option not present: 'false'
The JPA @Column name; no default value
An optional comment for JavaDocs; no default value
Inserts an optional Spring @Value annotation with the given content; no default value
Indicates to mark the field as transient; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Indicates the style of the date format (ignored if dateTimeFormatPattern is specified); default: 'MEDIUM'
Indicates the style of the time format (ignored if dateTimeFormatPattern is specified); default: 'NONE'
Indicates a DateTime format pattern such as yyyy-MM-dd hh:mm:ss a; no default value
Adds a private @Embedded field to an existing Java source file
field embedded --fieldName --type
The name of the field to add; no default value (mandatory)
The Java type of the @Embeddable class; no default value (mandatory)
The name of the @Entity class to receive this field; default if option not present: '*'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Adds a private enum field to an existing Java source file
field enum --fieldName --type
The name of the field to add; no default value (mandatory)
The enum type of this field; no default value (mandatory)
The name of the class to receive this field; default if option not present: '*'
The JPA @Column name; no default value
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be null; default if option present: 'true'; default if option not present: 'false'
The fetch semantics at a JPA level; no default value
An optional comment for JavaDocs; no default value
Indicates to mark the field as transient; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Adds a byte array field for storing uploaded file contents (JSF-scaffolded UIs only)
field file --fieldName --contentType
The name of the file upload field to add; no default value (mandatory)
The name of the class to receive this field; default if option not present: '*'
The content type of the file; no default value (mandatory)
Whether the file is uploaded automatically when selected; default if option present: 'true'; default if option not present: 'false'
The JPA @Column name; no default value
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Adds a private List field to an existing Java source file (eg the 'one' side of a many-to-one)
field list --fieldName --type
The name of the field to add; no default value (mandatory)
The entity which will be contained within the Set; no default value (mandatory)
The name of the class to receive this field; default if option not present: '*'
The field name on the referenced type which owns the relationship; no default value
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be null; default if option present: 'true'; default if option not present: 'false'
The minimum number of elements in the collection; no default value
The maximum number of elements in the collection; no default value
The relationship cardinality at a JPA level; default: 'MANY_TO_MANY'
The fetch semantics at a JPA level; no default value
An optional comment for JavaDocs; no default value
Indicates to mark the field as transient; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Adds a private numeric field to an existing Java source file
field number --fieldName --type
The name of the field to add; no default value (mandatory)
The Java type of the entity; no default value (mandatory)
The name of the class to receive this field; default if option not present: '*'
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be null; default if option present: 'true'; default if option not present: 'false'
The BigDecimal string-based representation of the minimum value; no default value
The BigDecimal string based representation of the maximum value; no default value
Maximum number of integral digits accepted for this number; no default value
Maximum number of fractional digits accepted for this number; no default value
The minimum value; no default value
The maximum value; no default value
The JPA @Column name; no default value
An optional comment for JavaDocs; no default value
Inserts an optional Spring @Value annotation with the given content; no default value
Indicates to mark the field as transient; default if option present: 'true'; default if option not present: 'false'
Indicates to use a primitive type if possible; default if option present: 'true'; default if option not present: 'false'
Indicates whether to mark the field with a unique constraint; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Inserts a private field into the specified file
field other --fieldName --type
The name of the field; no default value (mandatory)
The Java type of this field; no default value (mandatory)
The name of the class to receive this field; default if option not present: '*'
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be null; default if option present: 'true'; default if option not present: 'false'
An optional comment for JavaDocs; no default value
The JPA @Column name; no default value
Inserts an optional Spring @Value annotation with the given content; no default value
Indicates to mark the field as transient; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Adds a private reference field to an existing Java source file (eg the 'many' side of a many-to-one)
field reference --fieldName --type
The name of the field to add; no default value (mandatory)
The Java type of the entity to reference; no default value (mandatory)
The name of the class to receive this field; default if option not present: '*'
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be null; default if option present: 'true'; default if option not present: 'false'
The JPA @JoinColumn name; no default value
The JPA @JoinColumn referencedColumnName; no default value
The relationship cardinality at a JPA level; default: 'MANY_TO_ONE'
The fetch semantics at a JPA level; no default value
An optional comment for JavaDocs; no default value
Indicates to mark the field as transient; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Adds a private Set field to an existing Java source file (eg the 'one' side of a many-to-one)
field set --fieldName --type
The name of the field to add; no default value (mandatory)
The entity which will be contained within the Set; no default value (mandatory)
The name of the class to receive this field; default if option not present: '*'
The field name on the referenced type which owns the relationship; no default value
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be null; default if option present: 'true'; default if option not present: 'false'
The minimum number of elements in the collection; no default value
The maximum number of elements in the collection; no default value
The relationship cardinality at a JPA level; default: 'MANY_TO_MANY'
The fetch semantics at a JPA level; no default value
An optional comment for JavaDocs; no default value
Indicates to mark the field as transient; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Adds a private string field to an existing Java source file
field string --fieldName
The name of the field to add; no default value (mandatory)
The name of the class to receive this field; default if option not present: '*'
Whether this value cannot be null; default if option present: 'true'; default if option not present: 'false'
Whether this value must be null; default if option present: 'true'; default if option not present: 'false'
The BigDecimal string-based representation of the minimum value; no default value
The BigDecimal string based representation of the maximum value; no default value
The minimum string length; no default value
The maximum string length; no default value
The required regular expression pattern; no default value
The JPA @Column name; no default value
Inserts an optional Spring @Value annotation with the given content; no default value
An optional comment for JavaDocs; no default value
Indicates to mark the field as transient; default if option present: 'true'; default if option not present: 'false'
Indicates whether to mark the field with a unique constraint; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Indicates that this field is a Large Object; default if option present: 'true'; default if option not present: 'false'
Finder Commands are contained in org.springframework.roo.addon.finder.FinderCommands.
Install finders in the given target (must be an entity)
finder add --finderName
The controller or entity for which the finders are generated; default if option not present: '*'
The finder string as generated with the 'finder list' command; no default value (mandatory)
List all finders for a given target (must be an entity)
finder list
The controller or entity for which the finders are generated; default if option not present: '*'
The depth of attribute combinations to be generated for the finders; default: '1'
A comma separated list of strings that must be present in a filter to be included; no default value
Gwt Commands are contained in org.springframework.roo.addon.gwt.GwtCommands.
Install Google Web Toolkit (GWT) into your project - deprecated, use 'web gwt setup' instead
gwt setup
This command does not accept any options.
Locates all entities in the project and creates GWT requests, proxies and creates the scaffold
web gwt all --proxyPackage --requestPackage
The package in which created proxies will be placed; no default value (mandatory)
The package in which created requests will be placed; no default value (mandatory)
Updates the GWT project to support GAE
web gwt gae update
This command does not accept any options.
Locates all entities in the project and creates GWT proxies
web gwt proxy all --package
The package in which created proxies will be placed; no default value (mandatory)
Locates all entities in the project and creates GWT requests and proxies
web gwt proxy request all --package
The package in which created proxies and requests will be placed; no default value (mandatory)
Creates a proxy and request based on the specified type
web gwt proxy request type --package --type
The package in which created proxies and requests will be placed; no default value (mandatory)
The type to base the created proxy and request on; no default value (mandatory)
Creates a GWT proxy based on the specified type
web gwt proxy type --package --type
The package in which created proxies will be placed; no default value (mandatory)
The type to base the created request on; no default value (mandatory)
Locates all entities in the project and creates GWT requests
web gwt request all --package
The package in which created requests will be placed; no default value (mandatory)
Creates a GWT proxy based on the specified type
web gwt request type --package --type
The package in which created requests will be placed; no default value (mandatory)
The type to base the created request on; no default value (mandatory)
Creates a GWT request, proxy and scaffold for the specified
web gwt scaffold --proxyPackage --requestPackage --type
The package in which created proxies will be placed; no default value (mandatory)
The package in which created requests will be placed; no default value (mandatory)
The type to base the created scaffold on; no default value (mandatory)
Hint Commands are contained in org.springframework.roo.classpath.operations.HintCommands.
Integration Test Commands are contained in org.springframework.roo.addon.test.IntegrationTestCommands.
Creates a new integration test for the specified entity
test integration
The name of the entity to create an integration test for; default if option not present: '*'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Indicates whether the created test cases should be run withing a Spring transaction; default: 'true'
Creates a mock test for the specified entity
test mock
The name of the entity this mock test is targeting; default if option not present: '*'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Creates a test stub for the specified class
test stub
The name of the class this mock test is targeting; default if option not present: '*'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
J Line Shell Component are contained in org.springframework.roo.shell.jline.osgi.JLineShellComponent.
Parses the specified resource file and executes its commands
script --file
The file to locate and execute; no default value (mandatory)
Display line numbers when executing the script; default if option present: 'true'; default if option not present: 'false'
Shows the shell's properties
system properties
This command does not accept any options.
Jms Commands are contained in org.springframework.roo.addon.jms.JmsCommands.
Insert a JmsOperations field into an existing type
field jms template
The name of the field to add; default: 'jmsOperations'
The name of the class to receive this field; default if option not present: '*'
Indicates if the injected method should be executed asynchronously; default if option present: 'true'; default if option not present: 'false'
Create an asynchronous JMS consumer
jms listener class --class
The name of the class to create; no default value (mandatory)
The name of the destination; default: 'myDestination'
The type of the destination; default: 'QUEUE'
Jpa Commands are contained in org.springframework.roo.addon.jpa.JpaCommands.
Shows database configuration details
database properties list
This command does not accept any options.
Removes a particular database property
database properties remove --key
The property key that should be removed; no default value (mandatory)
Changes a particular database property
database properties set --key --value
The property key that should be changed; no default value (mandatory)
The new vale for this property key; no default value (mandatory)
Creates a new Java class source file with the JPA @Embeddable annotation in SRC_MAIN_JAVA
embeddable --class
The name of the class to create; no default value (mandatory)
Whether the generated class should implement java.io.Serializable; default if option present: 'true'; default if option not present: 'false'
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
Creates a new JPA persistent entity in SRC_MAIN_JAVA
entity jpa --class
Name of the entity to create; no default value (mandatory)
The superclass (defaults to java.lang.Object); default if option not present: 'java.lang.Object'
The interface to implement; no default value
Whether the generated class should be marked as abstract; default if option present: 'true'; default if option not present: 'false'
Create automatic integration tests for this entity; default if option present: 'true'; default if option not present: 'false'
The JPA table name to use for this entity; no default value
The JPA table schema name to use for this entity; no default value
The JPA table catalog name to use for this entity; no default value
The JPA identifier field name to use for this entity; no default value
The JPA identifier field column to use for this entity; no default value
The data type that will be used for the JPA identifier field (defaults to java.lang.Long); default: 'java.lang.Long'
The JPA version field name to use for this entity; no default value
The JPA version field column to use for this entity; no default value
The data type that will be used for the JPA version field (defaults to java.lang.Integer); default if option not present: 'java.lang.Integer'
The JPA @Inheritance value (apply to base class); no default value
Apply @MappedSuperclass for this entity; default if option present: 'true'; default if option not present: 'false'
Whether the generated class should implement equals and hashCode methods; default if option present: 'true'; default if option not present: 'false'
Whether the generated class should implement java.io.Serializable; default if option present: 'true'; default if option not present: 'false'
The persistence unit name to be used in the persistence.xml file; no default value
The transaction manager name; no default value
Indicates whether reserved words are ignored by Roo; default if option present: 'true'; default if option not present: 'false'
The name used to refer to the entity in queries; no default value
The name of the sequence for incrementing sequence-driven primary keys; no default value
Generate CRUD active record methods for this entity; default: 'true'
Install or updates a JPA persistence provider in your project
jpa setup --provider --database
The persistence provider to support; no default value (mandatory)
The database to support; no default value (mandatory)
The Google App Engine application identifier to use; default if option not present: 'the project's name'
The JNDI datasource to use; no default value
The host name to use; no default value
The database name to use; no default value
The username to use; no default value
The password to use; no default value
The transaction manager name; no default value
The persistence unit name to be used in the persistence.xml file; no default value
Install or updates a JPA persistence provider in your project - deprecated, use 'jpa setup' instead
persistence setup --provider --database
The persistence provider to support; no default value (mandatory)
The database to support; no default value (mandatory)
The Google App Engine application identifier to use; default if option not present: 'the project's name'
The JNDI datasource to use; no default value
The host name to use; no default value
The database name to use; no default value
The username to use; no default value
The password to use; no default value
The transaction manager name; no default value
The persistence unit name to be used in the persistence.xml file; no default value
Jsf Commands are contained in org.springframework.roo.addon.jsf.JsfCommands.
Create JSF managed beans for all entities
web jsf all --package
The package in which new JSF managed beans will be placed; no default value (mandatory)
Add a cross-browser generic player to embed multimedia content
web jsf media --url
The url of the media source; no default value (mandatory)
The name of the media player; no default value
Create JSF managed bean for an entity
web jsf scaffold --class
The path and name of the JSF managed bean to be created; no default value (mandatory)
The entity which this JSF managed bean class will create and modify as required; default if option not present: '*'
The name of the managed bean to use in the 'name' attribute of the @ManagedBean annotation; no default value
Include this entity on the generated JSF menu; default: 'true'
Json Commands are contained in org.springframework.roo.addon.json.JsonCommands.
Adds @RooJson annotation to target type
json add
The java type to apply this annotation to; default if option not present: '*'
The root name which should be used to wrap the JSON document; no default value
Indication if deep serialization should be enabled.; default if option present: 'true'; default if option not present: 'false'
Indication if dates should be formatted according to ISO 8601; default if option present: 'true'; default if option not present: 'false'
Adds @RooJson annotation to all types annotated with @RooJavaBean
json all
Indication if deep serialization should be enabled; default if option present: 'true'; default if option not present: 'false'
Indication if dates should be formatted according to ISO 8601; default if option present: 'true'; default if option not present: 'false'
Jsp Commands are contained in org.springframework.roo.addon.web.mvc.jsp.JspCommands.
Create a new manual Controller (ie where you write the methods) - deprecated, use 'web mvc controller' instead
controller class --class
The path and name of the controller object to be created; no default value (mandatory)
Indicates a specific request mapping path for this controller (eg /foo/); no default value
Create a new manual Controller (ie where you write the methods)
web mvc controller --class
The path and name of the controller object to be created; no default value (mandatory)
Indicates a specific request mapping path for this controller (eg /foo/); no default value
Install new internationalization bundle for MVC scaffolded UI.
web mvc install language --code
The language code for the desired bundle; no default value (mandatory)
Create a new static view.
web mvc install view --path --viewName --title
The path the static view to create in (required, ie '/foo/blah'); no default value (mandatory)
The view name the mapping this view should adopt (required, ie 'index'); no default value (mandatory)
The title of the view; no default value (mandatory)
Install new internationalization bundle for MVC scaffolded UI.
web mvc language --code
The language code for the desired bundle; no default value (mandatory)
Setup a basic project structure for a Spring MVC / JSP application
web mvc setup
This command does not accept any options.
Replace an existing application tagx library with the latest version (use --backup option to backup your application first)
web mvc update tags
Backup your application before replacing your existing tag library; default if option present: 'true'; default if option not present: 'false'
Create a new static view.
web mvc view --path --viewName --title
The path the static view to create in (required, ie '/foo/blah'); no default value (mandatory)
The view name the mapping this view should adopt (required, ie 'index'); no default value (mandatory)
The title of the view; no default value (mandatory)
Logging Commands are contained in org.springframework.roo.addon.logging.LoggingCommands.
Mail Commands are contained in org.springframework.roo.addon.email.MailCommands.
Install a Spring JavaMailSender in your project
email sender setup --hostServer
The host server; no default value (mandatory)
The protocol used by mail server; no default value
The port used by mail server; no default value
The encoding used for mail; no default value
The mail account username; no default value
The mail account password; no default value
Configures a template for a SimpleMailMessage
email template setup
The 'from' email (optional); no default value
The message subject (obtional); no default value
Inserts a MailTemplate field into an existing type
field email template
The name of the field to add; default: 'mailTemplate'
The name of the class to receive this field; default if option not present: '*'
Indicates if the injected method should be executed asynchronously; default if option present: 'true'; default if option not present: 'false'
Maven Commands are contained in org.springframework.roo.project.MavenCommands.
Adds a new dependency to the Maven project object model (POM)
dependency add --groupId --artifactId --version
The group ID of the dependency; no default value (mandatory)
The artifact ID of the dependency; no default value (mandatory)
The version of the dependency; no default value (mandatory)
The classifier of the dependency; no default value
The scope of the dependency; no default value
Removes an existing dependency from the Maven project object model (POM)
dependency remove --groupId --artifactId --version
The group ID of the dependency; no default value (mandatory)
The artifact ID of the dependency; no default value (mandatory)
The version of the dependency; no default value (mandatory)
The classifier of the dependency; no default value
Adds a new repository to the Maven project object model (POM)
maven repository add --id --url
The ID of the repository; no default value (mandatory)
The name of the repository; no default value
The URL of the repository; no default value (mandatory)
Removes an existing repository from the Maven project object model (POM)
maven repository remove --id --url
The ID of the repository; no default value (mandatory)
The URL of the repository; no default value (mandatory)
Creates a new Maven module
module create --moduleName --topLevelPackage
The name of the module; no default value (mandatory)
The uppermost package name (this becomes the <groupId> in Maven and also the '~' value when using Roo's shell); no default value (mandatory)
Forces a particular major version of Java to be used (will be auto-detected if unspecified; specify 6 or 7 only); no default value
The Maven coordinates of the parent POM, in the form "groupId:artifactId:version"; no default value
The Maven packaging of this module; default if option not present: 'jar'
The artifact ID of this module (defaults to moduleName if not specified); no default value
Changes focus to a different project module
module focus --moduleName
The module to focus on; no default value (mandatory)
Executes the assembly goal via Maven
perform assembly
This command does not accept any options.
Executes a full clean (including Eclipse files) via Maven
perform clean
This command does not accept any options.
Executes a user-specified Maven command
perform command --mavenCommand
User-specified Maven command (eg test:test); no default value (mandatory)
Sets up Eclipse configuration via Maven (only necessary if you have not installed the m2eclipse plugin in Eclipse)
perform eclipse
This command does not accept any options.
Packages the application using Maven, but does not execute any tests
perform package
This command does not accept any options.
Executes the tests via Maven
perform tests
This command does not accept any options.
Creates a new Maven project
project --topLevelPackage
The uppermost package name (this becomes the <groupId> in Maven and also the '~' value when using Roo's shell); no default value (mandatory)
The name of the project (last segment of package name used as default); no default value
Forces a particular major version of Java to be used (will be auto-detected if unspecified; specify 5 or 6 or 7 only); no default value
The Maven coordinates of the parent POM, in the form "groupId:artifactId:version"; no default value
The Maven packaging of this project; default if option not present: 'jar'
Metadata Commands are contained in org.springframework.roo.classpath.MetadataCommands.
Shows detailed metadata for the indicated type
metadata cache --maximumCapacity
The maximum number of metadata items to cache; no default value (mandatory)
Shows detailed information about the metadata item
metadata for id --metadataId
The metadata ID (should start with MID:); no default value (mandatory)
Shows the ProjectMetadata for the indicated project module
metadata for module
The module for which to retrieve the metadata (defaults to the focused module); no default value
Shows detailed metadata for the indicated type
metadata for type --type
The Java type for which to display metadata; no default value (mandatory)
Shows metadata statistics
metadata status
This command does not accept any options.
Mongo Commands are contained in org.springframework.roo.addon.layers.repository.mongo.MongoCommands.
Creates a domain entity which can be backed by a MongoDB repository
entity mongo --class
Implementation class for the specified interface; no default value (mandatory)
The ID type to be used for this domain type (defaults to BigInteger); no default value
Create automatic integration tests for this entity; default if option present: 'true'; default if option not present: 'false'
Configures the project for MongoDB peristence.
mongo setup
Username for accessing the database (defaults to ''); no default value
Password for accessing the database (defaults to ''); no default value
Name of the database (defaults to project name); no default value
Port for the database (defaults to '27017'); no default value
Host for the database (defaults to '127.0.0.1'); no default value
Deploy to CloudFoundry (defaults to 'false'); default if option present: 'true'; default if option not present: 'false'
Os Commands are contained in org.springframework.roo.addon.oscommands.OsCommands.
Pgp Commands are contained in org.springframework.roo.felix.pgp.PgpCommands.
Indicates to automatically trust all keys encountered until the command is invoked again
pgp automatic trust
This command does not accept any options.
Downloads a remote key and displays it to the user (does not change any trusts)
pgp key view --keyId
The key ID to view (eg 00B5050F or 0x00B5050F); no default value (mandatory)
Lists the keys you currently trust and have not been revoked at the time last downloaded from a public key server
pgp list trusted keys
This command does not accept any options.
Refreshes all keys from public key servers
pgp refresh all
This command does not accept any options.
Displays the status of the PGP environment
pgp status
This command does not accept any options.
Grants trust to a particular key ID
pgp trust --keyId
The key ID to trust (eg 00B5050F or 0x00B5050F); no default value (mandatory)
Process Manager Commands are contained in org.springframework.roo.process.manager.ProcessManagerCommands.
Switches the system into development mode (greater diagnostic information)
development mode
Activates development mode; default: 'true'
Perform a manual file system poll
poll now
This command does not accept any options.
Changes the file system polling speed
poll speed --ms
The number of milliseconds between each poll; no default value (mandatory)
Process Manager Diagnostics Listener are contained in org.springframework.roo.process.manager.internal.ProcessManagerDiagnosticsListener.
Prop File Commands are contained in org.springframework.roo.addon.propfiles.PropFileCommands.
Shows the details of a particular properties file
properties list --name --path
Property file name (including .properties suffix); no default value (mandatory)
Source path to property file; no default value (mandatory)
Removes a particular properties file property
properties remove --name --path --key
Property file name (including .properties suffix); no default value (mandatory)
Source path to property file; no default value (mandatory)
The property key that should be removed; no default value (mandatory)
Changes a particular properties file property
properties set --name --path --key --value
Property file name (including .properties suffix); no default value (mandatory)
Source path to property file; no default value (mandatory)
The property key that should be changed; no default value (mandatory)
The new vale for this property key; no default value (mandatory)
Proxy Configuration Commands are contained in org.springframework.roo.url.stream.jdk.ProxyConfigurationCommands.
Repository Jpa Commands are contained in org.springframework.roo.addon.layers.repository.jpa.RepositoryJpaCommands.
Security Commands are contained in org.springframework.roo.addon.security.SecurityCommands.
Create a permission evaluator
permissionEvaluator --package
The package to add the permission evaluator to; no default value (mandatory)
Selenium Commands are contained in org.springframework.roo.addon.web.selenium.SeleniumCommands.
Creates a new Selenium test for a particular controller
selenium test --controller
Controller to create a Selenium test for; no default value (mandatory)
Name of the test; no default value
URL of the server where the web application is available, including protocol, port and hostname; default: 'http://localhost:8080/'
Service Commands are contained in org.springframework.roo.addon.layers.service.ServiceCommands.
Adds @RooService annotation to all entities
service all --interfacePackage
The java interface package; no default value (mandatory)
The java package of the implementation classes for the interfaces; no default value
When true, Spring Roo will configure services using XML. This is the default behavior for services using GAE; no default value
Adds @RooService annotation to all entities with options for authentication, authorization, and a permission evaluator
service secure all --interfacePackage
The java interface package; no default value (mandatory)
The java package of the implementation classes for the interfaces; no default value
Whether or not users must be authenticated to use the service; default if option present: 'true'; default if option not present: 'false'
The role authorized the use the methods in the service (additional roles can be added after creation); no default value
Whether or not to use a PermissionEvaluator; default if option present: 'true'; default if option not present: 'false'
When true, Spring Roo will configure services using XML.; no default value
Adds @RooService annotation to target type with options for authentication, authorization, and a permission evaluator
service secure type --interface
The java interface to apply this annotation to; no default value (mandatory)
Implementation class for the specified interface; no default value
The domain entity this service should expose; default if option not present: '*'
Whether or not users must be authenticated to use the service; default if option present: 'ture'; default if option not present: 'false'
The role authorized the use the methods in the service; no default value
Whether or not to use a PermissionEvaluator; default if option present: 'true'; default if option not present: 'false'
When true, Spring Roo will configure services using XML.; no default value
Adds @RooService annotation to target type
service type --interface
The java interface to apply this annotation to; no default value (mandatory)
Implementation class for the specified interface; no default value
The domain entity this service should expose; default if option not present: '*'
When true, Spring Roo will configure services using XML.; no default value
Simple Parser Component are contained in org.springframework.roo.shell.osgi.SimpleParserComponent.
Solr Commands are contained in org.springframework.roo.addon.solr.SolrCommands.
Make target type searchable
solr add
The type to be made searchable; default if option not present: '*'
Make all eligible project types searchable
solr all
This command does not accept any options.
Tailor Commands are contained in org.springframework.roo.addon.tailor.TailorCommands.
Activate a tailor configuration.
tailor activate --name
The name of the tailor configuration; no default value (mandatory)
Deactivate the tailor.
tailor deactivate
This command does not accept any options.
Uaa Commands are contained in org.springframework.roo.uaa.UaaCommands.
Accepts the Spring User Agent Analysis (UAA) Terms of Use
download accept terms of use
This command does not accept any options.
Changes the Spring User Agent Analysis (UAA) privacy level
download privacy level --privacyLevel
The new UAA privacy level to use; no default value (mandatory)
Rejects the Spring User Agent Analysis (UAA) Terms of Use
download reject terms of use
This command does not accept any options.
Provides a summary of the Spring User Agent Analysis (UAA) status and commands
download status
This command does not accept any options.
Web Finder Commands are contained in org.springframework.roo.addon.web.mvc.controller.finder.WebFinderCommands.
Adds @RooWebFinder annotation to MVC controller type
web mvc finder add --formBackingType
The finder-enabled type; no default value (mandatory)
The controller java type to apply this annotation to; default if option not present: '*'
Web Flow Commands are contained in org.springframework.roo.addon.web.flow.WebFlowCommands.
Web Json Commands are contained in org.springframework.roo.addon.web.mvc.controller.json.WebJsonCommands.
Adds @RooJson annotation to target type
web mvc json add --jsonObject
The JSON-enabled object which backs this Spring MVC controller.; no default value (mandatory)
The java type to apply this annotation to; default if option not present: '*'
Adds or creates MVC controllers annotated with @RooWebJson annotation
web mvc json all
The package in which new controllers will be placed; no default value