cli: grouped/sorted help with per-command examples#55
Merged
Conversation
Top-level --help now groups subcommands gcloud-style (Authoring, Instances, Stepping, Persistence, Batch), sorted alphabetically within each group, each with a one-line description. Every subcommand's --help carries a description and a usage example (RawDescription epilog). 'export --help' documents that --format currently accepts only 'mermaid' and shows an example. --store is documented prominently with the file:/mem:/sqlite: schemes, the ./.determa default, and DETERMA_STORE, plus store examples. Help text is non-normative; no command behavior changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Top-level
--helpnow groups subcommands gcloud-style (Authoring, Instances, Stepping, Persistence, Batch), sorted alphabetically within each group, each with a one-line description. Every subcommand's--helpcarries a description and a usage example.export --helpdocuments that--formatcurrently accepts onlymermaid(with an example).--storeis documented prominently: thefile:/mem:/sqlite:schemes, the./.determadefault, andDETERMA_STORE, plus store examples.Workstream 2. Help text is non-normative; no command behavior changes. Mirrors the Rust CLI help structure.
Gate:
ruff+mypy+ 150 unit tests + 67 conformance cases all green.