Update README to reflect actual CLI behavior and Shop skill companionship - #14
Merged
Conversation
joerj123
force-pushed
the
update-readme-cli-docs
branch
from
June 11, 2026 16:25
d4955c4 to
f6bc5d4
Compare
PawanP1808
approved these changes
Jun 11, 2026
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.
What
Rewrites the README to accurately describe how the
shopCLI actually works, based on the current command surface insrc/cli.ts, and adds a nod to the fact that the CLI is the companion to the Shop skill (https://shop.app/SKILL.md).Why
The README had drifted from the implementation — it was missing several commands and flags, and did not mention its relationship to the Shop skill that drives the end-to-end shopping flow.
Changes
--country(context signal, not a ships-to filter),--profile-url,--format md|json,--memory-store, plus the real output-format behavior (auth/checkout → JSON, orders → markdown, catalog → md/json).--like-id,--image, etc.).device-code→pollflow alongside blockinglogin; notes tokens live in the OS secret store via keytar.checkout updatecommand, create-from-cart path, the--confirmrefusal behavior,messages[]warning surfacing, and--buyer-ip/SHOP_BUYER_IP.--typeset includingorder_info, plus--date-from/--date-to/--cursor.config set-countryandconfig showcommands.Docs-only change.