WIP MTA-6889 CLI refactored commands

[Pkylas007]

JIRA

• MTA-6889

Version

• 8.2.0

Previews

• 2. About the MTA commands
• 2.1. CLI command structure
• 2.2. Deprecated commands and options
• 2.3. Compatibility with deprecated commands
• 5.3. The provider and rules command options
• 4.1. Analyzing a single application - minor correction in the first step
• 4.4. The analyze command options - removed provider, source, and target flags
• 8.1. Transforming applications source code - minor command correction
• 8.3. The openrewrite command options - minor command correction

Summary by CodeRabbit

• Documentation
  • Added new CLI guide and reference pages covering the CLI command structure, backward compatibility, deprecated commands/options, and provider/rules and openrewrite options.
  • Updated procedures and examples to use the restructured command syntax (for example, mta-cli provider list and mta-cli rules list-targets) and removed outdated transform openrewrite references.
  • Refreshed mta-cli analyze flag documentation by removing listing flags moved to rules/provider.
  • Included additional guidance for analyzing non-Java applications.

[coderabbitai]

📝 Walkthrough

Walkthrough

The CLI guide gains a new assembly page and several AsciiDoc topics covering the reorganized mta-cli command structure, updated provider/rules and openrewrite command usage, deprecated commands, and backward compatibility behavior.

Changes

MTA CLI guide documentation

Layer / File(s)	Summary
Assembly entry point and CLI guide wiring assemblies/cli-guide/assembly_about-the-command-line-tool.adoc, docs/cli-guide/master.adoc	Adds the CLI guide assembly page with metadata, context handling, abstract text, and included topic partials, and includes that assembly from the CLI guide master page.
Command structure and option references docs/topics/mta-cli/con_cli-command-structure.adoc, docs/topics/mta-cli/ref_provider-and-rules-command-options.adoc, assemblies/cli-guide/assembly_analyzing-nonjava-applications.adoc, docs/topics/mta-cli/proc_analyze-selected-provider.adoc, docs/topics/mta-cli/proc_analyzing-single-app-with-mta-cli.adoc, docs/topics/mta-cli/proc_transforming-application-source-code.adoc, docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc, docs/topics/mta-cli/ref_openrewrite-command-options.adoc	Adds the CLI command structure concept, documents provider and rules options, updates non-Java analysis guidance, and rewrites procedure/reference text and examples for provider, rules, and openrewrite command names.
Deprecated commands and backward compatibility docs/topics/mta-cli/ref_deprecated-commands-and-options.adoc, docs/topics/mta-cli/ref_backward-compatibility.adoc	Adds reference topics for deprecated mta-cli commands and for translating unsupported or deprecated syntax into the reorganized command structure.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

• anarnold97

Poem

🐇 Hop, hop, the docs take flight,
New commands lined up left and right.
Old paths fade, new paths gleam,
mta-cli now follows a tidier theme.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title matches the PR’s main change: a CLI command refactor, with the issue key providing extra context.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch mta-6889-cli-refactor

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)

docs/topics/mta-cli/ref_deprecated-commands-and-options.adoc (1)

46-48: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Avoid publishing an empty “Additional resources” section.

Line 46–48 introduces the section header but no links/resources follow. Please either add at least one resource or remove the empty section.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/topics/mta-cli/ref_deprecated-commands-and-options.adoc` around lines 46
- 48, The “Additional resources” section is empty, so either add at least one
relevant resource link under the .Additional resources heading or remove the
section entirely from the deprecated commands and options topic; update the
AsciiDoc block around the Additional resources anchor/header so it only appears
when actual content is present.

assemblies/cli-guide/assembly_about-the-command-line-tool.adoc (1)

22-24: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Assembly ends without including topic modules.

Line 22–24 closes context, but the assembly never includes the concept/reference modules. This leaves the page with only the title/abstract and omits the CLI content this PR adds.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@assemblies/cli-guide/assembly_about-the-command-line-tool.adoc` around lines
22 - 24, The assembly currently only sets and clears context in the
about-the-command-line-tool page, so it never pulls in the new CLI content.
Update the assembly to include the relevant concept/reference topic modules used
by this PR, placing them in the proper section of the assembly so the content
renders after the title and abstract. Use the assembly document structure around
the parent-context-of-about-the-command-line-tool markers to locate where the
missing module includes should be added.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/topics/mta-cli/ref_provider-and-rules-command-options.adoc`:
- Around line 23-35: The provider command examples and their placeholder
definitions use hyphenated placeholder names, which should be converted to
underscore-separated placeholders to match repo conventions. Update the AsciiDoc
in the provider install/remove examples so the command examples and the
corresponding “where” definitions both use the same underscore-form placeholder
name, and keep the wording consistent across the install and remove sections.

---

Outside diff comments:
In `@assemblies/cli-guide/assembly_about-the-command-line-tool.adoc`:
- Around line 22-24: The assembly currently only sets and clears context in the
about-the-command-line-tool page, so it never pulls in the new CLI content.
Update the assembly to include the relevant concept/reference topic modules used
by this PR, placing them in the proper section of the assembly so the content
renders after the title and abstract. Use the assembly document structure around
the parent-context-of-about-the-command-line-tool markers to locate where the
missing module includes should be added.

In `@docs/topics/mta-cli/ref_deprecated-commands-and-options.adoc`:
- Around line 46-48: The “Additional resources” section is empty, so either add
at least one relevant resource link under the .Additional resources heading or
remove the section entirely from the deprecated commands and options topic;
update the AsciiDoc block around the Additional resources anchor/header so it
only appears when actual content is present.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fce97313-4a4b-4054-b5b9-d6917358090f

📥 Commits

Reviewing files that changed from the base of the PR and between a22f4a0 and c10bf99.

📒 Files selected for processing (5)

• assemblies/cli-guide/assembly_about-the-command-line-tool.adoc
• docs/topics/mta-cli/con_cli-command-structure.adoc
• docs/topics/mta-cli/ref_backward-compatibility.adoc
• docs/topics/mta-cli/ref_deprecated-commands-and-options.adoc
• docs/topics/mta-cli/ref_provider-and-rules-command-options.adoc