You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|--analyze-known-libraries | Flag to analyze known software artifacts embedded within your application. By default, {ProductShortName} only analyzes application code.
25
+
|Command |Type|Description
26
26
27
-
[NOTE]
28
-
====
29
-
This option might result in a longer execution time and a large number of migration issues being reported.
30
-
====
27
+
a|`--analyze-known-libraries`
28
+
|
29
+
|Flag to analyze known open-source libraries.
31
30
32
-
|--help |Display the {ProductShortName} help message.
33
-
|--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.
34
-
| --list-sources
35
-
| list rules for available migration sources
36
-
|--list-sources | Flag to list all available source technologies.
37
-
|--list-targets| Flag to list all available target technologies.
38
-
|--output |Specify the path to the directory to output the report information generated by {ProductShortName}.
31
+
a|`--bulk`
32
+
|
33
+
a|Flag for running multiple analyze commands in bulk, which result in a combined static report.
39
34
40
-
[IMPORTANT]
41
-
====
42
-
Do not overwrite a report output directory that contains important information.
43
-
====
44
-
| --rules stringArray | Filename or directory containing rule files
45
-
| --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.
46
-
|--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 `--list-targets` argument to list all available targets.
47
-
|====
35
+
|`--context-lines`
36
+
|Integer
37
+
|Flag to define the number of lines of source code to include in the output for each incident (default: `100`).
48
38
49
-
[id="cli-input-argument_{context}"]
50
-
== Specifying the input
39
+
a|`-d`, `--dependency-folders`
40
+
|String Array
41
+
|Flag for the directory for dependencies.
51
42
52
-
A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required.
43
+
a|`--enable-default-rulesets`
44
+
|Boolean
45
+
a|Flag to run default rulesets with analysis (default: `true`).
53
46
54
-
.Usage
55
-
[source,options="nowrap",subs="attributes+"]
56
-
----
57
-
--input <INPUT_ARCHIVE_OR_DIRECTORY> [...]
58
-
----
47
+
a|`-h`, `--help`
48
+
|
49
+
|Flag to output help for analyze
59
50
60
-
[id="cli-input-file-type-arguments_{context}"]
61
-
== Analyze application source code
51
+
a|`--http-proxy`
52
+
| String
53
+
| Flag for Hyper Text Transfer Protocol (HTTP) proxy string URL
62
54
63
-
Usage: `{mta-cli} analyze [flags]`
55
+
a|`--https-proxy`
56
+
| String
57
+
| Flag for Hypertext Transfer Protocol Secure (HTTPS) proxy string URL
64
58
65
-
The following flags are available:
59
+
a|`--incident-selector`
60
+
|String
61
+
a|Flag to select incidents based on custom variables, for example, `!package=io.konveyor.demo.config-utils`
66
62
67
-
.{ProductShortName} Analyze application
68
-
[cols="40%,60%a",options="header",]
69
-
|====
70
-
|Flag |Description
63
+
a|`-i`, `--input`
64
+
|String
65
+
a|Flag for the path to application source code or a binary. For more details, see xref:cli-input-argument_cli-guide[Specifying the input].
71
66
72
-
| --analyze-known-libraries
73
-
| analyze known open source libraries
67
+
a|`--jaeger-endpoint`
68
+
|String
69
+
|Flag for the jaeger endpoint to collect traces.
74
70
75
-
| -h, --help
76
-
| help for analyze
71
+
a|`--json-output`
72
+
|
73
+
a|Flag to create analysis and dependency output as JSON.
77
74
78
-
| -i, --input string
79
-
| path to application source code or a binary
75
+
a|`-l`, `--label-selector`
76
+
|String
77
+
|Flag to run rules based on a specified label selector expression.
80
78
81
-
| --json-output
82
-
| create analysis and dependency output as JSON
79
+
a|`--list-providers`
80
+
|
81
+
|Flag to list available supported providers.
83
82
84
-
| --list-sources
85
-
| list rules for available migration sources
83
+
a|`--list-sources`
84
+
|
85
+
a|Flag to list rules for available migration sources.
86
86
87
-
| --list-targets
88
-
| list rules for available migration targets
87
+
a|`--list-targets`
88
+
|
89
+
|Flag to list rules for available migration targets.
89
90
90
-
| -l, --label-selector string
91
-
| run rules based on specified label selector expression
91
+
a|`--maven-settings`
92
+
|string
93
+
|Flag path to a custom Maven settings file to use
92
94
93
-
| --maven-settings string
94
-
| path to a custom maven settings file to use
95
+
a|`-m`, `--mode`
96
+
|String
97
+
a|Flag for analysis mode, this must be one of `full`, for `source` and `dependencies`, or `source-only` (default `full`).
95
98
96
-
| --overwrite
97
-
| overwrite output directory
99
+
a|`--no-proxy`
100
+
|String
101
+
|Flag to excluded URLs from passing through any proxy (relevant only with proxy)
98
102
99
-
| --skip-static-report
100
-
| do not generate static report
103
+
a|`-o`, `--output`
104
+
|String
105
+
|Flag for the path to the directory for analysis output. For more details, see xref:cli-output-argument_cli-guide[Specifying the output directory].
101
106
102
-
| -m, --mode string
103
-
| analysis mode" `full` (default) or `source-only`
107
+
a|`--override-provider-settings`
108
+
|String
109
+
|Flag to override the provider settings. The analysis pod runs on the host network, and no providers are started.
104
110
105
-
| -o, --output string | path to the directory for analysis output
111
+
a|`--overwrite`
112
+
|
113
+
|Flag to overwrite the output directory. If you do not specify this argument and the `--output` directory exists, you are prompted to choose whether to overwrite the contents.
106
114
107
-
| --rules stringArray | filename or directory containing rule files
115
+
a|`--provider`
116
+
|String Array
117
+
|Flag to specify which provider or providers to run.
108
118
109
-
| --skip-static-report
110
-
| do not generate static report
119
+
a|`--rules`
120
+
|String Array
121
+
a|Flag to specify the filename or directory containing rule files. Use multiple times for additional rules, for example, `--rules --rules …`.
111
122
112
-
| -s, --source string
113
-
| source technology to consider for analysis. To specify multiple sources, repeat the parameter: --source <source_1> --source <source_2> etc.
123
+
a|`--run-local`
124
+
|
125
+
|Local flag to run analysis directly on local system without containers (for Java and Maven)
114
126
115
-
| -t, --target string
116
-
| target technology to consider for analysis. To specify multiple targets, repeat the parameter: --target <target_1> --target <target_2> etc.
a|Flag for the source technology to consider for analysis. Use multiple times for additional sources, for example, `--source --source …`. For more details, see xref:cli-source-argument_cli-guide[Setting the source technology].
121
134
122
-
.{ProductShortName} Analyze application
123
-
[cols="40%,60%a",options="header",]
135
+
a|`-t`, `--target`
136
+
|String Array
137
+
a|Flag for the target technology to consider for analysis. Use multiple times for additional targets, for example, `--target --target …`. For more details, see xref:cli-target-argument_cli-guide[Setting the target technology].
124
138
|====
139
+
====
125
140
126
-
|Flag
127
-
|Description
141
+
[id="cli-input-argument_{context}"]
142
+
== Specifying the input
128
143
129
-
| --log-level uint32
130
-
| log level (default 4)
144
+
A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required.
131
145
132
-
| --no-cleanup
133
-
| do not clean up temporary resources
134
-
|====
146
+
.Usage
147
+
[source,options="nowrap",subs="attributes+"]
148
+
----
149
+
--input <INPUT_ARCHIVE_OR_DIRECTORY> [...]
150
+
----
151
+
152
+
Depending on whether the input file type provided to the `--input` argument is a file or directory, it will be evaluated as follows depending on the additional arguments provided.
153
+
154
+
Directory::
155
+
+
156
+
* `--sourceMode`: The directory is evaluated as a single application.
135
157
158
+
File::
159
+
+
160
+
* `--sourceMode`: The file is evaluated as a compressed project.
136
161
137
162
138
163
[id="cli-output-argument_{context}"]
@@ -146,39 +171,40 @@ Specify the path to the directory to output the report information generated by
146
171
--output <OUTPUT_REPORT_DIRECTORY>
147
172
----
148
173
149
-
* The `--output` argument is mandatory. If omitted, an error is returned:
174
+
* If omitted, the report will be generated in an `<INPUT_ARCHIVE_OR_DIRECTORY>.report` directory.
175
+
* If the output directory exists, you will be prompted with the following question with a default answer of `N`:
150
176
+
151
177
[source,options="nowrap",subs="attributes+"]
152
178
----
153
-
Error: required flag(s) "output" not set
179
+
Overwrite all contents of "/home/username/<OUTPUT_REPORT_DIRECTORY>" (anything already in the directory will be deleted)? [y,N]
154
180
----
155
181
156
-
However, if you specify the `--overwrite` argument, {ProductShortName} will proceed to delete and re-create the directory. See the description of this argument for more information.
182
+
However, if you specify the `--overwrite` argument, {ProductShortName} will proceed to delete and recreate the directory. See the description of this argument for more information.
157
183
158
184
[id="cli-source-argument_{context}"]
159
185
== Setting the source technology
160
186
161
-
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 `--list-sources` argument to list all available sources.
187
+
A space-delimited list of one or more source technologies, servers, platforms, or frameworks to migrate from. You can use this argument, in conjunction with the `--target` argument, to determine which rulesets are used. Use the `--listSourceTechnologies` argument to list all available sources.
162
188
163
189
.Usage
164
190
[source,options="nowrap",subs="attributes+"]
165
191
----
166
192
--source <SOURCE_1> <SOURCE_2>
167
193
----
168
194
169
-
The `--source` argument now provides version support, which follows the link:http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html[Maven version range syntax]. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, `--source eap5`.
195
+
The `--source` argument now provides version support, which follows the link:http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html[Maven version range syntax]. This instructs {ProductShortName} to only run the rulesets matching the specified versions, for example, `--source eap:5`.
170
196
171
197
[WARNING]
172
198
====
173
-
When migrating to JBoss EAP, be sure to specify the version, for example, `eap6`. Specifying only `eap` will run rulesets for all versions of JBoss EAP, including those not relevant to your migration path.
199
+
When migrating to JBoss EAP, be sure to specify the version, for example, `eap:6`. Specifying only `eap` will run rulesets for all versions of JBoss EAP, including those not relevant to your migration path.
174
200
175
201
See link:{ProductDocIntroToMTAGuideURL}/index#migration_paths_getting-started-guide[Supported migration paths] in _{IntroToMTABookName}_ for the appropriate JBoss EAP version.
176
202
====
177
203
178
204
[id="cli-target-argument_{context}"]
179
205
== Setting the target technology
180
206
181
-
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. If you do not provide a target, mta-cli analyzes the input based on the source and discovery rules. Use the `--list-targets` argument to list all available targets.
207
+
A space-delimited list of one or more target technologies, servers, platforms, or frameworks to migrate to. You can use this argument, in conjunction with the `--source` argument, to determine which rulesets are used. If you do not specify this option, you are prompted to select a target. Use the `--listTargetTechnologies` argument to list all available targets.
182
208
183
209
.Usage
184
210
[source,options="nowrap",subs="attributes+"]
@@ -187,27 +213,4 @@ A space-delimited list of one or more target technologies, servers, platforms, o
187
213
----
188
214
189
215
190
-
The `--target` argument now provides version support, which follows the link:http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html[Maven version range syntax]. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, `--target eap7`.
191
-
192
-
[WARNING]
193
-
====
194
-
When migrating to JBoss EAP, be sure to specify the version in the target, for example, `eap6`. Specifying only `eap` will run rulesets for all versions of JBoss EAP, including those not relevant to your migration path.
195
-
196
-
See link:{ProductDocIntroToMTAGuideURL}/index#migration_paths_getting-started-guide[Supported migration paths] in _{IntroToMTABookName}_ for the appropriate JBoss EAP version.
197
-
====
198
-
199
-
////
200
-
[id="cli-packages-argument_{context}"]
201
-
== Selecting packages
202
-
203
-
A space-delimited list of the packages to be evaluated by {ProductShortName}. It is highly recommended to use this argument.
204
-
205
-
.Usage
206
-
[source,options="nowrap",subs="attributes+"]
207
-
----
208
-
----
209
-
210
-
* In most cases, you are interested only in evaluating custom application class packages and not standard Java EE or third party packages. The `<PACKAGE_N>` argument is a package prefix; all subpackages will be scanned. For example, to scan the packages `com.mycustomapp` and `com.myotherapp`, use `--packages com.mycustomapp com.myotherapp` argument on the command line.
211
-
* While you can provide package names for standard Java EE third party software such as `org.apache`, it is usually best not to include them as they should not impact the migration effort.
212
-
213
-
////
216
+
The `--target` argument now provides version support, which follows the link:http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html[Maven version range syntax]. This instructs {ProductShortName} to only run the rulesets matching the specified versions, for example, `--target eap:7`.
0 commit comments