docs: update CLI README with comprehensive documentation #320
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.
Description
This PR updates the CLI README.md with comprehensive documentation about the package structure, features, and usage.
Key improvements:
Related Issues
Fixes #319
Testing
The updated README has been reviewed for accuracy and completeness. All information is consistent with the current implementation of the CLI package.
Additional Notes
This update focuses on making the CLI documentation more comprehensive and user-friendly, especially highlighting the custom commands feature which wasn't well-documented before.