@shopify/shop-cli
v0.1.2
Published
Personal shopping CLI for Shop catalog search, checkout, and order workflows
Keywords
Readme
Shop CLI
Personal shopping CLI for the Shop catalog: search millions of stores, look up products, sign in to your Shop account, build and complete UCP checkouts, and search your orders for tracking, returns, and reorders.
It talks to the Shopify Global Catalog over MCP and to Shop's auth, checkout, and orders APIs. Tokens are stored in your OS secret store via keytar.
Companion to the Shop skill
This CLI is the companion to the Shop skill, the agent-facing playbook that drives the end-to-end shopping conversation. The skill calls these commands under the hood and documents every command, flag, and workflow in full.
The skill lives at https://shop.app/SKILL.md — see it for the complete reference.
Install
pnpm add --global @shopify/shop-cliOr with npm:
npm install --global @shopify/shop-cliRequires Node.js >= 20.
Usage
shop --help
shop auth status
shop search "trail running shoes" --limit 10
shop catalog lookup gid://shopify/ProductVariant/50362300006715
shop orders search --type recentCommands
shop search— search the catalog by text, similar items (--like-id), or image (--image).shop catalog lookup/shop catalog get-product— look up IDs you already hold and fetch full product detail.shop auth— sign in (login, or the non-blockingdevice-code+poll), checkstatus, read the remaining delegated spendingbudget, orlogout.shop checkout—create,update, andcompletea UCP checkout on the merchant domain (completerequires--confirm).shop orders search— search recent orders, tracking, order info, returns, and reorder candidates.shop config— persist CLI preferences such as a default country.
Run shop <command> --help for the flags on any command, and see the Shop skill for the full reference and shopping workflow.
Personal-use limits
This CLI is designed for individual end users, for personal use. The Shopify servers it connects to have usage restrictions. Building commercial services, resale platforms, aggregators, or anything that provides third parties with programmatic access to Shopify's catalog, checkout, delegated payments, or aggregated user data is prohibited.
See https://help.shop.app/en/shop/shopping/personal-agents for accepted and prohibited use.
Development
pnpm install
pnpm typecheck
pnpm test
pnpm buildContributing
Bug reports and pull requests are welcome. Read CONTRIBUTING.md and CODE_OF_CONDUCT.md before getting started.
License
MIT. See LICENSE.md.
