Appendix A. Command Index

This appendix was automatically built from Roo 1.0.2.RELEASE [rev 638].

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.

A.1. Component Commands

Component Commands are contained in org.springframework.roo.addon.surf.component.ComponentCommands.

A.1.1. surf component create

Adds a new Surf component to your Surf project.

surf component create --page --region --url
--page

Specifies page id of the component to be created.

--region

Specifies region id of the component to be created.

--url

Specifies url of the component to be created.

--options

Specifies additonal options for the component to be created.

A.1.2. surf component list

Lists Surf components in your project.

surf component list
--scope

Specifies scope of the components you want to list. Available options are page, template and component.

--page

Specifies page id for the page scoped components you want to list.

--template

Specifies template id for the template scoped components you want to list.

A.1.3. surf component property create

Creates a new property for Surf component.

surf component property create --id --properties
--id

Specifies component instance id of the new component resource.

--properties

Specifies list of the new component properties. The input format is name1:val1|name22:val2.

A.1.4. surf component resource create

Creates a new resource for the Surf component.

surf component resource create --id --content
--id

Specifies component instance id of the new component resource.

--attributes

Specifies attribute list for the new component resource. The input format is attr1:val1|attr2:val2.

--content

Specifies content body of the new component resource

A.1.5. surf webscript list

Lists all Surf web scripts.

surf webscript list

This command does not accept any options.

A.2. Content Commands

Content Commands are contained in org.springframework.roo.addon.surf.content.ContentCommands.

A.2.1. surf content association create

Creates a new Surf content association

surf content association create --source --destination
--id

Specifies id of the content association.

--source

Specifies content type of the association.

--destination

Specifies page id or component id that will be used for rendering the content type.

--type

Specifies type of the association, i.e. page, etc.

A.3. Page Commands

Page Commands are contained in org.springframework.roo.addon.surf.page.PageCommands.

A.3.1. surf page association create

Adds a new Surf page association between two pages.

surf page association create --sourceId --destId
--sourceId

Specifies id of the source page.

--destId

Specifies id of the destination page.

--name

Speficies optional name for the association.

--type

Speficies page association type. If not speficied, the default is child.

A.3.2. surf page association list

Lists associated pages of the page with a specified id.

surf page association list --sourceId
--sourceId

Specifies id of the source page.

A.3.3. surf page create

Adds a new page to your Surf project.

surf page create --id
--id

Specifies id of the page to be created e.g. test, test1

--path

Specifies path of the page to be created e.g. pages, mypages

--templateInstance

Specifies template instance id to be used.

--template

Specifies template id to be used.

--urls

Specifies list of urls that the new page to be mapped to. Urls should be separated by comma.

--title

Specifies tile of the page to be created.

A.3.4. surf page list

Lists all pages in your Surf project.

surf page list

This command does not accept any options.

A.4. Report Commands

Report Commands are contained in org.springframework.roo.addon.surf.report.ReportCommands.

A.4.1. surf report page

Lists detailed configurations of a Surf page.

surf report page --id
--id

Specifies id of the Surf page.

A.5. Site Commands

Site Commands are contained in org.springframework.roo.addon.surf.site.SiteCommands.

A.5.1. surf site create

Creates a new Surf site configuration.

surf site create --rootPageId
--name

Specifies name of the Surf site.

--rootPageId

Specifies root page id of the Surf site.

A.6. Surf Commands

Surf Commands are contained in org.springframework.roo.addon.surf.SurfCommands.

A.6.1. surf addon install

Installs a Surf addon into your Surf project.

surf addon install --id
--id

Id of the Surf addon package to be installed.

A.6.2. surf addon list

Returns list of available Surf addon packages.

surf addon list

This command does not accept any options.

A.6.3. surf install

Installs Surf artifacts into your project.

surf install
--siteName

Site name for the new Surf project. If not specified, last segment of package name will be used as default.

A.7. Template Commands

Template Commands are contained in org.springframework.roo.addon.surf.template.TemplateCommands.

A.7.1. surf template create

Creates a template (ftl) at the specified path.

surf template create --path
--path

Specifies path of the new template.

A.7.2. surf template instance create

Creates a Template Instance with the given id that maps to the given template path.

surf template instance create --id --template
--id

Specifies id of the new template instance.

--path

Specifies path of the new template instance.

--template

Specifies template for the new template instance.

A.7.3. surf template instance list

Lists all surf template instances.

surf template instance list

This command does not accept any options.

A.7.4. surf template list

Lists all Surf templates.

surf template list

This command does not accept any options.

A.7.5. surf template region list

Shows list of regions belong to this template.

surf template region list --path
--path

Specifies path of the template.