Appendix A. Reference Material

--additionalClassPath

A space-delimited list of additional JAR files or directories to add to the class path so that they are available for decompilation or other analysis.

--addonDir

Add the specified directory as a custom add-on repository.

--batchMode

Flag to specify that RHAMT should be run in a non-interactive mode without prompting for confirmation. This mode takes the default values for any parameters not passed in to the command line.

--debug

Flag to run RHAMT in debug mode.

--disableTattletale

Flag to disable generation of the Tattletale report. If both enableTattletale and disableTattletale are set to true, then disableTattletale will be ignored and the Tattletale report will still be generated.

--discoverPackages

Flag to list all available packages in the input binary application.

--enableClassNotFoundAnalysis

Flag to enable analysis of Java files that are not available on the class path. This should not be used if some classes will be unavailable at analysis time.

--enableCompatibleFilesReport

Flag to enable generation of the Compatible Files report. Due to processing all files without found issues, this report may take a long time for large applications.

--enableTattletale

Flag to enable generation of a Tattletale report for each application. This option is enabled by default when eap is in the included target. If both enableTattletale and disableTattletale are set to true, then disableTattletale will be ignored and the Tattletale report will still be generated.

--excludePackages

A space-delimited list of packages to exclude from evaluation. For example, entering com.mycompany.commonutilities would exclude all classes whose package name begins with com.mycompany.commonutilities.

--excludeTags

A space-delimited list of tags to exclude. When specified, rules with these tags will not be processed. To see the full list of tags, use the --listTags argument.

--explodedApp

Flag to indicate that the provided input directory contains source files for a single application. See the Input File Argument Tables for details.

--exportCSV

Flag to export the report data to a CSV file on your local file system. RHAMT creates the file in the directory specified by the --output argument. The CSV file can be imported into a spreadsheet program for data manipulation and analysis. For details, see Export the Report in CSV Format.

--help

Display the RHAMT help message.

--immutableAddonDir

Add the specified directory as a custom read-only add-on repository.

--includeTags

A space-delimited list of tags to use. When specified, only rules with these tags will be processed. To see the full list of tags, use the --listTags argument.

--input

A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required. See Specify the Input for more information.

--install

Specify add-ons to install. The syntax is GROUP_ID:ARTIFACT_ID[:VERSION]. For example, --install core-addon-x or --install org.example.addon:example:1.0.0.

--keepWorkDirs

Flag to instruct RHAMT to not delete temporary working files, such as the graph database and unzipped archives. This is useful for debugging purposes.

--list

Flag to list installed add-ons.

--listSourceTechnologies

Flag to list all available source technologies.

--listTags

Flag to list all available tags.

--listTargetTechnologies

Flag to list all available target technologies.

--mavenize

Flag to create a Maven project directory structure based on the structure and content of the application. This creates pom.xml files using the appropriate Java EE API and the correct dependencies between project modules. See also the --mavenizeGroupId option.

--mavenizeGroupId

When used with the --mavenize option, all generated pom.xml files will use the provided value for their <groupId>. If this argument is omitted, RHAMT will attempt to determine an appropriate <groupId> based on the application, or will default to com.mycompany.mavenized.

--online

Flag to allow network access for features that require it. Currently only validating XML schemas against external resources relies on Internet access. Note that this comes with a performance penalty.

--output

Specify the path to the directory to output the report information generated by RHAMT. See Specify the Output Directory for more information.

--overwrite

Flag to force delete the existing output directory specified by --output. If you do not specify this argument and the --output directory exists, you are prompted to choose whether to overwrite the contents.

--packages

A space-delimited list of the packages to be evaluated by RHAMT. It is highly recommended to use this argument. See Select Packages for more information.

--remove

Remove the specified add-ons. The syntax is GROUP_ID:ARTIFACT_ID[:VERSION]. For example, --remove core-addon-x or --remove org.example.addon:example:1.0.0.

--skipReports

Flag to indicate that HTML reports should not be generated. A common use of this argument is when exporting report data to a CSV file using --exportCSV.

--source

A space-delimited list of one or more source technologies, servers, platforms, or frameworks to migrate from. This argument, in conjunction with the --target argument, helps to determine which rulesets are used. Use the --listSourceTechnologies argument to list all available sources. See Set the Source Technology for more information.

--sourceMode

Flag to indicate that the application to be evaluated contains source files rather than compiled binaries. See the Input File Argument Tables for details.

--target

A space-delimited list of one or more target technologies, servers, platforms, or frameworks to migrate to. This argument, in conjunction with the --source argument, helps to determine which rulesets are used. Use the --listTargetTechnologies argument to list all available targets. See Set the Target Technology for more information.

--userIgnorePath

Specify a location, in addition to ${user.home}/.rhamt/ignore/, for RHAMT to identify files that should be ignored. For additional information on formatting these files, see Configure RHAMT to Exclude Files and Packages.

--userLabelsDirectory

Specify a location for RHAMT to look for custom Target Runtime Labels. The value can be a directory containing label files or a single label file. The Target Runtime Label files must use either the .windup.label.xml or .rhamt.label.xml suffix. The shipped Target Runtime Labels are defined within $RHAMT_HOME/rules/migration-core/core.windup.label.xml.

--userRulesDirectory

Specify a location, in addition to RHAMT_HOME/rules/ and ${user.home}/.rhamt/rules/, for RHAMT to look for custom RHAMT rules. The value can be a directory containing ruleset files or a single ruleset file. The ruleset files must use the .windup.xml or .rhamt.xml suffix.

--version

Display the RHAMT version.