stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 2 Releases Wiki Activity
Files
33360e8d9d13700ed772343dbe3a98cdf9d173a2
git.stella-ops.org/docs/features/unchecked/cli/cli-help-text-and-discoverability.md

1.3 KiB
Raw Blame History

CLI Help Text and Discoverability

Module

Cli

Status

IMPLEMENTED

Description

Improved help text generation showing the new command hierarchy with clear categories for better discoverability.

Implementation Details

  • Command Factory: src/Cli/StellaOps.Cli/Commands/CommandFactory.cs -- builds command hierarchy with descriptive help text
  • Command Groups: All command groups under src/Cli/StellaOps.Cli/Commands/ provide description strings for new Command("name", "description")
  • Tests: src/Cli/__Tests/StellaOps.Cli.Tests/Integration/HelpTextTests.cs -- validates help text output
  • Resource hierarchy: ~18 top-level groups (scan, release, verify, attest, evidence, policy, vex, reachability, sbom, crypto, config, auth, admin, ci, setup, explain, tools, doctor)

E2E Test Plan

  • Run stella --help and verify top-level command categories are listed with descriptions
  • Run stella scan --help and verify scan subcommands listed with descriptions
  • Run stella config --help and verify config subsections (notify, feeds, integrations, etc.)
  • Verify each top-level command group has a meaningful description
  • Verify --help works on every subcommand level
  • Verify help text shows option descriptions and default values