Help Developers and agencies psx command reference
Read-only commands are marked ○ and commands that write are marked ●. Required flags are in bold . For the full flags of any command run psx help <command> — the help is generated from the tool itself, so it is always current.
Two flags work everywhere: --json prints the whole result, and --opId <key> sets the idempotency key for a write.
Pages#
Command Flags What it does ○ pages.list — Every page with its publish status. ○ pages.show page , contentA page's sections in order, with keys. --content adds every component's text, link and binding. ○ pages.render page, file, out Renders a draft at 1440 and 390 px with screenshots and a check of what rendered. ● pages.create name , template, kind, productCreates a draft page from a template. ● pages.duplicate page , name Copies a page as an independent draft — the way to make an A/B challenger. ● pages.set-kind page , kind Marks a draft as the home page (home) or back to a page (page). ● pages.publish page , confirm , target, handle, themeIdPublishes a draft with its products' live data. ● pages.unpublish confirm , page, handle, themeIdTakes a page off the storefront; for the home page, restores the theme's original. ○ templates.list kind Templates for new pages and which can carry a home page.
Sections#
Command Flags What it does ○ sections.list query, category, template, limit Searches the section library. ○ sections.show section Every component of a section — the ids section.set takes. ● section.add page , section , index, productAdds a library section, or a copy of a saved section (custom/<id>). ● section.move page , section , to Moves a section. ● section.remove page , section Removes a section. ● section.set page , section , component , content, design, removed, bindChanges one component. ● batch page , ops Many set / add / move / remove ops on one page, in one write. ○ sections.mine query Your saved sections and where each is used. ● sections.save page , section , name Saves a section to your saved sections. ● sections.update section , page , from , applyRe-saves a saved section; --apply re-copies it to every page with a copy. ● sections.apply section , pagesRe-copies a saved section to the pages that have one. ● sections.forget section Removes a saved section from the library; copies stay. ● compose brief , kind, product, products, brand, facts, name, template, header, footerBuilds a product page, home page or cart from a brief. Saves a draft.
Products#
Command Flags What it does ○ product.list query, status, limit, after Searches your catalogue with Shopify's product search. ○ product.show product One product in full. ● product.create title , variants , …Creates a product in Shopify (draft by default). ● product.update product , …Changes a product; --publish adds it to the Online Store.
Offers, journeys and tests#
Command Flags What it does ● offer.create name , type , slot , reward , …Creates an offer as a draft. A free gift creates its Shopify automatic discount. ● offer.go-live offer , confirm Switches an offer on after checking it against Shopify. ● journey.create name , trigger , steps , products, collection, frequency, days, holdoutPctSequences offers into a draft journey. ● journey.turn-on journey , confirm Turns a journey on; refused while a step's offer isn't live. ● test.create name , kind , …Creates an A/B test as a draft. ● test.start test , confirm Starts a test.
Going live#
Command Flags What it does ○ live.pending — What is saved but not live, and what a push does to each item. ● live.push confirm , ids, allPushes the named pending changes live (or --all). ● live.discard ids, all Undoes pending changes back to what shoppers see now. Never deletes.
Reviews#
Command Flags What it does ● reviews.settings autoPublish, holdBelow, verifiedBadge, photosFirst No flags reads the settings; any flag changes them. ○ reviews.list state, product, limit, after Reviews by state and product. ● review.hide / review.restore review Hides reviews from the storefront, or puts them back. ● review.delete review Deletes reviews for good.
Your computer#
login, login --check, whoami and logout manage the sign-in stored on your machine.
Error codes#
Code Meaning bad_inputA flag is missing, unknown or the wrong shape. not_foundNo such page, section, product, offer, journey or test. refusedIt exists, but the command said no on purpose — for example no --confirm, or an offer whose mechanism isn't real. conflictSomeone else wrote first, or an idempotency key was reused. plan_limitYour plan doesn't include this. transportPageStax couldn't be reached. failedAnything else, in the server's own words.
Still stuck? Contact support — include your store address and what you were doing.