Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] [MTA-3848] Fixes for the CLI guide #68

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[WIP] [MTA-3848] Fixes for the CLI guide #68

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c029953
First fixes
mpershina Oct 22, 2024
d1b7112
Fixes for flags
mpershina Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 61 additions & 55 deletions docs/topics/mta-cli-analyze.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,70 +19,76 @@ All flags:

[source,terminal,subs="attributes+"]
----
Analyze application source code
Analyze application source code

Usage:
{mta-cli} analyze [flags]

Flags:

--analyze-known-libraries Analyze known open-source libraries.
--context-lines (int) Number of lines of source code to
include in the output for each
incident (default: `100`).
-d, --dependency-folders (stringArray) Directory for dependencies.
--enable-default-rulesets Run default rulesets with analysis
(default: `true`).
-h, --help Help for analyze.
--http-proxy (string) HTTP proxy string URL.
--https-proxy (string) HTTPS proxy string URL.
--incident-selector (string) An expression to select incidents
based on custom variables.
Example:
!package=io.demo.config-utils
-i, --input (string) Path to application source code or
a binary.
--jaeger-endpoint (string) Jaeger endpoint to collect traces.
--json-output Create analysis and dependency
output as JSON.
--list-sources List rules for available
migration sources.
--list-targets List rules for available
migration targets.
-l, --label-selector (string) Run rules based on specified label
selector expression.
--maven-settings (string) Path to the custom maven
settings file to use.
--overwrite Overwrite output directory.
--skip-static-report Do not generate the static report.
-m, --mode (string) Analysis mode, must be one of
`full` or `source-only`
(default: `full`).
--no-proxy (string) Proxy-excluded URLs
(relevant only with proxy).
-o, --output (string) Path to the directory for analysis
output.
--overwrite Overwrite output directory.
--rules (stringArray) Filename or directory containing
rule files.
--skip-static-report Do not generate the static report.
-s, --source (string) Source technology to consider
for analysis.
To specify multiple sources,
repeat the parameter:
`--source <source_1>
--source <source_2>` etc.
-t, --target (string) Target technology to consider
for analysis.
To specify multiple targets,
repeat the parameter:
`--target <target_1>
--target <target_2>` etc.
--analyze-known-libraries Analyze known open-source libraries.
--context-lines (int) Number of lines of source code to
include in the output for each
incident (default: `100`).
--bulk Analyze multiple applications in bulk.
The analysis produces a
combined static report.
-d, --dependency-folders (stringArray) Directory for dependencies.
--enable-default-rulesets Run default rulesets with analysis
(default: `true`).
-h, --help Help for analyze.
--incident-selector (string) An expression to select incidents
based on custom variables.
Example:
!package=io.demo.config-utils
-i, --input (string) Path to application source code or
a binary.
--jaeger-endpoint (string) Jaeger endpoint to collect traces.
--json-output Create analysis and dependency
output as JSON.
--list-sources List rules for available
migration sources.
--list-targets List rules for available
migration targets.
-l, --label-selector (string) Run rules based on specified label
selector expression.
--list-providers List language providers
supported for the analysis.
--maven-settings (string) Path to the custom maven
settings file to use.
-m, --mode (string) Analysis mode, must be one of
`full` or `source-only`
(default: `full`).
-o, --output (string) Path to the directory for analysis
output.
--override-provider-settings (string) Override the language provider
settings.
As a result, the analysis pod
runs on a host network, and
no providers are started.
--overwrite Overwrite output directory.
--provider (stringArray) Specify a language provider
or providers to run during the analysis.
--rules (stringArray) Filename or directory containing
rule files.
--skip-static-report Do not generate the static report.
-s, --source (string) Source technology to consider
for analysis.
To specify multiple sources,
repeat the parameter:
`--source <source_1>
--source <source_2>` etc.
-t, --target (string) Target technology to consider
for analysis.
To specify multiple targets,
repeat the parameter:
`--target <target_1>
--target <target_2>` etc.


Global Flags:
--log-level uint32 Log level (default: 4).
--no-cleanup Do not cleanup temporary resources.
--log-level uint32 Log level (default: 4).
--no-cleanup Do not cleanup temporary resources.
----

[NOTE]
Expand Down