Repository navigation
Clearer --help output - #9
Merged
Merged
Conversation
proofcli --help lists run, validate, and init with a one-line description each. Subcommand help no longer shares the run description. The proofcli SPEC shorthand, exit codes, and report output stay the same.
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
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.
proofcli --helpused to describe onlyrun, andvalidate --helpandinit --helprepeated that same sentence. Top-level help now lists every command with its own one-line description, and each command's help describes that command.proofcli SPECstill runs a spec. Exit codes, flags, and the JSON report are unchanged.Before
proofcli --help,proofcli validate --help, andproofcli init --helpall started from the same description: "Run an argv command and verify its explicit output contract."proofcli validate --helpkept that description and this usage:proofcli init --helpkept it as well:After
proofcli --help:proofcli run --helpdescribes run and keeps the run usage:proofcli validate --help:proofcli init --help:The second line of
proofcli --helpis the existingproofcli SPECform, with the same--reportand--artifactsoptions asrun.