docs: add examples and local development instructions to README#3
Merged
CodySearsOS merged 2 commits intomainfrom Feb 24, 2026
Merged
docs: add examples and local development instructions to README#3CodySearsOS merged 2 commits intomainfrom
CodySearsOS merged 2 commits intomainfrom
Conversation
Co-Authored-By: unknown <>
Contributor
Original prompt from cody.sears@opensea.io |
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
|
Co-Authored-By: unknown <>
devin-ai-integration bot
added a commit
that referenced
this pull request
Mar 4, 2026
- Remove wrapper-detection heuristic from filterFields; always apply pickFields at top level (issue #1 from review) - Remove setOutputOptions/OutputOptions from SDK barrel export to avoid state leakage for SDK consumers (issue #2 from review) - Add --max-lines validation requiring >= 1 (issue #3 from review) - Update tests to match simplified filterFields behavior Co-Authored-By: Chris K <ckorhonen@gmail.com>
ckorhonen
added a commit
that referenced
this pull request
Mar 4, 2026
* feat: add --fields and --max-lines global CLI options (DIS-145)
Add --fields <fields> to select specific JSON fields in output.
Add --max-lines <lines> to truncate output with line count indicator.
Uses Commander preAction hook and module-level output options to avoid
changing any command files. Field filtering handles plain objects,
arrays, and wrapped API responses (e.g. {nfts: [...], next: ...}).
Truncation appends '... (N more lines)' indicator.
Co-Authored-By: Chris K <ckorhonen@gmail.com>
* fix: improve filterFields heuristic and maxLines nullish check (DIS-145)
- filterFields now checks if any requested field matches a top-level key.
If yes, picks from top level (handles Collection with array props like
contracts, editors). If no match, treats as wrapper and filters array
items (handles {nfts: [...], next: ...} responses).
- Changed maxLines guard from truthiness to != null so --max-lines 0 works.
- Added tests for objects with array properties and maxLines 0.
Co-Authored-By: Chris K <ckorhonen@gmail.com>
* fix: address code review feedback (DIS-145)
- Remove wrapper-detection heuristic from filterFields; always apply
pickFields at top level (issue #1 from review)
- Remove setOutputOptions/OutputOptions from SDK barrel export to avoid
state leakage for SDK consumers (issue #2 from review)
- Add --max-lines validation requiring >= 1 (issue #3 from review)
- Update tests to match simplified filterFields behavior
Co-Authored-By: Chris K <ckorhonen@gmail.com>
---------
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
3 tasks
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.
docs: add examples and local development instructions to README
Summary
Documentation-only change to the README:
node dist/cli.jsornpm link)tiny-dinos-ethandmferscollections, with actual contract addresses and wallet addressesoffers traitssynopsis to show--typeand--valueas required flags (matching the code fix in PR fix: use POST for nfts refresh, require type+value for offers traits #2)https://docs.opensea.io/reference/api-keys(the specific API keys page, not the docs root)Review & Testing Checklist for Human
0xd9b78a2f1dafc8bb9c60961790d2beefebee56f4, owner0xde7fce3a1cba4a705f299ce41d163017f165d666).https://docs.opensea.io/reference/api-keys) resolves correctly and is the preferred page to send users to.Notes