Unshipped and stale CLI examples
The exact machine-readable list is unshipped-command-examples.json. Every entry is a runnable-looking stella, stellaops, or stellaops-cli example in living documentation that the released CommandFactory tree rejects for an unregistered command, argument, or option. The test reconstructs the release-style plugins/cli/** drop from every checked-in restart-time plug-in manifest under src/Cli/plugins/cli/ before parsing, so valid packaged-only commands such as runtime policy, excititor, and offline kit status are not false positives.
These entries are explicitly not shipped CLI syntax. Some are old design sketches, some are retired command shapes, and some are documentation defects. Do not copy them into runbooks, the public site, automation, or support instructions. A command is usable only when the current binary parses it.
The baseline records the normalized command line, occurrence count, and up to five source locations. Append-only QA evidence, sprint records, feature-check records, and incoming product advisories are excluded from this living-docs gate; they retain their point-in-time command output.
CliDocumentationContractTests enforces both directions:
- a new structurally invalid example fails the test until the source is fixed or the example is deliberately reviewed into this baseline;
- a baseline entry that starts parsing or disappears also fails, so stale debt is removed instead of accumulating forever.
Prefer correcting the source document. If a design example must remain, label it visibly as unshipped near the example. Regenerate this baseline only after reviewing the diff:
$env:STELLAOPS_UPDATE_CLI_DOC_BASELINE = '1'
pwsh ./tools/scripts/test-targeted-xunit.ps1 `
-Project src/Cli/__Tests/StellaOps.Cli.Tests/StellaOps.Cli.Tests.csproj `
-Method '*CliDocumentationContractTests*'
Run the same targeted test again without the environment variable to prove that the checked-in baseline and current documentation agree.
Every retained entry also has an exact owner obligation in tools/scripts/validate/cli-documentation-owner-worklist.json, pinned to the entry’s current document occurrences. The architecture lane’s documentation-example step fails when the baseline and the worklist disagree, or when a pinned occurrence moves. A baseline shrink or a document edit that moves a listed example therefore also updates the worklist and its owner-row marker.
