Skip to content

Commit

Permalink
updates to new cli guide chapters
Browse files Browse the repository at this point in the history
  • Loading branch information
emarcusRH committed Jan 22, 2024
1 parent 2de019e commit 1b3cbf6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
6 changes: 3 additions & 3 deletions docs/topics/mta-cli-analyze.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

`Analyze` allows running source code and binary analysis using `analyzer-lsp`.

To run analysis on application source code, run the following command:
.To run analysis on application source code, run the following command:

[source,terminal,subs="attributes+"]
----
Expand Down Expand Up @@ -40,7 +40,7 @@ Flags:
--rules stringArray filename or directory containing rule files
--skip-static-report do not generate 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 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)
Expand All @@ -55,7 +55,7 @@ Global Flags:
----
{mta-cli} analyze --list-targets
----
. Run an analysis with a specified target technology.
. Run an analysis with a specified target technology, for example `cloud-readiness`.
+
[source,terminal,subs="attributes+"]
----
Expand Down
14 changes: 10 additions & 4 deletions docs/topics/mta-cli-transform.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Global Flags:
Use "{mta-cli} transform [command] --help" for more information about a command.
----

.`OpenRewrite`
== `OpenRewrite`

The `openrewrite` sub command allows running `OpenRewrite` recipes on source code.
[source,terminal,subs="attributes+"]
Expand All @@ -45,19 +45,25 @@ Flags:
-h, --help help for openrewrite
-i, --input string path to application source code directory
-l, --list-targets list all available OpenRewrite recipes
-s, --maven-settings string path to a custom maven settings file to use
-t, --target string target openrewrite recipe to use. Run --list-targets to get a list of packaged recipes.
Global Flags:
--log-level uint32 log level (default 4)
--no-cleanup do not cleanup temporary resources
----
To run `transform openrewrite` on application source code, run the following command:

.To run `transform openrewrite` on application source code, run the following command:
[source,terminal,subs="attributes+"]
----
{mta-cli} transform openrewrite --input=<path/to/source/code> --target=<exactly_one_target_from_the_list>
----
[NOTE]
====
You can only use a single target to run the `transform overwrite` command.
====

.`Rules`
== `Rules`

The `rules` sub command allows converting {LC_PSN} XML rules to analyzer-lsp YAML rules using `windup-shim`.
[source,terminal,subs="attributes+"]
Expand All @@ -76,7 +82,7 @@ Global Flags:
--log-level int log level (default 5)
----

To run `transform rules` on application source code, run:
.To run `transform rules` on application source code, run the following:
[source,terminal,subs="attributes+"]
----
{mta-cli} transform rules --input=<path/to/xmlrules> --output=<path/to/output/dir>
Expand Down

0 comments on commit 1b3cbf6

Please sign in to comment.