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.

--analyzeKnownLibraries

Flag to analyze known software artifacts embedded within your application. By default, MTR only analyzes application code.

--batchMode

Flag to specify that MTR 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 MTR 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.

--enableTransactionAnalysis

[Technology Preview] Flag to enable generation of a Transactions report that displays the call stack, which executes operations on relational database tables. The Enable Transaction Analysis feature supports Spring Data JPA and the traditional preparedStatement() method for SQL statement execution. It does not support ORM frameworks, such as Hibernate.

--excludePackages

A space-delimited list of packages to exclude from evaluation. For example, entering com.mycompany.commonutilities excludes all classes whose package names begin 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.

--exportCSV

Flag to export the report data to a CSV file on your local file system. MTR 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.

--exportSummary

Flag to instruct MTR to generate an analysisSummary.json export file in the output directory. The file contains analysis summary information for each application analyzed, including the number of incidents and story points by category, and all of the technology tags associated with the analyzed applications.

--exportZipReport

This argument creates a reports.zip file in the output folder. The file contains the analysis output, typically, the reports. If requested, it can also contain the CSV export files.

--help

Display the MTR 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.

--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 MTR to not delete temporary working files, such as the graph database and extracted archive files. This is useful for debugging purposes.

--legacyReports

Flag to instruct MTR to generate the old format reports instead of the new format reports.

--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, MTR 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 MTR.

--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 MTR. It is highly recommended to use this argument.

--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.

--sourceMode

Flag to indicate that the application to be evaluated contains source files rather than compiled binaries. The sourceMode argument has been deprecated. There is no longer the need to specify it. MTR can intuitively process any inputs that are presented to it. In addition, project source folders can be analyzed with binary inputs within the same analysis execution.

--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.

--userIgnorePath

Specify a location, in addition to ${user.home}/.mtr/ignore/, for MTR to identify files that should be ignored.

--userLabelsDirectory

Specify a location for MTR 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 the .windup.label.xml suffix. The shipped Target Runtime Labels are defined within $MTR_HOME/rules/migration-core/core.windup.label.xml.

--userRulesDirectory

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

--version

Display the MTR version.

--skipSourceCodeReports

This option skips generating a Source code report when generating the application analysis report. Use this advanced option when concerned about source code information appearing in the application analysis.