34 lines
1.8 KiB
Markdown
34 lines
1.8 KiB
Markdown
# CLI Help Text and Discoverability
|
|
|
|
## Module
|
|
Cli
|
|
|
|
## Status
|
|
VERIFIED
|
|
|
|
## 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
|
|
|
|
## Verification
|
|
|
|
- **Verified**: 2026-02-13T15:30:00Z
|
|
- **Tier 0 (Source)**: pass -- all referenced source files exist on disk
|
|
- **Tier 1 (Build)**: pass -- module builds cleanly, 238 tests pass in StellaOps.Cli.Formatting.Tests
|
|
- **Tier 2d (Integration)**: pass -- targeted integration tests confirm behavioral correctness
|
|
- **Test Project**: `src/Cli/__Tests/StellaOps.Cli.Formatting.Tests/StellaOps.Cli.Formatting.Tests.csproj`
|
|
- **Evidence**: `docs/qa/feature-checks/runs/cli/cli-help-text-and-discoverability/run-001/tier2-integration-check.json`
|