Feature: Add CLI list-templates Command Closes #31

[IvantheGreatMaker]

Adds new Feature: Add CLI list-templates Command #31

Description

Add a new list command to the CLI that displays all available scaffold templates organized by category. This enables users to discover available templates without consulting documentation.

Related Issue

Closes #31

Type of Change

• 🐛 Bug fix
• ✨ New feature (non-breaking change that adds functionality)
• 💥 Breaking change
• 📚 Documentation update
• 🔧 Refactor / code cleanup
• 🧪 Test improvement

Changes Made

• Added TEMPLATE_INFO dictionary to 8 scaffold modules for dynamic discovery
• Added _collect_templates() helper function in devopsos.py
• Added @app.command("list") command to display templates by category
• Added tests for the new list command

Testing Done

• Existing tests pass (python -m pytest cli/test_cli.py mcp_server/test_server.py tests/test_comprehensive.py -v)
• New tests added to cover the changes
• Manually tested: python -m cli.devopsos list

Checklist

• My code follows the existing style and conventions
• I have self-reviewed my code
• My changes do not introduce new warnings or errors
• I have linked the related issue above
• All CI checks are passing

[chefgs]

@IvantheGreatMaker
One suggestion is to add the new list command under the Quick Start Commands section in root README.md file.

# ── List templates ──────────────────────────────────────────────────────────
python -m cli.devopsos list  # → Displays list of available templates

[chefgs]

Hello @IvantheGreatMaker - Thank you for picking up the issue and raising a PR.

Glad you have followed the PR template, which helped us to review the code quickly.

Please address the review comment, I've added in the code.

[Copilot]

Pull request overview

This PR adds a new top-level CLI command (python -m cli.devopsos list) that prints the available scaffold templates grouped by category, based on per-scaffold TEMPLATE_INFO metadata.

Changes:

• Added TEMPLATE_INFO metadata to scaffold modules so templates can be discovered and categorized.
• Added _collect_templates() and a new list command in cli/devopsos.py to render grouped template output.
• Added CLI tests to validate the new command and its presence in help output.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
cli/devopsos.py	Adds template collection + new list command rendering grouped templates.
cli/test_cli.py	Adds tests for list command output and help presence.
cli/scaffold_gha.py	Adds TEMPLATE_INFO for the GitHub Actions scaffold.
cli/scaffold_gitlab.py	Adds TEMPLATE_INFO for the GitLab CI scaffold.
cli/scaffold_jenkins.py	Adds TEMPLATE_INFO for the Jenkins scaffold.
cli/scaffold_cicd.py	Adds TEMPLATE_INFO for the combined CI/CD scaffold.
cli/scaffold_argocd.py	Adds TEMPLATE_INFO for the GitOps scaffold.
cli/scaffold_sre.py	Adds TEMPLATE_INFO for the SRE scaffold.
cli/scaffold_unittest.py	Adds TEMPLATE_INFO for the unit test scaffold.
cli/scaffold_devcontainer.py	Adds TEMPLATE_INFO for the devcontainer scaffold.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

Suppressed comments (2)

Previously missed (2) — in code that hasn't changed since the last review.

cli/test_cli.py:46

• test_list_in_help asserts against raw help output without stripping ANSI codes (unlike other help-related tests in this file) and the substring check is fairly weak. Stripping ANSI and using a multiline regex makes the test more consistent and less flaky.

    result = _run_module("cli.devopsos", ["--help"])
    assert result.returncode == 0
    assert "list" in result.stdout

cli/devopsos.py:915

• list_templates() assumes every discovered TEMPLATE_INFO dict has "name" and "description" keys and will raise a KeyError if a module provides an incomplete dict. Since discovery is dynamic, it’s safer to tolerate missing keys and keep output order stable (e.g., sort categories/items) to avoid surprising CLI output changes.

    for category, items in templates.items():
        typer.echo(typer.style(category, bold=True))
        for t in items:
            name = t["name"].ljust(14)
            desc = t["description"]
            typer.echo(f"  {name} {desc}")