Xuse User Guide: Commands
This section describes the commands that are available in Xuse - these commands are applicable for all version of Xuse - i.e. Java standalone version, Maven 1 and Maven 2 plugins.
Command reference
The following table shows how to form the different base commands for Xuse stand-alone as well as xuse with Maven 1 or 2. If you do not already have Maven installed it is recommended that you run use Xuse standalone.
| Type | Base command | Example |
|---|---|---|
| Standalone | java net.sourceforge.xuse.Xuse $1 |
java net.sourceforge.xuse.Xuse xuse:html |
| Maven 1.x | Maven $1 |
Maven xuse:html |
| Maven 2.x | mvn net.sourceforge.xuse:maven-xuse-m2-plugin:$1 |
mvn net.sourceforge.xuse:maven-xuse-m2-plugin:xuse:html |
The following table summarises the commands available and their applicability to different flavours of Xuse.
| Command | Since | Description | Stand-alone | Maven 1.x | Maven 2.x |
|---|---|---|---|---|---|
xuse |
00.01.00 | Builds all the project documentation. |  |
|
|
xuse:new-project |
00.02.00 | Creates a new project from a template in the directory where the command is run. Don't run this command in an existing project as it may overwrite files. | |
|
|
xuse:upgrade |
00.02.00 | Runs a tool that updates project files from a previous version to the current version of the model. Should only be run if project files have been backed up. Note: Tooling is not yet built for model version 0.2 to 0.3 upgrade. | |
|
|
xuse:html |
00.03.00 | Builds the HTML documentation. | |
 |
|
xuse:documents-html |
00.03.00 | Builds the HTML documentation for vision documents and SRSes. | |
|
|
xuse:validate |
00.03.00 | Runs the validation routine. | |
|
|
xuse:pdf-use-case $2 |
00.03.00 | Creates a PDF version of the use-case (note replace $2 with the use-case reference e.g. UC1. |
|
|
|
xuse:pdf-use-cases |
00.03.00 | Creates a PDF version of the all the use-cases. | |
|
|
xuse:import-trace-report |
00.03.00 | Import a trace-report allowing traceability of requirements to other artefacts - e.g. Java classes. | |
|
|
xuse:import-requirements |
00.03.00 | Import a requirements from other data sources - currently supports CSV import. | |
|
|
xuse:export-requirements |
00.03.00 | Export requirements into a CSV file format. |  |
|