Using XRadar command line

You may NOT want to use XRadar as a simple command line. This is a rather an exhausting setting up, and really not as simple as using XRadar in either Maven 2 or Ant. This interface has been mostly developed to allow to run unit test on XRadar itself, not really for human being. However, if you are felling up to it, you can refers to this documentation and the unit test to set up XRadar.

Basic Usage

Do not forget to specify if reports needs to be "static" or "dynamic". Here is a simple example: 

java -cp org.sourceforge.xradar.Statics static --jdepend jdepend_report.xml\ 
--xradarConfig radar-config.xml --properties tools.properties --target target

Obviously, there are several additional options that you may want to use

Statics Report

Availaible report integration

Parameter Description
--jdepend Adds Jdepend report to XRadar analysis.
--pmd Adds PMD report to XRadar analysis.
--checkstyle Adds Checkstyle report to XRadar analysis.
--javancss Adds JavaNCSS report to XRadar analysis.
--ckjm Adds ckjm report to XRadar analysis.
--cpd Adds Cpd report to XRadar analysis.
--findbugs Adds Findbugs report to XRadar analysis.

Compulsory Arguments

Some command line arguements are compulsory in order to generate XRadar Static reports.

Below is a list of these arguements:

Parameter Description
static Will generate Static reports
--jdepend JDepend becomes COMPULSORY if you ommited the --classes command
--classes If you do not have a JDepend report already generated, XRadar can run JDepend for you if you provide it the directory where your project directory is
The --classes command becomes COMPULSORY if you ommited the --jdepend command
--xradarConfig The location of XRadar configuration file
--properties The XRadar's properties
--target The target directory where reports will be generated

Optional Arguements

The command line interface also accepts the following optional arguments:

Parameter Description
--javadocRoot The project's Javadoc location
--debug Prints a stacktrace if an error is encountered
--offline / --online Specifies if the user is connected to the Internet, default setting is 'online'.
--javadocEnabled Integrates Javadoc to XRadar website.
--java2htmlRoot The location of the Java2htmlRoot enabling XRadar to have direct links to the code.

Dynamics Report

Compulsory Arguments

The following command line arguements are compulsory in order to generate XRadar Dynamic reports.

It is recommended to use them in the same order.

Parameter Description
dynamic Will generate Dynamic reports
--config The location of XRadar configuration file
--target The target directory where reports will be generated
--releaseX The release version where X is the version number
--daysSinceLast The time span since the last release
--previousReport The location of the previous Report generated.
If it is the first version of the project Xradar will use an embedded xml file in the jar distribution.
--reportToMerge The location of the report to be merged
--qualityReportPath TODO:
--staticsRoot TODO:
--masterFinal Directory of the two previous reports generated