Skip to content

Commit 627dfdd

Browse files
authored
Merge pull request #179 from Pkylas007/mta-5964-cli-guide-maven-flag
MTA-5964 - Added --disable-maven-search flag in CLI guide
2 parents cb653a3 + 2ef8157 commit 627dfdd

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,12 @@ The following are the options that you can use together with the `mta-cli analyz
1313
|====
1414
|Option|Description
1515
|`--analyze-known-libraries` (bool)|Analyze open-source libraries.
16-
|`--context-lines` (int)|A number of lines of source code to include in the output for each incident. The default is 100.
16+
|`--disable-maven-search`| Set the flag to `true` to disable {ProductShortName} from relying on the Maven search index to determine if a dependency is publicly available (such as an open-source dependency) or internal to the Java binary application during analysis.
17+
18+
When you disable Maven search, {ProductShortName} at first tries to determine dependencies from the the JAR file's POM file (if any). If this method does not succeed, {ProductShortName} goes through the directory structure to determine dependencies. This method may not produce a reliable dependency classification since the package structure can differ from what is expected by {ProductShortName}. You may see more number of incidents because some dependencies may be wrongly classified as internal.
19+
20+
By default, `--disable-maven-search` is set to `false`. Therefore, {ProductShortName} uses the SHA digest of the JAR file to search the Maven search index. This setting generates more accurate dependencies but the drawback is that the Maven search index is frequently unavailable.
21+
|`--context-lines` (int)|The number of lines of source code to include in the output for each incident. The default is 100.
1722
|`--dependency-folders` (stringArray)|A directory for dependencies.
1823
|`--enable-default-rulesets` (bool)|Run default rulesets with analysis. The default is `true`.
1924
|`--help`|Display the available flags for the `analyze` command.

0 commit comments

Comments
 (0)