docs: clarify --jq flag with examples and tutorial link#6
Merged
Conversation
Closes #5 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
ilyazub
approved these changes
Jun 9, 2026
There was a problem hiding this comment.
Pull request overview
This PR improves the CLI documentation for the global --jq flag to better explain how client-side filtering works and how it pairs with --fields for server-side payload reduction, aligning with the request in issue #5.
Changes:
- Expanded
--jqflag documentation with an official jq tutorial link and clearer behavioral explanation (runs locally after API call; no external jq install required). - Added multiple
--jqusage examples (slice/map, field extraction, counting) plus shell quoting guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Documentation improvement for #5