Add comprehensive command documentation to README - #4
Merged
Merged
Conversation
The README showed a handful of hand-picked examples, so the only way to discover the other two dozen commands and their flags was `--help` on a guess. Add a Commands section generated by `oclif readme` from the command classes, and run it from `prepack` so a publish cannot ship a reference that has drifted from the code. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018KocZzBsaC3JNDSFU2QvD6
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.
Summary
This PR adds auto-generated command documentation to the README.md file, providing users with a complete reference of all available CLI commands, their arguments, flags, and usage examples.
Key Changes
package.jsonscripts to auto-generate documentation:docsscript that runsoclif readmeto generate command documentationprepackscript to includenpm run docsto ensure documentation is always up-to-date before publishingImplementation Details
<!-- commands -->and<!-- commandsstop -->) to allow for safe regenerationhttps://claude.ai/code/session_018KocZzBsaC3JNDSFU2QvD6