@shoppexio/cli

Shoppex CLI for theme development workflows.

Use this package when you want to:

• pull a hosted Shoppex theme into a local folder
• push your local draft source back to Shoppex
• inspect, validate, preview, and publish from the terminal

Key Commands

Install from npm:

npx @shoppexio/cli auth login --api-key shx_your_key

Or run it from this repo:

bun packages/cli/bin/shoppex.mjs auth login --api-key shx_your_key
bun packages/cli/bin/shoppex.mjs theme pull --theme 11111111-1111-4111-8111-111111111111 --out ./my-theme
cd ./my-theme
bun /absolute/path/to/shoppex/packages/cli/bin/shoppex.mjs theme status
bun /absolute/path/to/shoppex/packages/cli/bin/shoppex.mjs theme doctor
bun /absolute/path/to/shoppex/packages/cli/bin/shoppex.mjs theme push --preview
bun /absolute/path/to/shoppex/packages/cli/bin/shoppex.mjs theme publish --theme 11111111-1111-4111-8111-111111111111

Safety Model

Simple rules:

• pull stores .shoppex/theme.json with the linked theme and source revision
• status compares the linked local revision, local files, and remote source revision
• doctor checks auth, workspace link, remote source access, inspect, validation, and preview startup
• push uploads the full local source snapshot
• push validates automatically
• push never publishes automatically
• pull refuses to overwrite dirty linked workspaces unless you pass --force
• a revision mismatch blocks accidental overwrites unless you pass --force

Auth

Set SHOPPEX_API_KEY or log in with:

shoppex auth login --api-key shx_your_key

Recommended scopes:

• themes.read
• themes.write

Related Docs

• Hosted Theme Sync: https://docs.shoppex.io/themes/hosted-theme-sync
• Theme Control Plane: https://docs.shoppex.io/themes/theme-control-plane